Jump to

• Request
• Response
• Examples

List Permissions of an Item

get

/content/management/api/v1.1/items/{id}/permissions

Lists all permissions (allowed actions) of a given item.

Request

Path Parameters

• id: string
  id of the item.

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

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Action"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : data

Type: array

Show Source

• Array of: object Action
  Action

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Action

Type: object

Action

Show Source

• action(optional): string
  Allowed Values: [ "view", "update", "create", "delete" ]

  action is allowed on the resource

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"action is allowed on the resource",
            "enum":[
                "view",
                "update",
                "create",
                "delete"
            ]
        }
    },
    "description":"Action"
}

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

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 list permissions (allowed actions) of an item.

curl -i -X GET -H 'Accept:application/json' 'https://host:port/content/management/api/v1.1/items/{id}/permissions'

Example

This lists all permissions (allowed actions) of item with id CORED98388F2AA724E27844821414B0B0447.

/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/permissions

Response Body

{
	    "data": [
	        {
	            "action": "view"
	        },
	        {
	            "action": "update"
	        },
	        {
	            "action": "create"
	        },
	        {
	            "action": "delete"
	        }
	    ],
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/permissions",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }    

Back to Top