Document Types

Manage VARIO Cloud DMS document types via the REST API, including storage duration, revision rules, access levels, activation, and CRUD operations.

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

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstring · min: 1Required

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

404

Resource with given ID was not found

application/json

get/dms/resources/types/{id}

GET /dms/resources/types/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "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

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstring · min: 1Required

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

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstring · min: 1Required

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

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/dms/resources/types/{id}

PUT /dms/resources/types/{id} HTTP/1.1
Host: api.example.com
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-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "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

contextstringOptional

message context

messageValuestringOptional

message

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}

DELETE /dms/resources/types/{id} HTTP/1.1
Host: api.example.com
Accept: */*

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

Create new Resource

post

Body

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstring · min: 1Required

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

Dokumentenart

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringRead-onlyOptional

unique key of type

labelstring · min: 1Required

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

422

Resource was not valid to process

application/json

post/dms/resources/types

POST /dms/resources/types HTTP/1.1
Host: api.example.com
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-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "key": "text",
  "label": "text",
  "systemPresetting": false,
  "duration": 1,
  "revisionStorageRule": 1,
  "accessLevelRead": 1,
  "accessLevelWrite": 1,
  "accessLevelDelete": 1,
  "active": true
}