Get Templates

For customers with the Adaptive Template templates feature, use this endpoint to return a list of all available templates in the system.

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON object

from
integer <= 10000
Default: 0

The beginning index of the search. A value greater than 0 will offset the search.

limit
integer or null [ 1 .. 100 ]
Default: 50

The maximum number of templates to return per page.

searchTerm
Array of strings or null

List of search terms with AND operation by default

Array of objects or null (Search_sortBy)

The metadata attribute and order to sort by.

operation
string

Indicates whether to apply an AND conditions or an OR condition between search terms

Responses
200

The Response Body is a JSON object.

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

post/template
Request samples
application/json
{
  • "from": 0,
  • "limit": 50,
  • "searchTerm": [
    ],
  • "sortBy": [
    ],
  • "operation": "AND"
}
Response samples
application/json
{
  • "childProductIds": [
    ],
  • "renditionsDocument": {},
  • "avamTags": [
    ],
  • "lockType": [
    ],
  • "objectType": "string",
  • "digitalAssetIds": [
    ],
  • "fileState": "string",
  • "technicalMetadataDocument": {
    },
  • "customerId": "string",
  • "lastUpdatedEpoch": 0,
  • "metadataTemplateId": "string",
  • "objectId": "string",
  • "metadataDocument": {
    },
  • "metadataState": "string",
  • "lastUpdatedBy": "9eca4444-bb39-4c34-8088-e204f5c15d34",
  • "originalFileId": "1ebf63d7-819a-4a33-a1cd-00df81f55bd3",
  • "securityTemplateIds": [
    ],
  • "currentVersion": "Y",
  • "versionNumber": 0,
  • "filename": "string",
  • "createdEpoch": 0,
  • "technicalMetadataText": "string",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "AITags": [
    ],
  • "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
  • "securityTemplateDenormalized": [
    ]
}