Jump to

• Request
• Response
• Examples

Read Permission Operations Status

get

/content/management/api/v1.1/permissionOperations/{statusId}

Read Permission Operations status.

Request

Path Parameters

• statusId: string
  status id of the permission operations.

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 : PermissionOperationsStatus

Type: object

PermissionOperationsStatus

Show Source

• completed(optional): boolean
  Whether the original request is completed or not
• completedPercentage(optional): integer(int32)
  A number between 0 and 100, capturing how much of the process has been completed.
• endTime(optional): object date
  date
• error(optional): object Error
  Error
• id(optional): string
  status id of the original request. It is a required property in the get response.
• links(optional): array links
  links of the status resource
• message(optional): string
  Human readable message about the current processing status
• progress(optional): string
  Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  The current progress of the original request. It is a required property in the get response.
• requestStatus(optional): integer(int32)
  HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed
• result(optional): object ResultPermissionOperations
  Result
• startTime(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"status id of the original request. It is a required property in the get response."
        },
        "startTime":{
            "description":"Time when the original request started",
            "$ref":"#/definitions/date"
        },
        "endTime":{
            "description":"Time when the original request ended",
            "$ref":"#/definitions/date"
        },
        "progress":{
            "type":"string",
            "description":"The current progress of the original request. It is a required property in the get response.",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the original request is completed or not"
        },
        "message":{
            "type":"string",
            "description":"Human readable message about the current processing status"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "requestStatus":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed"
        },
        "result":{
            "description":"The response when the original async request finishes",
            "$ref":"#/definitions/ResultPermissionOperations"
        },
        "error":{
            "description":"contains error detail of the original request. This is only available when the original request is processed and failed",
            "$ref":"#/definitions/Error"
        },
        "links":{
            "type":"array",
            "description":"links of the status resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionOperationsStatus"
}

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 : Error

Type: object

Error

Show Source

• detail(optional): string
  Detailed error message.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application specific error code.
• o:errorDetails(optional): object Error
  Error
• o:errorPath(optional): string
  XPath or JSON patch to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code.
• title(optional): string
  Summary error message. It is a required property in the get response.
• type(optional): string
  Link to HTTP error code page. It is a required property in the get response.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Summary error message. It is a required property in the get response."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page. It is a required property in the get response."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application specific error code."
        },
        "o:errorDetails":{
            "description":"Drill down to the details. Multiple errors can be organized in a hierarchical structure.",
            "$ref":"#/definitions/Error"
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON patch to indicate where the error occurs."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        }
    },
    "description":"Error"
}

Nested Schema : links

Type: array

links of the status resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the status resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ResultPermissionOperations

Type: object

Result

Show Source

• body(optional): object PermissionOperations
  Permission Operations
• headers(optional): array headers
  List of the HTTP headers of the response to the original async request
• status(optional): object ResultHTTPStatus
  ResultHTTPStatus

{
    "type":"object",
    "properties":{
        "status":{
            "description":"HTTP status line of the response to the original async request",
            "$ref":"#/definitions/ResultHTTPStatus"
        },
        "headers":{
            "type":"array",
            "description":"List of the HTTP headers of the response to the original async request",
            "items":{
                "$ref":"#/definitions/ResultHTTPHeader"
            }
        },
        "body":{
            "description":"HTTP body of the response to the original async request",
            "$ref":"#/definitions/PermissionOperations"
        }
    },
    "description":"Result"
}

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 : PermissionOperations

Type: object

Permission Operations

Show Source

• links(optional): array links
  Links of the permission operations resource.
• operations(optional): object PermissionOperationsActions
  Operations that can be performed. Currently only one operation at a time is supported.

{
    "type":"object",
    "properties":{
        "operations":{
            "description":"Operations to perform. It is a required property in the post request.",
            "$ref":"#/definitions/PermissionOperationsActions"
        },
        "links":{
            "type":"array",
            "description":"Links of the permission operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Permission Operations"
}

Nested Schema : headers

Type: array

List of the HTTP headers of the response to the original async request

Show Source

• Array of: object ResultHTTPHeader
  ResultHTTPHeader

{
    "type":"array",
    "description":"List of the HTTP headers of the response to the original async request",
    "items":{
        "$ref":"#/definitions/ResultHTTPHeader"
    }
}

Nested Schema : ResultHTTPStatus

Type: object

ResultHTTPStatus

Show Source

• code(optional): integer(int32)
  HTTP response status code
• reason(optional): string
  HTTP response reason phrase

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP response status code"
        },
        "reason":{
            "type":"string",
            "description":"HTTP response reason phrase"
        }
    },
    "description":"ResultHTTPStatus"
}

Nested Schema : links

Type: array

