Document Types

Resource managing the document types in our DMS(Shelf)

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/dms/resources/types/{id}

HTTPcURLJavaScriptPython

GET /api/dms/resources/types/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.069Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.069Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "systemPresetting": false,
  "duration": 1,
  "revisionStorageRule": 1,
  "accessLevelRead": 1,
  "accessLevelWrite": 1,
  "accessLevelDelete": 1,
  "active": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstringRequired

label of type

systemPresettingbooleanRead-onlyOptional

system presetting

Default: false

durationinteger · int32Optional

duration of storage (years)

revisionStorageRuleinteger · int32Optional

storage rule for revisions

accessLevelReadinteger · int32Optional

access level or reading

accessLevelWriteinteger · int32Optional

access level for writing

accessLevelDeleteinteger · int32Optional

access level for deleting

activebooleanOptional

Ist die Dokumentenart aktiv

Default: true

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/dms/resources/types/{id}

HTTPcURLJavaScriptPython

PUT /api/dms/resources/types/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "duration": 1,
  "revisionStorageRule": 1,
  "accessLevelRead": 1,
  "accessLevelWrite": 1,
  "accessLevelDelete": 1,
  "active": true
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.069Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.069Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "systemPresetting": false,
  "duration": 1,
  "revisionStorageRule": 1,
  "accessLevelRead": 1,
  "accessLevelWrite": 1,
  "accessLevelDelete": 1,
  "active": true
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/dms/resources/types/{id}

HTTPcURLJavaScriptPython

DELETE /api/dms/resources/types/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Create new Resource

post

Body

application/json

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstringRequired

label of type

systemPresettingbooleanRead-onlyOptional

system presetting

Default: false

durationinteger · int32Optional

duration of storage (years)

revisionStorageRuleinteger · int32Optional

storage rule for revisions

accessLevelReadinteger · int32Optional

access level or reading

accessLevelWriteinteger · int32Optional

access level for writing

accessLevelDeleteinteger · int32Optional

access level for deleting

activebooleanOptional

Ist die Dokumentenart aktiv

Default: true

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/dms/resources/types

HTTPcURLJavaScriptPython

POST /api/dms/resources/types HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "duration": 1,
  "revisionStorageRule": 1,
  "accessLevelRead": 1,
  "accessLevelWrite": 1,
  "accessLevelDelete": 1,
  "active": true
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.069Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.069Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "systemPresetting": false,
  "duration": 1,
  "revisionStorageRule": 1,
  "accessLevelRead": 1,
  "accessLevelWrite": 1,
  "accessLevelDelete": 1,
  "active": true
}