Get Permission Rule

Get Permission Rule

Retrieves details for a specific permission rule. Each rule contains information about the principal and the access rights assigned.

Request
URI
GET
https://{api_host}/vco/api/tasks/{id}/permissions/{ruleId}
COPY
Path Parameters
string
Required
string
Required
Responses
200

The request is successful

Returns permission of type(s) application/json 
{
    "principal": "string",
    "rights": "string",
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    }
}
string
principal
Optional

principal

string
rights
Optional

rights

string
href
Optional

href

Relations
relations
Optional

relations


401

The user is not authorized

Operation doesn't return any data structure

404

Can not find a task with the specified ID, the user does not have 'read' access rights for that task, or the permission rule with the specified ID does not exist.

Operation doesn't return any data structure

On This Page
Task Service Operations
POST
Create Task
DELETE
Delete Permission Rule
DELETE
Delete Permissions For Object
DELETE
Delete Task
GET
Get Executions
GET
Get Permission Rule
GET
Get Permissions For Object
GET
Get Task
GET
Get Tasks
POST
Insert Permissions For Object
PUT
Update Permission Rule
POST
Update Task