Jump to

• Request
• Response
• Examples

Read Editorial Role

get

/content/management/api/v1.1/editorialRoles/{roleId}

Read a custom editorial role by id.

Request

Path Parameters

• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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

{
    "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 read a custom editorial role by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/editorialRoles/{roleId}'

Example

/content/management/api/v1.1/editorialRoles/D2434092E77D436D96E468C343249B1D

This reads a custom editorial roles with id D2434092E77D436D96E468C343249B1D.

Response Body

{
  "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": "viewer",
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": null,
      "isValid": true,
      "operations": [
        "view"
      ]
    },
    {
      "typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
      "typeName": "Image",
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create"
      ]
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": null,
      "taxonomyShortName": null,
      "isForSiteManagement": false,
      "categoryId": "",
      "nodes": null,
      "isSiteCategory": false,
      "isValid": true,
      "operations": [
        "view"
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/D2434092E77D436D96E468C343249B1D",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/D2434092E77D436D96E468C343249B1D",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles/D2434092E77D436D96E468C343249B1D",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top