Read Repository Editorial Role
get
/content/management/api/v1.1/repositories/{id}/editorialRoles/{roleId}
Read a custom editorial role under a repository. The editorial role should be assigned to the repository.
Request
Path Parameters
-
id: string
id of the repository.
-
roleId: string
id of the custom editorial role.
Query Parameters
-
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
Response
Supported Media Types
- application/json
200 Response
OK.
Root 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.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to read a custom editorial role 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/{roleId}'
Example
/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05
This reads a custom editorial roles with id 76F2903A0C8E48BCA222E68264BE1E05 under a repository with id 7F289D0F4FD44C0382A83EFD44A355C0. 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
{ "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" }, { "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }