List All Types
/content/management/api/v1.1/types
Request
-
fields(optional): string
This parameter is used to control the returned fields in each type in the list. All the field names are case-sensitive. Each type has both standard fields (id, name, displayName, description, typeCategory, createdBy, createdDate, updatedBy, updatedDate, roleName, allowedActions) and additional fields (fields, properties, connectorInfos). When fields is specified as all (case-insensitive), all the standard and additional fields are returned. The standard fields are always returned in the response and cannot be filtered out. The user can filter out only the additional fields. This parameter is optional in the query, and by default the result shows all standard and additional fields in the response. Any incorrect or invalid field name given in the query will throw an error.
Example: ?fields=fields,connectorInfos
This returns all standard fields along with the fields and connectorInfos additional fields for each type.
Example: ?fields=all
This will return all standard fields and all additional fields for each type.
Default Value:all
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
This parameter is used to control the order of results. The value of this query parameter follows the format of fieldName:[asc/desc]. asc stands for ascending order desc stands for descending order, default order is asc.The only fields allowed in the field name are name and updatedDate.Default Value:
name:asc
-
q(optional): string
This parameter accepts a query expression condition that matches the field values. The value of query condition follows the format of {fieldName} {operator} "{fieldValue}". The only fieldNames allowed for now are roleName, repositoryId, typeCategory, name and displayName and only allowed operators for now are mt on name, displayName and eq on the others. This query param is optional and defaults to roleName eq "viewer" which filters the resources with at least given role.
Example:
?q=(roleName eq "manager")Default Value:roleName eq "viewer"
-
roleName(optional): string
This parameter is used to filter the returned types with the given role name. This parameter is optional in the query and by default all the types are returned.Allowed Values:
[ "viewer", "contributor", "manager" ]
-
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
- application/json
200 Response
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
array
-
Array of:
object Type
AggregatedType
array
-
Array of:
object Link
Link of the resource.
array
object
-
allowedActions(optional):
array allowedActions
allowedActions on Type.
-
allowedFileTypes(optional):
array allowedFileTypes
Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .
-
apiName(optional):
string
API Name of the type.
-
archivedFields(optional):
object ItemSubResourceListTypeField
Item SubResource.
-
connectorInfos(optional):
array connectorInfos
connectorInfos on Type.
-
createdBy(optional):
string
Created by
-
createdDate(optional):
object date
date
-
description(optional):
string
Description of the type.
-
displayName(optional):
string
display name of the type. It is a required property in the get response whereas it is not required in the post/put request.
-
fields(optional):
array fields
Fields used in the type.
-
id(optional):
string
id of the type. It is a required property in the get response and put request whereas it is not required in the post request.
-
inplacePreview(optional):
object ItemSubResourceListInplacePreview
Item SubResource.
-
jobToken(optional):
string
job token of the background job updating the Type.
-
layoutMapping(optional):
object ItemSubResourceListLayoutMapping
Item SubResource.
-
links(optional):
array links
-
name(optional):
string
Name of the type. It is a required property in the get response and post/put request.
-
properties(optional):
object properties
Additional Properties Allowed: additionalPropertiesType specific properties.
-
relationships(optional):
object ItemSubResourceTypeRelationships
Item SubResource.
-
requiredTaxonomies(optional):
object ItemSubResourceListRequiredTaxonomy
Item SubResource.
-
roleName(optional):
string
Name of the user's role on the content type.
-
typeCategory(optional):
string
Category of the type. The allowed values are [ContentType, DigitalAssetType]. It is a required property in the get response. It is optional in post request and defaults to ContentType. It is also optional in put request and is identified based on the typeName path param in URL.
-
updatedBy(optional):
string
Updated by
-
updatedDate(optional):
object date
date
array
-
Array of:
string
Allowed Values:
[ "preview", "read", "write", "update", "delete" ]
array
array
-
Array of:
object ConnectorInfo
ConnectorInfo
array
-
Array of:
object TypeField
FieldInAggrType.
object
object
-
apiName(optional):
string
API Name of the field.
-
archivedBy(optional):
string
Archived by.
-
archivedDate(optional):
object date
date
-
datatype(optional):
string
Allowed Values:
[ "number", "long", "decimal", "text", "largetext", "reference", "datetime", "boolean" ]
Data Type Enum. It is a required property in the get response and post/put request. -
defaultValue(optional):
object defaultValue
defaultValue for field.
-
description(optional):
string
Description of the field.
-
id(optional):
string
id of the field. It is a required property in the get response and put request whereas it is not required in the post request.
-
isSystemField(optional):
boolean
Is the field provided by the system.
-
name(optional):
string
name of the field. It is a required property in the get response and post/put request.
-
properties(optional):
object properties
Additional Properties Allowed: additionalPropertiesField specific properties. The field publishingDependency is specific for media and reference.
-
required(optional):
boolean
Required or optional value for the Field. It is a required property in the get response and post/put request.
-
settings(optional):
object settings
Additional Properties Allowed: additionalPropertiesField specific settings.
-
valuecount(optional):
string
Allowed Values:
[ "single", "list" ]
Value count as a single or list. It is a required property in the get response and post/put request.
object
object
{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}
object
object
object
object
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
object
-
connectorId(optional):
string
id of the connector.
-
connectorSyncEnabled(optional):
boolean
Sync status of connector.
object
-
apiName(optional):
string
Name of the layout.
-
formats(optional):
object formats
Additional Properties Allowed: additionalPropertieslayout formats.
-
generateRendition(optional):
boolean
generateRendition.
-
id(optional):
integer(int64)
Id of the layout mapping.
-
label(optional):
string
Name of the category for layout mapping.
object
object
-
references(optional):
array references
Unique Items Required:
true
Reference type names/ids
array
true
-
Array of:
object TypeReferences
Type References bean
object
-
id(optional):
string
id of the type
-
links(optional):
array links
-
name(optional):
string
name of the type
object
-
defaultCategories(optional):
array defaultCategories
-
description(optional):
string
Read Only:
true
-
id(optional):
string
-
name(optional):
string
Read Only:
true
object
-
apiName(optional):
string
Read Only:
true
-
id(optional):
string
-
name(optional):
string
Read Only:
true
304 Response
400 Response
403 Response
404 Response
500 Response
Examples
The following example shows how to list of all Types by submission of a GET request using cURL.
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/types'
Example 1
This lists all types.
/content/management/api/v1.1/types
Response Body
{ "hasMore": false, "offset": 0, "count": 3, "limit": 3, "items": [ { "id": "1482247306768", "name": "AppImage", "description": "AppImage", "typeCategory": "DigitalAssetType", "fields": [ { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA1", "name": "copyRights", "description": "copyRights", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE2", "name": "size", "description": "size", "datatype": "number", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE3", "name": "fileType", "description": "fileType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE9", "name": "fileGroup", "description": "fileGroup", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE5", "name": "mimeType", "description": "mimeType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE6", "name": "renditions", "description": "renditions", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE7", "name": "metadata", "description": "metadata", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE8", "name": "native", "description": "native", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA8", "name": "advancedVideoInfo", "description": "advancedVideoInfo", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "D103EEB2A5CC42619D7688A62A169092", "name": "TypeSample", "description": "", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-11-23T10:33:17.270Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-11-23T10:33:17.270Z", "timezone": "UTC" }, "fields": [ { "id": "66EA1FD6AE634B1290968AB1C8F606C4", "name": "fieldASample", "description": "Content", "datatype": "largetext", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE2", "name": "fieldBSample", "description": "Content", "datatype": "largetext", "required": true, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "A5A8C813AB80480C99551A2C62A0B518", "name": "typeName", "description": "", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-11-30T06:56:08.822Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-11-30T09:23:07.608Z", "timezone": "UTC" }, "fields": [ { "id": "9B00BE1343BB4AD59706191544A84709", "name": "fieldB", "description": "Number Field", "datatype": "number", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "viewer", "links": null } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/types", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 2:
This lists all the types starts from index 1.
/content/management/api/v1.1/types?offset=1
Response Body
{ "hasMore": false, "offset": 1, "count": 2, "limit": 3, "items": [ { "id": "3669DC6FA9FB417C81B5EFA4D620E6FA", "name": "Type1", "description": "Type1 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "fields": [ { "id": "D1120F0D990E455B83E2E44C06B21916", "name": "field_type1", "description": "field_type1 description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "4112D51813BE4842A0F1C463E8786B78", "name": "Type2", "description": "Type2 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "fields": [ { "id": "7F311179684E4E909DC08E83E91749BC", "name": "fieldName", "description": "fieldName description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "viewer", "links": null } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/types?offset=1", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=1", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0", "rel": "prev", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=1", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 3:
This lists first 2 types from the list of available types.
/content/management/api/v1.1/types?limit=2
Response Body
{ "hasMore": true, "offset": 0, "count": 2, "limit": 3, "items": [ { "id": "1482247306768", "name": "AppImage", "description": "AppImage", "typeCategory": "DigitalAssetType", "fields": [ { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA1", "name": "copyRights", "description": "copyRights", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE2", "name": "size", "description": "size", "datatype": "number", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE3", "name": "fileType", "description": "fileType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE9", "name": "fileGroup", "description": "fileGroup", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE5", "name": "mimeType", "description": "mimeType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE6", "name": "renditions", "description": "renditions", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE7", "name": "metadata", "description": "metadata", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE8", "name": "native", "description": "native", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA8", "name": "advancedVideoInfo", "description": "advancedVideoInfo", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "3669DC6FA9FB417C81B5EFA4D620E6FA", "name": "Type1", "description": "Type1 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "fields": [ { "id": "D1120F0D990E455B83E2E44C06B21916", "name": "field_type1", "description": "field_type1 description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "contributor", "links": null } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/types?limit=2", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?limit=2", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?limit=2&offset=2", "rel": "next", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?limit=2&offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?limit=2&offset=2", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 4:
This lists all the types including totalResults value in the response.
/content/management/api/v1.1/types?totalResults=true
Response Body
{ "hasMore": false, "offset": 0, "count": 3, "limit": 3, "totalResults": 3, "items": [ { "id": "1482247306768", "name": "AppImage", "description": "AppImage", "typeCategory": "DigitalAssetType", "fields": [ { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA1", "name": "copyRights", "description": "copyRights", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE2", "name": "size", "description": "size", "datatype": "number", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE3", "name": "fileType", "description": "fileType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE9", "name": "fileGroup", "description": "fileGroup", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE5", "name": "mimeType", "description": "mimeType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE6", "name": "renditions", "description": "renditions", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE7", "name": "metadata", "description": "metadata", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE8", "name": "native", "description": "native", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA8", "name": "advancedVideoInfo", "description": "advancedVideoInfo", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "3669DC6FA9FB417C81B5EFA4D620E6FA", "name": "Type1", "description": "Type1 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "fields": [ { "id": "D1120F0D990E455B83E2E44C06B21916", "name": "field_type1", "description": "field_type1 description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "4112D51813BE4842A0F1C463E8786B78", "name": "Type2", "description": "Type2 description.", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "fields": [ { "id": "7F311179684E4E909DC08E83E91749BC", "name": "fieldName", "description": "fieldName description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "viewer", "links": null } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/types?totalResults=true", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?totalResults=true", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0&totalResults=true", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0&totalResults=true", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 5:
This lists all types order by field-name name in descending order.
/content/management/api/v1.1/types?orderBy=name:desc
Response Body
{ "hasMore": false, "offset": 0, "count": 3, "limit": 3, "items": [ { "id": "3669DC6FA9FB417C81B5EFA4D620E6FA", "name": "Type2", "description": "Type2 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T13:55:40.726Z", "timezone": "UTC" }, "fields": [ { "id": "D1120F0D990E455B83E2E44C06B21916", "name": "fieldName", "description": "fieldName description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "viewer", "links": null }, { "id": "4112D51813BE4842A0F1C463E8786B78", "name": "Type1", "description": "Type1 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "fields": [ { "id": "7F311179684E4E909DC08E83E91749BC", "name": "field_type1", "description": "field_type1 description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null }, { "id": "1482247306768", "name": "AppImage", "description": "AppImage", "typeCategory": "DigitalAssetType", "fields": [ { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA1", "name": "copyRights", "description": "copyRights", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE2", "name": "size", "description": "size", "datatype": "number", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE3", "name": "fileType", "description": "fileType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE9", "name": "fileGroup", "description": "fileGroup", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE5", "name": "mimeType", "description": "mimeType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE6", "name": "renditions", "description": "renditions", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE7", "name": "metadata", "description": "metadata", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE8", "name": "native", "description": "native", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA8", "name": "advancedVideoInfo", "description": "advancedVideoInfo", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/types?totalResults=true", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?totalResults=true", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0&totalResults=true", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0&totalResults=true", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 6:
This lists first 2 types starts from index 1 including totalResults value and in descending order by field-name name in the response.
/content/management/api/v1.1/types?limit=2&offset=1&totalResults=true&orderBy=name:desc
Response Body
{ "hasMore": false, "offset": 1, "count": 2, "limit": 3, "totalResults":3, "items": [ { "id": "4112D51813BE4842A0F1C463E8786B78", "name": "Type2", "description": "Type2 description.", "typeCategory": "ContentType", "createdBy": "cecusername", "createdDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "updatedBy": "cecusername", "updatedDate": { "value": "2018-12-05T15:41:59.129Z", "timezone": "UTC" }, "fields": [ { "id": "7F311179684E4E909DC08E83E91749BC", "name": "fieldName", "description": "fieldName description.", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} } ], "properties": {}, "links": null }, { "id": "1482247306768", "name": "AppImage", "description": "AppImage", "typeCategory": "DigitalAssetType", "fields": [ { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA1", "name": "copyRights", "description": "copyRights", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE2", "name": "size", "description": "size", "datatype": "number", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE3", "name": "fileType", "description": "fileType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE9", "name": "fileGroup", "description": "fileGroup", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE5", "name": "mimeType", "description": "mimeType", "datatype": "text", "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE6", "name": "renditions", "description": "renditions", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE7", "name": "metadata", "description": "metadata", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DE8", "name": "native", "description": "native", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} }, { "id": "B4E2EA0BBD5E4DD38BA721BEA7E02DA8", "name": "advancedVideoInfo", "description": "advancedVideoInfo", "datatype": "json", "jsonSchema" : null, "required": false, "valuecount": "single", "isSystemField":true, "properties": {}, "settings": {} } ], "properties": {}, "roleName": "manager", "links": null } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/types?totalResults=true", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?totalResults=true", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0&totalResults=true", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/types?offset=0&totalResults=true", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 7:
This lists 2 types and there will be only standard fields in response.
/content/management/api/v1.1/types?limit=2&fields=name
Response Body
{ "hasMore": true, "offset": 0, "count": 2, "limit": 137, "items": [ { "id": "64C505716FBA499EAE93D12777AA0280", "name": "0002Test1094770152343003", "description": "Test1094770152438004 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0002Test1094770152343003", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ] }, { "id": "145BFDB1D8FA4B7F86D18724C20EA162", "name": "0001Test1094751307482001", "description": "Test1094751309924002 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0001Test1094751307482001", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ] } ], "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=name", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=name", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=name&offset=2", "rel": "next", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=name&offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=name&offset=136", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 8:
This lists 2 types and there will be both standard and additional fields in response.
/content/management/api/v1.1/types?limit=2&fields=all
Response Body
{ "hasMore": true, "offset": 0, "count": 2, "limit": 137, "items": [ { "id": "64C505716FBA499EAE93D12777AA0280", "name": "0002Test1094770152343003", "description": "Test1094770152438004 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "fields": [ { "id": "941021DD8CB04D3EB21BDB0F0C51D650", "name": "0002Test1094770152343003_string_single", "description": "0002Test1094770152343003_string_single", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "2B02826033484DDA8BFC5DA254C60EE1", "name": "0002Test1094770152343003_int_list", "description": "0002Test1094770152343003_int_list", "datatype": "number", "required": true, "valuecount": "list", "properties": {}, "settings": {} }, { "id": "B7A0C0FAC37B4DD38F0BD4BD66B4618A", "name": "0002Test1094770152343003_reference_single", "description": "0002Test1094770152343003_reference_single", "datatype": "reference", "required": false, "valuecount": "single", "properties": {}, "settings": {}, "referenceType": { "type": null, "types": [], "typeCategory": "ContentType" } } ], "properties": { "foo": "bar" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0002Test1094770152343003", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ] }, { "id": "145BFDB1D8FA4B7F86D18724C20EA162", "name": "0001Test1094751307482001", "description": "Test1094751309924002 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "fields": [ { "id": "DABD2854AB4E411AB6CC3E8AB49198D6", "name": "0001Test1094751307482001_string_single", "description": "0001Test1094751307482001_string_single", "datatype": "text", "required": true, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "A97BC69A43A34C4FA3F239033ED4B38A", "name": "0001Test1094751307482001_int_list", "description": "0001Test1094751307482001_int_list", "datatype": "number", "required": false, "valuecount": "list", "properties": {}, "settings": {} }, { "id": "8545B665F025415DAE47184FC8F585DE", "name": "0001Test1094751307482001_reference_single", "description": "0001Test1094751307482001_reference_single", "datatype": "reference", "required": true, "valuecount": "single", "properties": {}, "settings": {}, "referenceType": { "type": null, "types": [], "typeCategory": "ContentType" } } ], "properties": { "caas": { "slug": { "enabled": true, "pattern": "myslug-{name}" } } }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0001Test1094751307482001", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ], "connectorInfos": [ { "connectorId": "10000", "connectorSyncEnabled": true } ] } ], "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=all", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=all", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=all&offset=2", "rel": "next", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=all&offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=all&offset=136", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 9:
This lists 2 types and there will be standard fields and properties, fields in response.
/content/management/api/v1.1/types?limit=2&fields=fields,properties
Response Body
{ "hasMore": true, "offset": 0, "count": 2, "limit": 137, "items": [ { "id": "64C505716FBA499EAE93D12777AA0280", "name": "0002Test1094770152343003", "description": "Test1094770152438004 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "fields": [ { "id": "941021DD8CB04D3EB21BDB0F0C51D650", "name": "0002Test1094770152343003_string_single", "description": "0002Test1094770152343003_string_single", "datatype": "text", "required": false, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "2B02826033484DDA8BFC5DA254C60EE1", "name": "0002Test1094770152343003_int_list", "description": "0002Test1094770152343003_int_list", "datatype": "number", "required": true, "valuecount": "list", "properties": {}, "settings": {} }, { "id": "B7A0C0FAC37B4DD38F0BD4BD66B4618A", "name": "0002Test1094770152343003_reference_single", "description": "0002Test1094770152343003_reference_single", "datatype": "reference", "required": false, "valuecount": "single", "properties": {}, "settings": {}, "referenceType": { "type": null, "types": [], "typeCategory": "ContentType" } } ], "properties": { "foo": "bar" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0002Test1094770152343003", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ] }, { "id": "145BFDB1D8FA4B7F86D18724C20EA162", "name": "0001Test1094751307482001", "description": "Test1094751309924002 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "fields": [ { "id": "DABD2854AB4E411AB6CC3E8AB49198D6", "name": "0001Test1094751307482001_string_single", "description": "0001Test1094751307482001_string_single", "datatype": "text", "required": true, "valuecount": "single", "properties": {}, "settings": {} }, { "id": "A97BC69A43A34C4FA3F239033ED4B38A", "name": "0001Test1094751307482001_int_list", "description": "0001Test1094751307482001_int_list", "datatype": "number", "required": false, "valuecount": "list", "properties": {}, "settings": {} }, { "id": "8545B665F025415DAE47184FC8F585DE", "name": "0001Test1094751307482001_reference_single", "description": "0001Test1094751307482001_reference_single", "datatype": "reference", "required": true, "valuecount": "single", "properties": {}, "settings": {}, "referenceType": { "type": null, "types": [], "typeCategory": "ContentType" } } ], "properties": { "caas": { "slug": { "enabled": true, "pattern": "myslug-{name}" } } }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0001Test1094751307482001", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ] } ], "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=fields,properties", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=fields,properties", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=fields,properties&offset=2", "rel": "next", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=fields,properties&offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=fields,properties&offset=136", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 10:
This lists 2 types and there will be standard fields and connectorInfos in response.
/content/management/api/v1.1/types?limit=2&fields=connectorInfos
Response Body
{ "hasMore": true, "offset": 0, "count": 2, "limit": 137, "items": [ { "id": "64C505716FBA499EAE93D12777AA0280", "name": "0002Test1094770152343003", "description": "Test1094770152438004 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:46.486Z", "timezone": "UTC" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0002Test1094770152343003", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ] }, { "id": "145BFDB1D8FA4B7F86D18724C20EA162", "name": "0001Test1094751307482001", "description": "Test1094751309924002 description", "typeCategory": "ContentType", "createdBy": "marketing.cecsadmina", "createdDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "updatedBy": "marketing.cecsadmina", "updatedDate": { "value": "2019-11-08T13:45:45.940Z", "timezone": "UTC" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types/0001Test1094751307482001", "rel": "self", "method": "GET", "mediaType": "application/json" } ], "allowedActions": [ "preview", "read", "write", "update", "delete" ], "connectorInfos": [ { "connectorId": "10000", "connectorSyncEnabled": true } ] } ], "links": [ { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=connectorInfos", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=connectorInfos", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/types", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=connectorInfos&offset=2", "rel": "next", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=connectorInfos&offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/types?limit=2&orderBy=updatedDate:des&fields=connectorInfos&offset=136", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }
Example 11:
This lists 2 types and there will be standard fields and connectorInfos in response.
/content/management/api/v1.1/types?limit=2&fields=invalidField
Response Body
{ "detail": "Invalid field name : invalidField", "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", "title": "Invalid field name : invalidField", "status": 400 }