Jump to

• Request
• Response
• Examples

List Repository Editorial Roles

get

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

List custom editorial roles under a repository.

Request

Path Parameters

• id: string
  id of the repository.

Query Parameters

• fields(optional): string
  This parameter is used to control the returned fields in each editorial role in the list. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each editorial role in the list. All the field names are case-sensitive, and users must provide the correct field names in the query. Each editorial role has both standard fields (id, name, description, createdBy, createdDate, updatedBy, updatedDate) and additional fields (isUsed, hasPrivilegeGranted, contentPrivileges, taxonomyPrivileges). When fields is specified as all (case-insensitive), all the standard and additional fields are returned. This parameter is optional in the query, and by default the result shows only standard fields in the response. Any incorrect or invalid field name given in the query will throw an error. Note that the "id" field would always be returned even if it is not explicitly specified by this parameter.
  
  Example: ?fields=id,name,description
  This returns id, name, and description fields for each editorial role.
  Example: ?fields=all
  This will return all standard fields and all additional fields for each editorial role.
  
• limit(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the size of the result.

  Default Value: 50
• 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 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.

  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 isUsed and the only allowed operators for now are eq on isUsed. The only fieldValues allowed for now are true and false. This query param is optional with no default.
  Example:
  ?q=(isUsed eq "true")
• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EditorialRoles

Type: object

EditorialRoles

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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/EditorialRole"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"EditorialRoles"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object EditorialRole
  EditorialRole

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/EditorialRole"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : EditorialRole

Type: object

EditorialRole

Show Source

• contentPrivileges(optional): array contentPrivileges
  The privileges of asset type defined by a custom editorial role.
• createdBy(optional): string
  Created by user of a custom editorial role.
• createdDate(optional): object date
  date
• description(optional): string
  Description of a custom editorial role.
• hasPrivilegeGranted(optional): boolean
  Whether a custom editorial role grants any privilege under the context of a given repository.
• id(optional): string
  ID of a custom editorial role.
• isUsed(optional): boolean
  Whether a custom editorial role is being used by a given repository.
• links(optional): array links
  Links of a custom editorial role resource.
• name(optional): string
  Name of a custom editorial role.
• roleName(optional): string
  Name of the user's role on a custom editorial role.
• taxonomyPrivileges(optional): array taxonomyPrivileges
  The privileges of taxonomy defined by a custom editorial role.
• updatedBy(optional): string
  Updated by user of a custom editorial role.
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of a custom editorial role."
        },
        "name":{
            "type":"string",
            "description":"Name of a custom editorial role."
        },
        "description":{
            "type":"string",
            "description":"Description of a custom editorial role."
        },
        "createdBy":{
            "type":"string",
            "description":"Created by user of a custom editorial role."
        },
        "createdDate":{
            "description":"Created date and time of a custom editorial role.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by user of a custom editorial role."
        },
        "updatedDate":{
            "description":"Updated date and time of a custom editorial role.",
            "$ref":"#/definitions/date"
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on a custom editorial role."
        },
        "isUsed":{
            "type":"boolean",
            "description":"Whether a custom editorial role is being used by a given repository."
        },
        "hasPrivilegeGranted":{
            "type":"boolean",
            "description":"Whether a custom editorial role grants any privilege under the context of a given repository."
        },
        "contentPrivileges":{
            "type":"array",
            "description":"The privileges of asset type defined by a custom editorial role.",
            "items":{
                "$ref":"#/definitions/ContentPrivilege"
            }
        },
        "taxonomyPrivileges":{
            "type":"array",
            "description":"The privileges of taxonomy defined by a custom editorial role.",
            "items":{
                "$ref":"#/definitions/TaxonomyPrivilege"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of a custom editorial role resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"EditorialRole"
}

Nested Schema : contentPrivileges

Type: array

The privileges of asset type defined by a custom editorial role.

Show Source

• Array of: object ContentPrivilege
  ContentPrivilege

{
    "type":"array",
    "description":"The privileges of asset type defined by a custom editorial role.",
    "items":{
        "$ref":"#/definitions/ContentPrivilege"
    }
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : links

Type: array

Links of a custom editorial role resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of a custom editorial role resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : taxonomyPrivileges

Type: array

The privileges of taxonomy defined by a custom editorial role.

Show Source

• Array of: object TaxonomyPrivilege
  TaxonomyPrivilege

{
    "type":"array",
    "description":"The privileges of taxonomy defined by a custom editorial role.",
    "items":{
        "$ref":"#/definitions/TaxonomyPrivilege"
    }
}

Nested Schema : ContentPrivilege

Type: object

ContentPrivilege

Show Source

• isEnabled(optional): boolean
  Whether the privilege is enabled under the context of a repository.
• isValid(optional): boolean
  The validness of the privilege.
• operations(optional): array operations
  Operations.
• typeDisplayName(optional): string
  The display name of the content type.
• typeId(optional): string
  The id of the content type.
• typeName(optional): string
  The name of the content type.

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string",
            "description":"The id of the content type."
        },
        "typeName":{
            "type":"string",
            "description":"The name of the content type."
        },
        "typeDisplayName":{
            "type":"string",
            "description":"The display name of the content type."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "update",
                    "create",
                    "delete"
                ]
            }
        }
    },
    "description":"ContentPrivilege"
}

