Administering user profiles6

Authoring assets9

Authoring categories8

Authoring changes8

Authoring comments6

Authoring content11

Authoring context search1

Authoring image profiles7

Authoring Import1

Authoring layouts23

Authoring reference4

Authoring renditions4

Authoring resources4

Authoring review7

Authoring search2

Authoring sites17

Authoring types15

Authoring version7

Delivery content4

Delivery context search1

Delivery render7

Delivery resources2

Delivery search2

Delivery sites8

Publishing5

Tenant Registry2

Webhook profiles2

Authoring image profiles

Update an existing image profile.

Use the /image-profiles/{id} end-point to update an existing image profile within the database.<br />User roles: admin, manager

put/authoring/v1/image-profiles/{id}

Request

The document declares no server URL.
Auth
none declared
TypeScript
https://skmtc.dev/goacoustic/apis/acoustic-content-api/docs/authoring/v1/image-profiles/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the image profile document to update.

Query parameters

forceOverrideboolean

Specifies whether revision checking should be disabled.

Request body

idstring

The ID of the image profile.

revstring required

The current revision of the image profile.

namestring required

The name of the image profile.

descriptionstring

The description of the image profile.

classification'image-profile' required

creatorIdstring required

The ID of the user that created the image profile.

creatorstring

The display name of the user that created the image profile. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

createdstring date-time

The created date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

lastModifierIdstring

The ID of the user that last modified the image profile.

lastModifierstring

The display name of the last user that modified the image profile. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

lastModifiedstring date-time

The last modified date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

tagsstring[]

isSystemboolean

Indicates whether this item is a 'system item' or not.

Example request

{
  "tags": [
    "news",
    "sample"
  ]
}

Response

Success.