Links of the permission operations resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the permission operations resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PermissionOperationsActions

Type: object

Operations that can be performed. Currently only one operation at a time is supported.

Show Source

• share(optional): object SharePermission
  Details of the share operation
• unshare(optional): object UnSharePermission
  Details of the unshare operation

{
    "type":"object",
    "properties":{
        "share":{
            "description":"Share resource with other users or groups.",
            "$ref":"#/definitions/SharePermission"
        },
        "unshare":{
            "description":"Unshare resource with other users or groups.",
            "$ref":"#/definitions/UnSharePermission"
        }
    },
    "description":"Operations that can be performed. Currently only one operation at a time is supported."
}

Nested Schema : SharePermission

Type: object

Details of the share operation

Show Source

• failedRoles(optional): array failedRoles
  failed share list.
• resource(optional): object ResourceId
  ResourceId
• roles(optional): array roles
  details of the roles to be granted.
• successRoles(optional): array successRoles
  successful share list.

{
    "type":"object",
    "properties":{
        "resource":{
            "description":"resource to be shared.",
            "$ref":"#/definitions/ResourceId"
        },
        "roles":{
            "type":"array",
            "description":"details of the roles to be granted.",
            "items":{
                "$ref":"#/definitions/SharePermissionRole"
            }
        },
        "successRoles":{
            "type":"array",
            "description":"successful share list.",
            "items":{
                "$ref":"#/definitions/SuccessSharePermissionRole"
            }
        },
        "failedRoles":{
            "type":"array",
            "description":"failed share list.",
            "items":{
                "$ref":"#/definitions/FailedSharePermissionRole"
            }
        }
    },
    "description":"Details of the share operation"
}

Nested Schema : UnSharePermission

Type: object

Details of the unshare operation

Show Source

• failedUsers(optional): array failedUsers
• message(optional): string
• resource(optional): object ResourceId
  ResourceId
• successUsers(optional): array successUsers
• users(optional): array users

{
    "type":"object",
    "properties":{
        "resource":{
            "description":"resource to be unshared.",
            "$ref":"#/definitions/ResourceId"
        },
        "message":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        },
        "successUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        },
        "failedUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        }
    },
    "description":"Details of the unshare operation"
}

Nested Schema : failedRoles

Type: array

failed share list.

Show Source

• Array of: object FailedSharePermissionRole
  Details of share operation role failed.

{
    "type":"array",
    "description":"failed share list.",
    "items":{
        "$ref":"#/definitions/FailedSharePermissionRole"
    }
}

Nested Schema : ResourceId

Type: object

ResourceId

Show Source

• id(optional): string
  id of the resource.
• name(optional): string
  Name of the resource.
• type(optional): string
  Allowed Values: [ "repository", "collection", "channel", "type", "workflow", "scheduledjob", "translationjob", "editorialrole", "publishingrole", "siteplan", "taxonomy", "retentionpolicy", "hold" ]

  Type of the resource.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the resource."
        },
        "name":{
            "type":"string",
            "description":"Name of the resource."
        },
        "type":{
            "type":"string",
            "description":"Type of the resource.",
            "enum":[
                "repository",
                "collection",
                "channel",
                "type",
                "workflow",
                "scheduledjob",
                "translationjob",
                "editorialrole",
                "publishingrole",
                "siteplan",
                "taxonomy",
                "retentionpolicy",
                "hold"
            ]
        }
    },
    "description":"ResourceId"
}

Nested Schema : roles

Type: array

details of the roles to be granted.

Show Source

• Array of: object SharePermissionRole
  Details of share operation role.

{
    "type":"array",
    "description":"details of the roles to be granted.",
    "items":{
        "$ref":"#/definitions/SharePermissionRole"
    }
}

Nested Schema : successRoles

Type: array

successful share list.

Show Source

• Array of: object SuccessSharePermissionRole
  Details of successful share operation role.

{
    "type":"array",
    "description":"successful share list.",
    "items":{
        "$ref":"#/definitions/SuccessSharePermissionRole"
    }
}

Nested Schema : FailedSharePermissionRole

Type: object

Details of share operation role failed.

Show Source

• id(optional): string
  id of the role to be granted.
• name(optional): string
  name of the role to be granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role to be granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role to be granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role to be granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role to be granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        }
    },
    "description":"Details of share operation role failed."
}

Nested Schema : users

Type: array

Show Source

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

Nested Schema : FailedUserId

Type: object

FailedUserId

Show Source

• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• message(optional): string
  failure message.
• name(optional): string
• type(optional): string
  Allowed Values: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "message":{
            "type":"string",
            "description":"failure message."
        }
    },
    "description":"FailedUserId"
}

Nested Schema : SharePermissionRole

Type: object

Details of share operation role.

Show Source

