List Repository Assigned Types

get

/content/management/api/v1.1/repositories/{id}/assignedTypes

List assigned types under a repository.

Request

Path Parameters
Query Parameters
  • 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.
  • This parameter accepts a non negative integer and is used to control the size of the result.
    Default Value: 25
  • This parameter accepts a non negative integer and is used to control the start index of the result.
    Default Value: 0
  • 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
  • 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.
  • This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.
    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : AssignedTypes
Type: object
AssignedTypes
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : AggregationResult
Type: object
Show Source
Nested Schema : AssignedType
Type: object
AssignedType
Show Source
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 : date
Type: object
date
Show Source
Nested Schema : fields
Type: array
The list of fields of an assigned type.
Show Source
Nested Schema : inplacePreview
Type: array
The list of inplace previews of an assigned type.
Show Source
Nested Schema : layoutMapping
Type: array
The list of layout mappings of an assigned type.
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
The properties of an assigned type.
Nested Schema : TypeField
Type: object
FieldInAggrType.
Show Source
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 : InplacePreview
Type: object
InplacePreview
Show Source
Nested Schema : LayoutMapping
Type: object
LayoutMapping
Show Source
Nested Schema : formats
Type: object
Additional Properties Allowed
Show Source
layout formats.
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.
Back to Top

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"
    }
  ]
}
Back to Top