Help Contents

 

Permissions (Resources)

Resource: Permissions ( /api/permissions )

Permissions (collection) resource.

Root Relation: Permissions

This resource supports the following methods: GET

Methods

GET


Retrieves list of permissions (including all child permissions).

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.

Example - Retrieve all permissions

Returns a collection of all permissions (including all nested permissions)

Request Headers

KeyValueDescription
Acceptapplication/json

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Items": [
    {
      "Id": "16342c78-d2ec-4436-a9c3-aaa105cafda4",
      "Key": "/Resources",
      "Name": "Resources",
      "Children": [
        {
          "Id": "38d05448-09f7-4a13-b091-bc271d148246",
          "Key": "/Resources/ExternalLinks",
          "Name": "External Links",
          "Children": [],
          "Self": "http://localhost/api/permission/38d05448-09f7-4a13-b091-bc271d148246"
        }
      ],
      "Self": "http://localhost/api/permission/16342c78-d2ec-4436-a9c3-aaa105cafda4"
    },
    {
      "Id": "b5fee9b8-563a-4d1b-b3b0-4a0cea9cf78e",
      "Key": "/Administration",
      "Name": "Administration",
      "Children": [],
      "Self": "http://localhost/api/permission/b5fee9b8-563a-4d1b-b3b0-4a0cea9cf78e"
    }
  ]
}

Status Code

200 - OK