1. REST API for Content Management
  2. Tasks
  3. Repositories

List Repository Assigned Taxonomies

get

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

List assigned taxonomies under a repository.

Request

Path Parameters
Query Parameters
  • This parameter is used to control the returned fields in each assigned taxonomy in the list. This parameter accepts a comma-separated list of field names. These fields will be returned for assigned taxonomy in the list. All the field names are case-sensitive, and users must provide the correct field names in the query. Each assigned taxonomy can have these fields: id, name, description, shortName, version, isPublishable, isForSiteManagement, createdBy, createdDate, updatedBy, updatedDate, allowedActions. This parameter is optional. If it is not present, the default fields would be returned in the response: id, name, description. Any incorrect or invalid field name given in the parameter will throw an error.

    Example: ?fields=id,name,shortName,isForSiteManagement,allowedActions
    This returns id, name, shortName, isForSiteManagement, and allowedActions fields for each assigned taxonomy.
  • 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 order of results. The value of this query parameter follow 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. The default value of this parameter is name:asc.
    Default Value: name:asc
  • This parameter accepts a query expression condition that matches the field values. Query conditions can be joined using AND operators and grouped with parentheses. The value of a query condition follows the format of {fieldName} {operator} "{fieldValue}". The only field names allowed are name, isForSiteManagement, and allowedActions. A query cannot include multiple same named fields.
    The only allowed operator is eq (Equals) for isForSiteManagement and the allowed values are either "false" or "true".
    The only allowed operator is co (Contains) for name and its value is case insensitive.
    The only allowed operator is eq (Equals) for allowedActions and the allowed values are either "ASSET_CATEGORIZE" or "SITE_CREATE".

    Example:
    ?q=(isForSiteManagement eq "true") AND (allowedActions eq "SITE_CREATE")
    This query filters assigned taxonomies by both isForSiteManagement and allowedActions fields to return the Site Security taxonomies the user has Create Site permission.

    Example:
    ?q=(allowedActions eq "ASSET_CATEGORIZE") AND (name co "org")
    This query filters assigned taxonomies by both allowedActions and name fields to return the taxonomies with names containing "org" (case-insensitively) and the user has Categorize permission.
  • 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 : AssignedTaxonomies
Type: object
AssignedTaxonomies
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 : AssignedTaxonomy
Type: object
AssignedTaxonomy
Show Source
Nested Schema : allowedActions
Type: array
The allowed actions of an assigned taxonomy. The actions can be "ASSET_CATEGORIZE" and "SITE_CREATE".
Show Source
Nested Schema : date
Type: object
date
Show Source

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 taxonomies 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}/assignedTaxonomies'

Example:

This lists taxonomies that are assigned to the repository 720E2B7391E64FB9A1EB5FA6DEA8F4C7, with isForSiteManagement field set to \"true\" and name field containing \"org\" case-insensitively, sorted by taxonomy name ascending. 

/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?offset=0&limit=10&orderBy=name:asc&q=(isForSiteManagement eq \"true\") AND (name co \"org\")&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions&totalResults=true

Response Body

{
  "hasMore": false,
  "offset": 0,
  "count": 2,
  "limit": 2,
  "totalResults": 2,
  "items": [
    {
      "id": "FB8240D6DC70407F87ED111325D06F89",
      "name": "Organization1",
      "description": "organization one",
      "shortName": "ORG",
      "version": 1,
      "isPublishable": false,
      "isForSiteManagement": true,
      "allowedActions": [
        "ASSET_CATEGORIZE",
        "SITE_CREATE"
      ],
      "links": [
        {
          "href": "http://{hostname}/content/management/api/v1.1/taxonomies/FB8240D6DC70407F87ED111325D06F89",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "9252676B0FD34FFCB40C6F65030001E7",
      "name": "Organization2",
      "description": "organization two",
      "shortName": "OR1",
      "version": 1,
      "isPublishable": false,
      "isForSiteManagement": true,
      "allowedActions": [],
      "links": [
        {
          "href": "http://{hostname}/content/management/api/v1.1/taxonomies/9252676B0FD34FFCB40C6F65030001E7",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://{hostname}/content/management/api/v1.1/metadata-catalog/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}
Back to Top