List Editorial Roles
get
/content/management/api/v1.1/editorialRoles
List custom editorial roles.
Request
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, roleName) and additional fields (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 name and the only allowed operators for now are mt on name. This query param is optional with no default.
Example:
?q=(name mt "editor") -
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 : 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.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object EditorialRole
EditorialRole
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 : 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
Nested Schema : contentPrivileges
Type:
array
The privileges of asset type defined by a custom editorial role.
Show Source
-
Array of:
object ContentPrivilege
ContentPrivilege
Nested Schema : links
Type:
array
Links of a custom editorial role resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : taxonomyPrivileges
Type:
array
The privileges of taxonomy defined by a custom editorial role.
Show Source
-
Array of:
object TaxonomyPrivilege
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.
Nested Schema : operations
Type:
array
Operations.
Show Source
-
Array of:
string
Allowed Values:
[ "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.
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.
Nested Schema : operations
Type:
array
Operations.
Show Source
-
Array of:
string
Allowed Values:
[ "view", "categorize", "createsite" ]
Nested Schema : CategoryNodeBean
Type:
Show Source
object
-
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.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.
Examples
The following example shows how to list editorial roles by submitting a GET request using cURL.
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/editorialRoles'
Example
/content/management/api/v1.1/editorialRoles?limit=10&offset=0&orderBy=name:asc
This lists first set of 10 editorial roles with standard fields, sorted by editorial role name ascending.
Response Body
{ "hasMore": false, "offset": 0, "count": 1, "limit": 1, "items": [ { "id": "D2434092E77D436D96E468C343249B1D", "name": "Custom Editor Role", "description": "role description", "createdBy": "cecuser1", "createdDate": { "value": "2021-09-13T05:03:55.956Z", "timezone": "UTC" }, "updatedBy": "cecuser1", "updatedDate": { "value": "2021-09-13T05:03:55.956Z", "timezone": "UTC" }, "roleName": "manager", "links": [ { "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/D2434092E77D436D96E468C343249B1D", "rel": "self", "method": "GET", "mediaType": "application/json" } ] } ], "links": [ { "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }