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}

Autorisierung

AuthorizationBearer-Token (JWT) · headererforderlich

BpmLicenseAPI-Schlüssel · headererforderlich

Pfadparameter

warehouseIdstringerforderlich

ID of warehouse

roleIdstringerforderlich

ID of the organizational role

Query-Parameter

fromAccumulatedboolean

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

Antworten

200

Organizational role

baseRoleIdstring

descriptionLocalizedFormattedText[]erforderlich

Eigenschaften anzeigen

Array von LocalizedFormattedText

formatTextFormaterforderlich

Erlaubt:BBCodeHTMLPlainText

textLocalizedStringerforderlich

Eigenschaften anzeigen

translationsStringTranslation[]erforderlich

valuestring

externalbooleanerforderlich

idstring

roleTypeIdstringerforderlich

subTypestringerforderlich

titleLocalizedStringerforderlich

Eigenschaften anzeigen

translationsStringTranslation[]erforderlich

Eigenschaften anzeigen

Array von StringTranslation

languagestringerforderlich

valuestring

unitIdstring

userIdsstring[]erforderlich

404

Organizational role not found

string

Ausprobieren

Server

Basis-URLEigene Basis-URLÜberschreibt den ausgewählten Server, wenn gesetzt.

Autorisierung

Bearer-Token (JWT)API-SchlüsselAuf diesem Gerät merkenMeine Werte in die Beispiele übernehmen

Parameter

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

Anfrage

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

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

Antwort

{
  "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"