Nested Schema : operations

Type: array

Operations.

Show Source

• Array of: string
  Allowed Values: [ "view", "update", "create", "delete" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "update",
            "create",
            "delete"
        ]
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : TaxonomyPrivilege

Type: object

TaxonomyPrivilege

Show Source

• categoryId(optional): string
  The id of the category.
• isEnabled(optional): boolean
  Whether the privilege is enabled under the context of a repository.
• isForSiteManagement(optional): boolean
  Whether the taxonomy is for site management.
• isSiteCategory(optional): boolean
  Whether the category is a site category.
• isValid(optional): boolean
  The validness of the privilege.
• nodes(optional): array nodes
  The path of the category.
• operations(optional): array operations
  Operations.
• taxonomyId(optional): string
  The id of the taxonomy.
• taxonomyShortName(optional): string
  The short name of the taxonomy.

{
    "type":"object",
    "properties":{
        "taxonomyId":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "taxonomyShortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether the taxonomy is for site management."
        },
        "categoryId":{
            "type":"string",
            "description":"The id of the category."
        },
        "nodes":{
            "type":"array",
            "description":"The path of the category.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "isSiteCategory":{
            "type":"boolean",
            "description":"Whether the category is a site category."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "categorize",
                    "createsite"
                ]
            }
        }
    },
    "description":"TaxonomyPrivilege"
}

Nested Schema : nodes

Type: array

The path of the category.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"The path of the category.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : operations

Type: array

Operations.

Show Source

• Array of: string
  Allowed Values: [ "view", "categorize", "createsite" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "categorize",
            "createsite"
        ]
    }
}

Nested Schema : CategoryNodeBean

Type: object

Show Source

• apiName(optional): string
  The apiName of the Category node.
• id(optional): string
  The id of the Category node.
• name(optional): string
  The name of the Category node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    }
}

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 custom editorial roles 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}/editorialRoles'

Example

/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles?limit=10&offset=0&orderBy=name:asc&q=isUsed eq \"true\"&fields=all

This lists first set of 10 editorial roles with all fields that are used by the repository with id 7F289D0F4FD44C0382A83EFD44A355C0, sorted by editorial role name ascending. If a type rule has a type that is not assigned to the repository, or a taxonomy rule has a taxonomy that is not assigned to the repository, that rule is marked as disabled.

Response Body

{
  "hasMore": false,
  "offset": 0,
  "count": 1,
  "limit": 10,
  "items": [
    {
      "id": "76F2903A0C8E48BCA222E68264BE1E05",
      "name": "Role 1019B",
      "description": "desc",
      "createdBy": "cecuser1",
      "createdDate": {
        "value": "2021-10-19T18:51:24.223Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecuser1",
      "updatedDate": {
        "value": "2021-10-19T18:51:24.223Z",
        "timezone": "UTC"
      },
      "isUsed": true,
      "hasPrivilegeGranted": true,
      "contentPrivileges": [
        {
          "typeId": "",
          "typeName": null,
          "typeDisplayName": null,
          "isValid": true,
          "isEnabled": true,
          "operations": [
            "view"
          ]
        },
        {
          "typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
          "typeName": "Image",
          "typeDisplayName": "Image",
          "isValid": true,
          "isEnabled": true,
          "operations": [
            "view",
            "update",
            "create",
            "delete"
          ]
        },
        {
          "typeId": "49B267B515C84AD7903C5B9C34EDB09E",
          "typeName": "TypeAAA",
          "typeDisplayName": "TypeAAA",
          "isValid": true,
          "isEnabled": true,
          "operations": [
            "view",
            "update",
            "create",
            "delete"
          ]
        },
        {
          "typeId": "8CB7D974CBB74923BF40A6CA68BED145",
          "typeName": "TypeBBB",
          "typeDisplayName": "TypeBBB",
          "isValid": true,
          "isEnabled": true,
          "operations": []
        },
        {
          "typeId": "B228AE0D8E2E41B8924C5B9FFBCAF039",
          "typeName": "TypeCCC",
          "typeDisplayName": "TypeCCC",
          "isValid": true,
          "isEnabled": false,
          "operations": [
            "view",
            "update",
            "create",
            "delete"
          ]
        }
      ],
      "taxonomyPrivileges": [
        {
          "taxonomyId": null,
          "taxonomyShortName": null,
          "isForSiteManagement": false,
          "categoryId": "",
          "nodes": null,
          "isSiteCategory": false,
          "isValid": true,
          "isEnabled": true,
          "operations": [
            "view"
          ]
        }
      ],
      "links": [
        {
          "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles?limit=10&orderBy=name:asc&q=isUsed eq \"true\"&offset=0",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles?limit=10&orderBy=name:asc&q=isUsed eq \"true\"&offset=0",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles?limit=10&orderBy=name:asc&q=isUsed eq \"true\"&offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles?limit=10&orderBy=name:asc&q=isUsed eq \"true\"&offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

Back to Top