GET /api-web/api/dms/permissions

As of Version

product version 2022 Spring | component version

Request Method GET

Response Format JSON

Description

Retrieves the object types that are available for all available actions on DMS objects for the currently logged-in user. Available actions are CREATE, WRITE, READ and DELETE (see role set documentation).

With this information, client applications can present a selection list of object types that are relevant for the logged-in user. Thus, users will see only those object types that are available to them. Those selection lists may differ for the different actions CREATE, READ, WRITE, or DELETE.

The response body is a JSON structure listing all object types for the corresponding action as shown in the example below.

The composition of the object type IDs including the usage of prefixes is described in the schema documentation article.

Response HTTP status codes:

HTTP Status Code	Meaning
200	OK
401	Unauthorized

Internally, the endpoint calls the search service's endpoint GET /search/api/search/dsl/check.

Request Example

https://<host>/api-web/api/dms/permissions

no request body

Response Example

200 OK

{
  "CREATE": {
    "folderTypeIds": [
      "appPersonalfile:pfpersonalfile"
    ],
    "secondaryObjectTypeIds": [
      "system:secondary",
      "emailsot",
      "appClientsystem:leadingType",
      "tenKolibri:qadocdossiersot"
    ],
    "objectTypeIds": [
      "email",
      "appClient:minidoc",
      "appPersonalfile:pfdocument",
      "tenKolibri:preobject"
    ]
  },
  "READ": {
    "folderTypeIds": [
      "appPersonalfile:pfpersonalfile",
      "appPhotoarchive:paphotoalbum"
    ],
    "secondaryObjectTypeIds": [
      "system:secondary",
      "system:rmDestructionRetention",
      "emailsot",
      "emailextension",
      "appClientsystem:leadingType",
      "tenKolibri:qadocdossiersot",
      "tenKolibri:qadoccatalogssot",
      "tenKolibri:qadoccontentrequiredsot",
      "tenKolibri:qadocscriptssot"
    ],
    "objectTypeIds": [
      "doctableofnotices",
      "email",
      "preemail",
      "appClient:minidoc",
      "appPersonalfile:pfidphoto",
      "appPersonalfile:pfdocument",
      "appPersonalfile:pfsicknote",
      "appPersonalfile:pfvacancy",
      "appPersonalfile:pfdocumentdlm",
      "tenKolibri:qadoccatalogs",
      "tenKolibri:qadocscripts",
      "tenKolibri:qadocscriptsmulti",
      "tenKolibri:preobject"
    ]
  },
  "WRITE": {
    "folderTypeIds": [
      "appPersonalfile:pfpersonalfile"
    ],
    "secondaryObjectTypeIds": [
      "system:secondary",
      "emailsot",
      "appClientsystem:leadingType",
      "tenKolibri:qadocdossiersot"
    ],
    "objectTypeIds": [
      "doctableofnotices",
      "email",
      "appClient:minidoc",
      "appPersonalfile:pfdocument",
      "tenKolibri:preobject"
    ]
  },
  "DELETE": {
    "folderTypeIds": [
      "tenKolibri:qadossier"
    ],
    "secondaryObjectTypeIds": [
      "tenKolibri:qadocscriptssot"
    ],
    "objectTypeIds": [
      "doctableofnotices",
      "tenKolibri:preobject"
    ]
  }
}