Skip to main content
GET
/
v1
/
{tenantId}
/
updates
/
types
Get update types
curl --request GET \
  --url https://api.debbiecollect.com/v1/{tenantId}/updates/types \
  --header 'Authorization: Bearer <token>'
[
  {
    "updateTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "procedure": [
      "<any>"
    ],
    "procedureEnabled": true,
    "referenceType": "CASE",
    "selectable": true,
    "public": true,
    "knowledgeBaseUrls": "<any>",
    "priority": 123,
    "label": "<string>",
    "description": "<string>",
    "pausing": true,
    "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "groupLabel": "<string>",
    "important": true,
    "importantTheme": "<string>",
    "responsiblePermissionLevel": "client",
    "hiddenPermissionLevel": "client",
    "pauseWithUpdateOnCaseExit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "continueOnCaseExit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "introductionHeroFile": {
      "fileName": "<string>",
      "contentType": "<string>",
      "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "introductionHTML": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

​
tenantId
string<uuid>
required

Id of the tenant the update is related to

Response

Successful operation

​
updateTypeId
string<uuid>

The id of the type. An overview of type id's can be found under settings in Debbie Caseworker.

​
createdAt
string<date-time>

Time of update type creation

​
procedure
any[]

The procedure of the update type.

​
procedureEnabled
boolean

Whether the update type procedure is enabled or not.

​
referenceType
enum<string>

The type of reference.

Available options:
CASE
​
selectable
boolean

Whether the update type is selectable or not from a case.

​
public
boolean

Whether the update type is a system standard or not.

​
knowledgeBaseUrls
any
​
priority
integer

The priority of the update type. 0 is the highest priority.

​
label
string

The label of the update type.

​
description
string

The description of the update type.

​
pausing
boolean

Whether the update type is pausing the case or not.

​
groupId
string<uuid>

Id of the update type group

​
groupLabel
string

The label of the update type group.

​
important
boolean

Whether the update type is important or not.

​
importantTheme
string

The theme of the important update type.

​
responsiblePermissionLevel
enum<string>

The permission level of the responsible user.

Available options:
client,
caseworker,
admin
​
hiddenPermissionLevel
enum<string>

The permission level the update type should be hidden for.

Available options:
client,
caseworker,
admin
​
pauseWithUpdateOnCaseExit
string<uuid>

An update that will pause the case when the case is ended.

​
continueOnCaseExit
string<uuid>

An update that will continue automatically when the case is ended.

​
introductionHeroFile
object
​
introductionHTML
string

The introduction HTML of the update type.