Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring image profiles

Retrieve an existing image profile.

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

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

Path parameters

idstring required

The ID of the image profile to retrieve.

Query parameters

fieldsstring

A comma separated list that when specified, limits the fields returned to just those specified. Any type document field is a valid value.

includestring

A comma separated list of additional fields (which are normally hidden) to add to the response. Valid options are: * metadata: Adds additional details such as creator and last modifier to the response. * all: Adds all current and future additional fields to the response. When used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.

Headers

If-None-Matchstring

Provide an Etag value from a previous request to check whether the image profile retrieved is the most recent version. If the image profile is the most recent version, the call returns a 304 ( Not modified) message instead of sending the image profile back.

Response

Success.

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 response

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