• id(optional): string
  id of the role to be granted.
• message(optional): string
• name(optional): string
  name of the role to be granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role to be granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role to be granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role to be granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role to be granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "message":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"Details of share operation role."
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : UserId

Type: object

UserId

Show Source

• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• name(optional): string
• type(optional): string
  Allowed Values: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"UserId"
}

Nested Schema : SuccessSharePermissionRole

Type: object

Details of successful share operation role.

Show Source

• id(optional): string
  id of the role granted.
• name(optional): string
  name of the role granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"Details of successful share operation role."
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : failedUsers

Type: array

Show Source

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

Nested Schema : successUsers

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : ResultHTTPHeader

Type: object

ResultHTTPHeader

Show Source

• name(optional): string
  HTTP response header name
• value(optional): string
  HTTP response header value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"HTTP response header name"
        },
        "value":{
            "type":"string",
            "description":"HTTP response header value"
        }
    },
    "description":"ResultHTTPHeader"
}

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 status of a permission operation by submitting a GET request on the REST resource using cURL.

curl -X GET 'content-type: application/json' 'https://host:port/content/management/api/v1.1/permissionOperations/{statusId}'

Example 1:

This reads status of a successful permission asynchronous share operation with operation id: OP4C2BA99B626B4E43A4A64853D639F4CA.

/content/management/api/v1.1/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA

Response Body

{
        "id": "OP4C2BA99B626B4E43A4A64853D639F4CA",
        "startTime": {
          "value": "2018-12-21T06:47:14.656Z",
          "timezone": "UTC"
        },
        "endTime": {
          "value": "2018-12-21T06:47:16.759Z",
          "timezone": "UTC"
        },
        "progress": "succeeded",
        "completed": true,
        "message": "Job Completed Successfully",
        "completedPercentage": 100,
        "result": {
          "status": {
            "code": 200,
            "reason": ""
          },
          "headers": [],
          "body": {
            "operations": {
              "share": {
                "resource" : {
                  "id" : "F0A4079D50E370E0B074F62AE4863ECDF2B8EF156CC7",
                  "type" : "repository"
                },
                "roles": [
                  {
                    "name" : "viewer",
                    "message" : "message1",
                    "users" : [
                      {"id" : "cecuserLoginIdName", "type" : "user"}
                    ]
                  },
                  {
                    "name" : "manager",
                    "message" : "message2",
                    "users" : [
                      {"id" : "cecgroupLoginIdName", "type" : "group"}
                    ]
                  }
                ],
                "successRoles": [
                  {
                    "name" : "viewer",
                    "users" : [
                      {"id" : "cecuserLoginIdName", "type" : "user"}
                    ]
                  },
                  {
                    "name" : "manager",
                    "users" : [
                      {"id" : "cecgroupLoginIdName", "type" : "group"}
                    ]
                  }
                ]
              }
            },
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
                "rel": "self",
                "method": "POST",
                "mediaType": "application/json"
              },
              {
                "href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
                "rel": "canonical",
                "method": "POST",
                "mediaType": "application/json"
              },
              {
                "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations",
                "rel": "describedby",
                "method": "GET",
                "mediaType": "application/schema+json"
              }
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }

Example 2:

This reads status of a successful item permissionOperations unshare operation with operation id: E2A8C607848940D9ADA0DFFBE078E793.

/content/management/api/v1.1/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793

Request Body

{
        "id": "E2A8C607848940D9ADA0DFFBE078E793",
        "startTime": {
          "value": "2018-12-21T06:47:14.656Z",
          "timezone": "UTC"
        },
        "endTime": {
          "value": "2018-12-21T06:47:16.759Z",
          "timezone": "UTC"
        },
        "progress": "succeeded",
        "completed": true,
        "message": "Job Completed Successfully",
        "completedPercentage": 100,
        "result": {
          "status": {
            "code": 200,
            "reason": ""
          },
          "headers": [],
          "body": {
            "operations": {
              "unshare": {
                "resource": {
                  "id": "F0A4079D50E370E0B074F62AE4863ECDF2B8EF156CC7",
                  "type": "repository"
                },
                "message": "hi",
                "users": [
                  {
                    "id": "cecuserLoginIdName",
                    "type": "user"
                  }
                ],
                "successUsers": [
                  {
                    "id": "cecuserLoginIdName",
                    "type": "user"
                  }
                ]
              }
            },
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
                "rel": "self",
                "method": "POST",
                "mediaType": "application/json"
              },
              {
                "href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
                "rel": "canonical",
                "method": "POST",
                "mediaType": "application/json"
              },
              {
                "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations",
                "rel": "describedby",
                "method": "GET",
                "mediaType": "application/schema+json"
              }
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Back to Top