List Repository Assigned Types
get
/content/management/api/v1.1/repositories/{id}/assignedTypes
List assigned types under a repository.
Request
Path Parameters
-
id: string
Repository id parameter for assigned types.
Query Parameters
-
fields(optional): string
This parameter is used to control the returned fields in each type in the list. This parameter accepts a comma-separated list of field names. All the field names are case-sensitive. Each assigned type can have these fields: id, name, displayName, apiName, description, typeCategory, createdBy, createdDate, updatedBy, updatedDate, allowedActions, allowedFileTypes, fields, properties, layoutMapping, inplacePreview. This parameter is optional. If it is not present, these default fields would be returned in the response: id, name, description. Any incorrect or invalid field name given in the query will be ignored.
Example:
?fields=id,name,displayName,typeCategory,allowedActions
This returns id, name, displayName, typeCategory, and allowedActions fields for each assigned type.
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
25
-
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, displayName, 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 allowedActions, allowedFileTypes, typeCategory, name and displayName. The only allowed operators are eq on allowedActions, allowedFileTypes, and typeCategory, and co on name and displayName. The only allowed logical operator is AND. This query param is optional.
Example:
?q=(allowedActions eq "ASSET_CREATE")
This returns the types of which the user can create assets in the repository.
Example:
?q=(displayName co "asset")
This returns the types with display name containing string "asset" (case insensitive) assigned to the repository.
Example:
?q=(typeCategory eq "ContentType")
This returns ContentType types assigned to the repository.
Example:
?q=(typeCategory eq "DigitalAssetType" AND allowedFileTypes eq "jpg")
This returns DigitalAssetType types assigned to the repository that support "jpg" file extension. -
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
Supported Media Types
- application/json
200 Response
OK.
Root Schema : AssignedTypes
Type:
object
AssignedTypes
Show Source
-
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.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object AssignedType
AssignedType
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : AssignedType
Type:
object
AssignedType
Show Source
-
allowedActions(optional):
array allowedActions
The logged-in user's allowed actions on assets of an assigned type. The actions can be "ASSET_VIEW", "ASSET_UPDATE", "ASSET_CREATE", and "ASSET_DELETE".
-
allowedFileTypes(optional):
array allowedFileTypes
The list of supported file extensions of an assigned type.
-
apiName(optional):
string
The API Name of an assigned type.
-
createdBy(optional):
string
The created by user of an assigned type.
-
createdDate(optional):
object date
date
-
description(optional):
string
The description of an assigned type.
-
displayName(optional):
string
The display name of an assigned type.
-
fields(optional):
array fields
The list of fields of an assigned type.
-
id(optional):
string
The id of an assigned type.
-
inplacePreview(optional):
array inplacePreview
The list of inplace previews of an assigned type.
-
layoutMapping(optional):
array layoutMapping
The list of layout mappings of an assigned type.
-
links(optional):
array links
The links of an assigned type resource.
-
name(optional):
string
The name of an assigned type.
-
properties(optional):
object properties
Additional Properties Allowed: additionalPropertiesThe properties of an assigned type.
-
typeCategory(optional):
string
The category of an assigned type. The category can be "ContentType" or "DigitalAssetType".
-
updatedBy(optional):
string
The updated by user of an assigned type.
-
updatedDate(optional):
object date
date
Nested Schema : allowedActions
Type:
array
The logged-in user's allowed actions on assets of an assigned type. The actions can be "ASSET_VIEW", "ASSET_UPDATE", "ASSET_CREATE", and "ASSET_DELETE".
Show Source
Nested Schema : allowedFileTypes
Type:
array
The list of supported file extensions of an assigned type.
Show Source
Nested Schema : fields
Type:
array
The list of fields of an assigned type.
Show Source
-
Array of:
object TypeField
FieldInAggrType.
Nested Schema : inplacePreview
Type:
array
The list of inplace previews of an assigned type.
Show Source
-
Array of:
object InplacePreview
InplacePreview
Nested Schema : layoutMapping
Type:
array
The list of layout mappings of an assigned type.
Show Source
-
Array of:
object LayoutMapping
LayoutMapping
Nested Schema : links
Type:
array
The links of an assigned type resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : properties
Type:
object
Additional Properties Allowed
Show Source
The properties of an assigned type.
Nested Schema : TypeField
Type:
object
FieldInAggrType.
Show Source
-
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.
Nested Schema : defaultValue
Type:
object
defaultValue for field.
Nested Schema : properties
Type:
object
Additional Properties Allowed
Show Source
Field specific properties. The field publishingDependency is specific for media and reference.
Example:
{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}
Nested Schema : settings
Type:
object
Additional Properties Allowed
Show Source
Field specific settings.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : LayoutMapping
Type:
object
LayoutMapping
Show Source
-
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.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
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.
Nested Schema : additionalProperties
Type:
object
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to list assigned types under a repository by submitting a GET request using cURL.
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/repositories/{id}/assignedTypes'
Example 1
/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions
This lists types that are assigned to the repository DE7E10DE3F7940A38C6584E4887ED281 and the user has create permission on assets in those types, sorted by type display name ascending.
Response Body
{ "hasMore": false, "offset": 0, "count": 3, "limit": 10, "totalResults": 3, "items": [ { "id": "C986A82C2F1A4C5DA1F0379343B62620", "name": "File", "displayName": "File", "apiName": "file", "description": "Asset type for assets other than images and videos", "typeCategory": "DigitalAssetType", "createdBy": "system", "createdDate": { "value": "2017-01-01T00:00:00.000Z", "timezone": "UTC" }, "updatedBy": "system", "updatedDate": { "value": "2017-01-01T00:00:00.000Z", "timezone": "UTC" }, "allowedActions": [ "ASSET_VIEW", "ASSET_UPDATE", "ASSET_CREATE", "ASSET_DELETE" ], "links": [ { "href": "http://{hostname}/content/management/api/v1.1/types/File", "rel": "canonical", "method": "GET", "mediaType": "application/json" } ] }, { "id": "EF4C64E6BF81419F9743A8A4348A69EB", "name": "Image", "displayName": "Image", "apiName": "image", "description": "Asset type for images", "typeCategory": "DigitalAssetType", "createdBy": "system", "createdDate": { "value": "2017-01-01T00:00:00.000Z", "timezone": "UTC" }, "updatedBy": "system", "updatedDate": { "value": "2017-01-01T00:00:00.000Z", "timezone": "UTC" }, "allowedActions": [ "ASSET_VIEW", "ASSET_UPDATE", "ASSET_CREATE", "ASSET_DELETE" ], "links": [ { "href": "http://{hostname}/content/management/api/v1.1/types/Image", "rel": "self", "method": "canonical", "mediaType": "application/json" } ] }, { "id": "FCC73EFCAD8B4BFDA3FD73D5DCBC8099", "name": "TypeAAA", "displayName": "TypeAAA", "apiName": "typeAaa", "description": "", "typeCategory": "ContentType", "createdBy": "cecuser1", "createdDate": { "value": "2022-12-16T20:16:38.336Z", "timezone": "UTC" }, "updatedBy": "cecuser1", "updatedDate": { "value": "2022-12-16T20:17:13.135Z", "timezone": "UTC" }, "allowedActions": [ "ASSET_VIEW", "ASSET_UPDATE", "ASSET_CREATE" ], "links": [ { "href": "http://{hostname}/content/management/api/v1.1/types/TypeAAA", "rel": "canonical", "method": "GET", "mediaType": "application/json" } ] } ], "links": [ { "href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://{hostname}/content/management/api/v1.1/metadata-catalog/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes", "rel": "describedby", "method": "GET", "mediaType": "application/json" }, { "href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }