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
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : EditorialRole
Type: object
EditorialRole
Show Source
Nested Schema : contentPrivileges
Type: array
The privileges of asset type defined by a custom editorial role.
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : taxonomyPrivileges
Type: array
The privileges of taxonomy defined by a custom editorial role.
Show Source
Nested Schema : ContentPrivilege
Type: object
ContentPrivilege
Show Source
Nested Schema : operations
Type: array
Operations.
Show Source
Nested Schema : TaxonomyPrivilege
Type: object
TaxonomyPrivilege
Show Source
Nested Schema : nodes
Type: array
The path of the category.
Show Source
Nested Schema : operations
Type: array
Operations.
Show Source
Nested Schema : CategoryNodeBean
Type: object
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 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"
    }
  ]
}
Back to Top