v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

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}

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.