List a single role by ID.

List a single role by ID. Get an organizational role of this process space.

Security: Any user holding a Bpanda licence for the process space.

GET/v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

ID of warehouse

roleIdstringrequired

ID of the organizational role

Query parameters

fromAccumulatedboolean

use only roles or roles and role subsets (intersections with org units)

Responses

200

Organizational role

baseRoleIdstring

descriptionLocalizedFormattedText[]required

Show properties

Array of LocalizedFormattedText

formatTextFormatrequired

Allowed:BBCodeHTMLPlainText

textLocalizedStringrequired

Show properties

translationsStringTranslation[]required

valuestring

externalbooleanrequired

idstring

roleTypeIdstringrequired

subTypestringrequired

titleLocalizedStringrequired

Show properties

translationsStringTranslation[]required

Show properties

Array of StringTranslation

languagestringrequired

valuestring

unitIdstring

userIdsstring[]required

404

Organizational role not found

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)API keyRemember on this deviceInclude my values in samples

Parameters

warehouseIdpath*ID of warehouseroleIdpath*ID of the organizational rolefromAccumulatedqueryuse only roles or roles and role subsets (intersections with org units)

Request

curl -X GET 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/orgstructure/roles/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/orgstructure/roles/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY"
  }
});

Response

{
  "baseRoleId": "string",
  "description": [
    {
      "format": "BBCode",
      "text": {
        "translations": [
          {
            "language": "string",
            "value": "string"
          }
        ],
        "value": "string"
      }
    }
  ],
  "external": true,
  "id": "string",
  "roleTypeId": "string",
  "subType": "string",
  "title": {
    "translations": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "value": "string"
  },
  "unitId": "string",
  "userIds": [
    "string"
  ]
}

"string"