Jump to

• Request
• Response
• Examples

Convert a Permission Set.

post

/content/management/api/v1.1/repositories/{id}/permissionSets/{permissionSetId}/convertToEditorialRole

Convert a permission set of a repository to a custom editorial role.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Repository id parameter for permission sets.
• permissionSetId: string
  Id of the permission set.

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

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Bean representing a request payload to convert a repository permission set to a custom editorial role.

Root Schema : EditorialRoleOperation

Type: object

EditorialRoleOperation

Show Source

• description(optional): string
  Description of the custom editorial role to be created by this operation.
• name: string
  Name of the custom editorial role to be created by this operation.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the custom editorial role to be created by this operation."
        },
        "description":{
            "type":"string",
            "description":"Description of the custom editorial role to be created by this operation."
        }
    },
    "description":"EditorialRoleOperation"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

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."
        }
    }
}

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 convert a repository permission set to a custom editorial role by submitting a POST request using cURL.

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/repositories/{id}/permissionSets/{permissionSetId}/convertToEditorialRole'

Example

/content/management/api/v1.1/repositories/37A3950CB83543D4B48E379627BF3C99/permissionSets/F4810B9BD8F44ADAA1A7973FC039DA67/convertToEditorialRole

This converts the permission set with id F4810B9BD8F44ADAA1A7973FC039DA67 under repository with id 37A3950CB83543D4B48E379627BF3C99 to a custom editorial role. Request payload should define the name and optionally the description of the new editorial role. Replace payload with your own data.

Request Payload

{
  "name": "Role converted from permset",
  "description": "converted role description"
} 

Response Body

{
  "id": "F4810B9BD8F44ADAA1A7973FC039DA67",
  "name": "Role converted from permset",
  "description": "converted role description",
  "createdBy": "cecuser1",
  "createdDate": {
    "value": "2022-01-12T09:32:04.083Z",
    "timezone": "UTC"
  },
  "updatedBy": "cecuser1",
  "updatedDate": {
    "value": "2022-01-12T09:32:04.083Z",
    "timezone": "UTC"
  },
  "isUsed": true,
  "hasPrivilegeGranted": true,
  "contentPrivileges": [
    {
      "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"
      ]
    },
    {
      "typeId": "8CB7D974CBB74923BF40A6CA68BED145",
      "typeName": "TypeBBB",
      "typeDisplayName": "TypeBBB",
      "isValid": true,
      "isEnabled": true,
      "operations": [
        "view",
        "update",
        "create"
      ]
    },
    {
      "typeId": "B228AE0D8E2E41B8924C5B9FFBCAF039",
      "typeName": "TypeCCC",
      "typeDisplayName": "TypeCCC",
      "isValid": true,
      "isEnabled": true,
      "operations": []
    },
    {
      "typeId": "",
      "typeName": null,
      "typeDisplayName": null,
      "isValid": true,
      "isEnabled": true,
      "operations": [
        "view"
      ]
    }
  ],
  "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/37A3950CB83543D4B48E379627BF3C99/permissionSets/F4810B9BD8F44ADAA1A7973FC039DA67/convertToEditorialRole",
      "rel": "self",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/37A3950CB83543D4B48E379627BF3C99/permissionSets/F4810B9BD8F44ADAA1A7973FC039DA67/convertToEditorialRole",
      "rel": "canonical",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/37A3950CB83543D4B48E379627BF3C99/permissionSets/F4810B9BD8F44ADAA1A7973FC039DA67/convertToEditorialRole",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

Back to Top