DMS API for configuring d.3 repositories

Using the API functions

Below, you will learn how to use the programming interface of the DMS app to configure d.3 repositories for your own developments.

This API is a RESTful HTTP API with JSON representations. In particular, we use JSON Hypertext Application Language to create links between various resources in JSON format.

You can find information about getting started with the configuration of repositories at the route /dms. You can use the link relation repoconfig to access the list of configurable repositories. From there, you can find additional link relations for the various configuration options.

Determining the link for the repository configuration

Call the link for the repository configuration using an HTTP GET request.

Request

GET /dms
Accept: application/hal+json

Among other things, the response to the HTTP GET request contains the link relation for the configuration.

Response

{
  "_links": {
    "repoconfig": {
      "href": "<URI to repository list>"
    },
    ...
  }
}

Basic information about general status codes

While you are using the functions of this API, the app may output the following general status codes. More specific status codes are explained in the corresponding sections.

Status code

401: The user has not been authenticated.
403: The origin header is missing or the user does not have administrator rights. Only tenant administrators are authorized to apply configurations to the repository.
406: The requested resource is not available in the desired form. Please change the accept header.
500: Server error.

Basic information on supported languages

You can define specific property values in multiple languages according to ISO 639-1 and RFC-3066 within this API. The following languages are supported:

Language	Language ID (ISO 639-1 and RFC-3066)	Characteristic
German	de
English	en
Croatian	hr
Czech	cs
Danish	da
Dutch	nl
French	fr
Italian	it
Polish	pl
Serbian	sr
Spanish	es
Slovak	sk
Chinese	zh-CN
Language independent default value	x-original	Only for datasets

The language ID de-DE is also supported for backwards compatibility. When using writing HTTP requests (POST, PUT), you can use the language ID de-DE synonymously to the language ID de (for categories and properties) or x-original (for datasets). We recommend using the IDs de or x-original.

Basic information about sequential and parallel requests to this API

Please use only sequential requests for this API. Parallel requests to this API can lead to errors and are therefore not supported.

Configuring resources

The API for configuring d.3 repositories contains the following resources. The sections below describe the resources and their configuration options in detail.

Repositories

Represents a list of repository resources.

Displaying all the administrable repositories

Use an HTTP GET request to display all the administrable repositories.

Request

GET <URI to repositories resource>
Accept: application/hal+json

In the response, you receive an array of repositories within the object _embedded.

Response

{
  "_links": { ... },
  "_embedded": {
    "repositories": [ ... ]
  }
}

Status code

200: The repositories were determined successfully.
404: The administrable repositories could not be determined.

Structure of a “repositories” resource

The repositories resource always contains the following elements.

Embedded (embedded resources)

Relation	Type	Resource
repositories	repository	Repository

Repository

Represents a d.3 repository. To configure a repository, you can follow its corresponding link relations in the repository resources. For the configuration, you require administration authorizations in the respective repositories.

Below you can learn how to configure a d.3 repository.

Displaying an administrable repository

Use an HTTP GET request to display an administrable repository.

Request

GET <URI to repository resource>
Accept: application/hal+json

After opening the URI, you receive the link relations that reference the specific functions of the repository in the response to the HTTP GET request. You can now use these functions to configure the repository.

Response

{
  "id": "723199c4-4f0c-5993-8b04-d5f72cd37b3d",
  "name": "repository name",
  "_links": {
    "categories": {
      "href": "<URI to category list>"
    },
    "properties": {
      "href": "<URI to property list>"
    },
    "datasets": {
      "href": "<URI to dataset list>"
    },
    "permissions": {
      "href": "<URI to permission list>"
    },
    "structures": {
      "href": "<URI to struturerule list>"
    },
    "events": {
      "href": "<URI to event list>"
    },
    "packages": {
      "href": "<URI to packages resouce>"
    }
  }
}

Status code

200: The repository was determined successfully.
404: The repository with the specified ID could not be determined.

Structure of a “repository” resource

The repository resource always contains the following elements.

Property	Type	Meaning
id	string	The unique ID of the repository.
name	string	The display name of the repository.

Links

Relation	Operations	Media type	Resource
self	GET	application/hal+json	Repository
categories	GET, POST	application/hal+json	Categories
properties	GET, POST	application/hal+json	Properties
datasets	GET, POST	application/hal+json	Datasets
permissions	GET, POST	application/hal+json	Permissions
structures	GET, POST	application/hal+json	Structures
events	GET	application/hal+json	Events
packages	GET	application/hal+json	Packages

Relation	Type	Resource
categories	category	Category

Property	Type	Meaning	Required
id	string	The unique ID of the category.	yes
name	dictionary<string,string>	The display name of the category. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language. See Basic information on supported languages.	yes
type	string	The type of the category. Dossier type: DOSSIER_TYPE Document type: DOCUMENT_TYPE	yes
readOnly	boolean	A read-only property indicating whether a category has been predefined by the system and cannot be changed.	read-only
retention	retention	The settings for retention of documents of this type.	no
propertyRefs	propertyRef	References to properties assigned to a category. Consists of an array of reference objects. By specifying the propertyId, the respective property is assigned to the category.	yes
titleRefs	titleRef	The title of a document of this category. It is composed of an array of objects.	no
protection	protection	The setting specifies if an extended protection is used for items of this category.	no

Property	Type	Meaning	Required
propertyId	string	The unique ID of a property.	yes
required	boolean	Labels the property as mandatory within the category. Default value: false	no
showInFacets	boolean	This property is offered as a facet when searching for this category. Default value: false	no
showInSearch	boolean	This property is offered when searching for this category. Default value: false	no
showInImport	boolean	This property is offered for storage of this category. Default value: false	no
showInResult	boolean	This property is shown in the result list after the search for this category. Default value: false	no

Property	Type	Meaning	Required
propertyId	string	The unique ID of a property.	yes
delimiter	string	Separator that is inserted before this property. Default value: Blank	no

Property	Type	Meaning	Required
period	number	Retention period for documents of this type. Default value: 0 (0 means unlimited)	no
unit	string	The unit in which the retention period is specified. Years: YEARS Months: MONTHS Default value: YEARS	no
basedOn	string	The start time used to calculate the end of retention period for documents. The end of the retention period is calculated starting from the modification date: LAST_EDITED The end of retention period is calculated based on a date from a property of the category: <propertyId> Default value: LAST_EDITED	no

Property	Type	Meaning	Required
preventDeletion	boolean	Prevents deletion of items in the status Release and Archive. The property overrules all Delete rights. If you specified a retention period for items of this category, the items are still deleted after the period expires. Default value: false	no
preventDeletionChangeReason	string	Reason for changing the property preventDeletion.	no, only if you change the value preventDeletion from true to false.

Relation	Operations	Media type	Resource
self	GET, PUT, DELETE	application/hal+json	Category
properties	GET, POST	application/hal+json	Properties

Relation	Type	Resource
properties	properties	Properties

Properties

Represents a list of property resources.

Retrieving a list of all the properties

Use an HTTP GET request to retrieve a list of all the properties.

Request

GET <URI to properties resource>
Accept: application/hal+json

In the response, you receive an array of properties in the section _embedded.

Response

{
  "_links": { ... },
  "_embedded": {
    "properties": [ ... ]
   }
}

Status code

200: The properties were determined successfully.

Structure of a “properties” resource

The properties resource always contains the following elements.

Embedded (embedded resources)

Relation	Type	Resource
properties	property	Property

Creating a property

Use the POST method to create a property.

Optionally, you can link a property with a dataset to enable the DMS user to choose from a predefined set of values. In case you want to create a property with a dataset not already contained in the repository, you need to create it before the property. This chapter provides further assistance in doing so: Creating a dataset.

While executing the POST method as the request body, transfer a property resource.

Request

POST <URI to properties resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "name": {
    "en": "Supplier"
  },
  "dataType": "STRING",
  "isSystemProperty": false,
  "isMultiValue": false,
  "validationRegEx": "(?<=\s)\d{13}(?=\s)",
  "dataSetId": "1"
}

You cannot specify an ID when you create a property. This is generated automatically by the system. After a property has been created, you can find the URI of the new property in the location header.

Response

location: <URI of the created property resource>

Status code

201: The property was created successfully.
400: Invalid data was transferred or the property already exists in the repository.

Property

Represents a property within a d.3 repository. A property is a feature providing a compact description of a document or a dossier. You can assign the available properties when you create or change a category.

Below, you can learn how to configure a property.

Viewing the configuration of a property

If you want to display the configuration of an existing property, you can apply the GET method to the URI of the property resource.

Request

GET <URI to property resource>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified property:

Response

{
  "id": "1",
  "name": {
    "en": "Supplier"
  },
  "dataType": "STRING",
  "isSystemProperty": false,
  "readOnly": false,
  "isMultiValue": false,
  "validationRegEx": "",
  "dataSetId": "1",
  "_links": { ... }
}

Status code

200: The property was determined successfully.
404: The property with the specified ID could not be determined.

Structure of a property resource

The property resource always contains the following elements.

Property	Type	Meaning	Required
id	string	The unique ID of the property.	yes
name	dictionary<string,string>	The display name of the property. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language. See Basic information on supported languages.	yes
dataType	string	The data type of the property. Text: STRING Currency: CURRENCY Number: NUMERIC Date: DATE Date and time: DATETIME	yes
isSystemProperty	boolean	Indicates whether the property has been created by the system.	read-only
readOnly	boolean	A read-only property indicating whether a property has been predefined by the system and cannot be changed.	read-only
isMultiValue	boolean	Indicates whether the property has one of multiple values. Default value: false	yes
validationRegEx	string	Regular expression for validation of the input (POSIX basic regular expression syntax). Valid data types: STRING	no
dataSetId	string	The ID of a linked dataset. Valid data types: STRING, NUMERIC, CURRENCY, DATE	no
minValue	number	The smallest value this property can take. Valid data types: NUMERIC, CURRENCY	no
maxValue	number	The biggest value this property can take. Valid data types: NUMERIC, CURRENCY	no

Links

Relation	Operations	Media type	Resource
self	GET, PUT, DELETE	application/hal+json	Property
dataset	GET, PUT, DELETE	application/hal+json	Dataset

Embedded (embedded resources)

Relation	Type	Resource
dataset	dataset	Dataset

Using predefined properties

Some properties already exist in the repository without having been created by you. These properties cannot be assigned to any category since they are automatically a part of each category. However, you can use these properties to assign permissions and to assign the title of a category. You cannot modify this type of property. This means you cannot change or delete its values. All these properties are marked with the property isSystemProperty=true.

ID	Name	Meaning
DOCUMENT_ID	Document ID	The unique ID of the document.
CATEGORY	Category name	The name of the category.
FILE_EXTENSION	File type	The file type of the document.
FILE_NAME	File name	The file name of the document.
STATUS	Status	The current status of the document.
EDITOR	Editor	The current editor of the document.
OWNER	Owner	The owner of the document.

Changing a property

If you want to make changes to an existing property, you can apply the PUT method to the URI of the property resource.

Request

PUT <URI to property resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "name": {
    "en": "Supplier"
  },
  "dataType": "STRING",
  "isSystemProperty": "false",
  "isMultiValue": false,
  "validationRegEx": "",
  "dataSetId": "2"
}

Response

location: <URI of the changed property resource>

Status code

200: The property was changed successfully.
400: Invalid data was transferred.
404: The property with the specified ID could not be determined.

Deleting a property

You can delete a property that is no longer required from the repository by applying the DELETE method to the URI of the property resource. A property can only be deleted if it is no longer assigned to any category and if it has not been predefined by the system (readOnly=true).

Request

DELETE <URI to property resource>
Origin: <Base-URI of the tenant>

Status code

204: The property was deleted successfully.
400: The property is still assigned to at least one category or has been predefined by the system.
404: The property with the specified ID could not be determined.

Datasets

Represents a list of dataset resources.

Retrieving a list of all the datasets

Use an HTTP GET request to retrieve a list of all the datasets.

Request

GET <URI to datasets resource>
Accept: application/hal+json

In the response, you receive an array of datasets within the object _embedded.

Response

{
  "_links": { ... },
  "_embedded": {
    "datasets": [ ... ]
   }
}

Status code

200: The datasets were determined successfully.

Structure of a “datasets” resource

The datasets resource always contains the following elements.

Embedded (embedded resources)

Relation	Type	Resource
datasets	dataset	Dataset

Creating a dataset

You can use the POST method to create a dataset.

While executing the POST method as the request body, transfer a dataset resource.

Request

POST <URI to datasets resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "name": "Supplier names",
  "dataType": "STRING",
  "values": [
    {
      "x-original": "SUPPLIER_1",
      "en": "Supplier 1"
    },
    {
      "x-original": "SUPPLIER_2",
      "en": "Supplier 2"
    }
  ]
}

You cannot specify an ID when you create a dataset. This is generated automatically by the system. After a dataset has been successfully created, you can find the URI of the new data in the location header.

Response

location: <URI of the created dataset resource>

Status code

201: The dataset was created successfully.
400: Invalid data was transferred or the dataset already exists in the repository.

Dataset

Represents a dataset within a d.3 repository. A dataset is an inventory of values a user can choose as a property for a category. This applies both for the search and for the storage of new documents.

Below, you can learn how to configure a dataset.

Viewing the configuration of a dataset

If you want to display the configuration of an existing dataset, you can apply the GET method to the URI of the dataset resource.

Request

GET <URI to dataset resource>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified dataset:

Response

{
  "id": "1",
  "name": "Supplier names",
  "dataType": "STRING",
  "readOnly": false,
  "values": [
      {
        "x-original": "SUPPLIER_1",
        "en": "Supplier 1"
      },
      {
        "x-original": "SUPPLIER_2",
        "en": "Supplier 2"
      }
    ],
  "_links": { ... }
}

Status code

200: The dataset was determined successfully.
404: The dataset with the specified ID could not be determined.

Structure of a “dataset” resource

The dataset resource always contains the following elements.

Property	Type	Meaning	Required
id	string	The unique ID of the dataset.	yes
name	string	The internal name of the dataset.	yes
dataType	string	The data type of the dataset. Text: STRING Currency: CURRENCY Number: NUMERIC Date: DATE Dynamic: URI	yes
readOnly	boolean	A read-only property indicating whether a dataset has been predefined by the system and cannot be changed.	read-only
values	value	The values available for selection by the DMS user. Is specified as an array of values that depend on the data type of the dataset.	no

Value

A value object describes a value that is available for the DMS user to select in this dataset. A value object is structured in different ways depending on the data type of the dataset:

Data type	Type	Meaning	Example
STRING	dictionary<string,string>	Is specified as an array of dictionaries. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language. A language-independent default value must exist in each Value of the array (x-original). This value is used within webhooks, for example, and is a default value if no matching translation exists in another language. Values in other languages are optional. See Basic information on supported languages.	"values": { "x-original": "SUPPLIER 1"}
CURRENCY, NUMERIC	number	Is specified as an array of numbers (a period corresponds to the thousand separator).	"values": 10.3, -4.99
DATE	string	Is specified as an array of strings (ISO 8601).	"values": "2004-07-11"
URI	string	Is specified as an array of strings. Specification of a webhook URI for dynamically determining values. Must be a valid HTTP(S) URI. Relative URIs begin with a slash. Currently, only one URI can be specified. In this case, you can configure an additional "apiKey" property. This property can be used to transfer an authentication key to the webhook. You can also configure an additional property "timeout". This property specifies the time in milliseconds after which a timeout is assumed (default value: 1000).	"values": `"https://webhook.d-velop.cloud/"`, "apiKey": "securid-key", "timeout": 1000

Links

Relation	Operations	Media type	Resource
self	GET, PUT, DELETE	application/hal+json	Dataset

Using predefined datasets

Some datasets already exist in the repository without having been created by you. These datasets can contain dynamic values and are composed of the data inventory in the repository. You can assign these datasets to a property using the following IDs. You cannot modify this type of dataset. This means you cannot add any values to it or change its name and data type. All these datasets are marked with the property readOnly=true.

ID	Data type	Meaning
USERS	STRING	Contains all users in the repository.
EXISTING_VALUES	STRING	Contains all values that have been entered for the linked property.

Changing a dataset

If you want to make changes to an existing dataset, you can apply the PUT method to the URI of the dataset resource.

Request

PUT <URI to dataset resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "name": "Supplier names",
  "dataType": "STRING",
  "values": [
    {
      "x-original": "SUPPLIER_1",
      "en": "Supplier 1"
    },
    {
      "x-original": "SUPPLIER_2",
      "en": "Supplier 2"
    },
    {
      "x-original": "SUPPLIER_3",
      "en": "Supplier 3"
    }
  ]
}

Response

location: <URI of the changed dataset resource>

Status code

200: The dataset was changed successfully.
400: Invalid data was transferred.
404: The dataset with the specified ID could not be determined.

Deleting a dataset

You can delete a dataset that is no longer required from the repository by applying the DELETE method to the URI of the dataset resource. A dataset can only be deleted if it is no longer assigned to any property and if it has not been predefined by the system (readOnly=true).

Request

DELETE <URI to dataset resource>
Origin: <Base-URI of the tenant>

Status code

204: The dataset was deleted successfully.
400: The dataset is still assigned to at least one property or has been predefined by the system.
404: The dataset with the specified ID could not be determined.

Permissions

Represents a list of permission resources.

Retrieving a list of all the permissions

Use an HTTP GET request to retrieve a list of all the permissions.

Request

GET <URI to permissions resource>
Accept: application/hal+json

In the response, you receive an array of permissions within the object _embedded.

Response

{
  "_links": { ... },
  "_embedded": {
    "permissions": [ ... ]
   }
}

Status code

200: The permissions were determined successfully.

Structure of a “permissions” resource

The permissions resource always contains the following elements.

Links

Relation	Operations	Media type	Resource
self	GET	application/hal+json	Permissions
assignments	GET, PATCH	application/hal+json	Assignments
groups	GET	application/hal+json	SCRIM resource

Embedded (embedded resources)

Relation	Type	Resource
permissions	permission	Permission

Creating a permission

Creating a permission using the POST method.

While executing the POST method as the request body, transfer a permission resource.

Request

POST <URI to permissions resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "name": "All bills",
  "restrictions": [
    {
      "key": "CATEGORY",
      "value": "BILL"
    },
    {
      "key": "9",
      "value": "|-1000"
    }
  ],
  "assignments": [
    {
      "subject": "89e6cbd9-af7f-46c8-9c86-2c12602476fe",
      "type": "GROUP",
      "read": "INHERITED",
      "write": "DENIED",
      "delete": "DENIED"
    }
  ]
}

You cannot specify an ID when you create a permission. This is generated automatically by the system. After the permission has been successfully created, you can find the URI of the new permission in the location header.

Response

location: <URI of the created permission resource>

Status code

201: The permission was created successfully.
400: Invalid data was transferred or a permission with the name already exists.

Assignments

The assignments resource provides a view of your system permissions from a different perspective. It focuses on the groups and applications. The resource shows which permissions with which rights have been assigned to each group or application.

Viewing all mappings of permissions to the groups and applications

If you want to display all the mappings of existing permissions to groups and applications, you can apply the GET method to the URI of the assignments resource of the permissions resource.

Request

GET <URI to permissions assignments resource>
Accept: application/hal+json

In the response to the HTTP GET request, you then receive the requested information:

Response

{
  "subjects": [
    {
      "id": "1f99afff-9335-4525-8d76-5fd882acaa00",
      "type": "GROUP"
      "assignments": [
        {
          "permissionId": "d7bfa38f-e44d-44dc-be87-b1ae488e7ba1",
          "read": "ALLOWED",
          "write": "INHERITED",
          "delete": "INHERITED"
        }
      ]
    }
  ],
  "_links": { ... }
}

Status code

200: The mappings were determined successfully.

Structure of an "assignments" resource

The permission resource always contains the following elements.

Property	Type	Meaning	Required
id	string	The unique ID of the group or application.	yes
type	string	The type of the object that is being assigned. Default value: GROUP	no
assignments	assignment	The groups and applications receiving permissions.	no

Notes on the "type" property

The property can receive one of the following values:

Type	Meaning
GROUP	The right is assigned to a group.
APP	The right is assigned to an application.

Assignment

An assignment object describes a group or application that contains permissions and their corresponding rights.

Property	Type	Meaning	Required
permissionId	string	The unique ID of the permission.	yes
read	string	Authorizes the group members or applications to read objects. Default value: INHERITED	no
write	string	Authorizes the group members or applications to edit or create objects. Default value: INHERITED	no
delete	string	Authorizes the group members or applications to delete objects. Default value: INHERITED	no

Notes on the properties "read", "write" and "delete"

Each of the three properties can take one of these values:

Right	Meaning
ALLOWED	Right is explicitly granted.
INHERITED	Right is not granted. If several permissions for the group or application pertain to an object, the others will apply. Otherwise as DENIED
DENIED	Right is explicitly denied. If several permissions for the group or application pertain to an object, DENIED will always apply.

If the property read contains the value DENIED, the properties write and delete also need to contain the value DENIED. If the properties write or delete contain the value ALLOWED, the property read also needs to contain the value ALLOWED.

Links

Relation	Operations	Media type	Resource
self	GET, PATCH	application/hal+json	Assignments

Mapping of permissions to groups and applications

If you want to quickly map or remove a large number of existing permissions to existing groups and applications, you can apply the PATCH method to the URI of the assignments resource of the permissions resource.

Request

PATCH <URI to permissions assignments resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "subjects": [
    {
      "id": "1f99afff-9335-4525-8d76-5fd882acaa00",
      "type": "GROUP",
      "assignments": [
        {
          "permissionId": "d7bfa38f-e44d-44dc-be87-b1ae488e7ba1",
          "read": "ALLOWED",
          "write": "INHERITED",
          "delete": "INHERITED"
        },
        {
          "permissionId": "56269a85-8377-4197-bae2-4855781b5d99",
          "read": "ALLOWED",
          "write": "INHERITED",
          "delete": "DENIED"
        }
      ]
    }
  ],
  "_links": { ... }
}

Response

Status code

200: The mappings was successfully updated.
400: Invalid data was transferred.

Permission

Represents a permission within a d.3 repository. Within a d.3 repository, you can assign different permissions for the categories you have created. You can use this to limit the visibility and access options of different user groups and applications. The configuration of permissions is always done based on a repository.

Below, you can learn how to configure a permission.

Viewing the configuration of a permission

If you want to display the configuration of an existing permission, you can apply the GET method to the URI of the permission resource.

Request

GET <URI to permission resource>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified permission:

Response

{
  "id": "1",
  "name": "All bills",
  "restrictions": [
    {
      "key": "CATEGORY",
      "value": "BILL"
    },
    {
      "key": "9",
      "value": "|-1000"
    },
    ...
  ],
  "assignments": [
    {
      "subject": "89e6cbd9-af7f-46c8-9c86-2c12602476fe",
      "type": "GROUP",
      "read": "INHERITED",
      "write": "DENIED",
      "delete": "DENIED"
    },
    ...
  ],
  "_links": { ... }
}

Status code

200: The permission was determined successfully.
404: No permission with the entered ID could be determined.

Structure of a “permission” resource

The permission resource always contains the following elements.

Property	Type	Meaning	Required
id	string	The unique ID of the permission.	yes
name	string	Name, only relevant for differentiation by the administrator.	yes
restrictions	restriction	The filters defining to which documents and dossiers this permission applies. There must be at least one object with the key category.	yes
assignments	permissionAssignment	The groups and applications receiving permissions.	no

Restriction

The restriction object describes a filter that defines the documents and dossiers to which this permission applies.

Property	Type	Meaning	Required
key	string	Either CATEGORY to filter for a category (may occur only once), or the ID of an object property.	yes
value	string	For a category the ID of the category, in all other cases a filter text. Operators: Range: \|- Placeholder for an unknown number of characters:* Placeholder for exactly one unknown character:? Placeholder for the ID of the logged on user: @CURRENT_USER Placeholder for the ID of a group or application in which the logged on user is a member: @CURRENT_USER_IN_GROUP Dynamically via a filter set with @Filter(<Filter-ID>)	yes

PermissionAssignment

A PermissionAssignment object describes a group or application that contains permissions and their corresponding rights.

Property	Type	Meaning	Required
subject	string	The ID of an application or group from the identity provider app	yes
type	string	The type of the object that is being assigned. Default value: GROUP	no
read	string	Authorizes the group members or applications to read objects. Default value: INHERITED	no
write	string	Authorizes the group members or applications to edit or create objects. Default value: INHERITED	no
delete	string	Authorizes the group members or applications to delete objects. Default value: INHERITED	no

Notes on the "type" property

The property can receive one of the following values:

Type	Meaning
GROUP	The right is assigned to a group.
APP	The right is assigned to an application.

Notes on the properties "read", "write" and "delete"

Each of the three properties can take one of these values:

Right	Meaning
ALLOWED	Right is explicitly granted.
INHERITED	Right is not granted. If several permissions for the group or application pertain to an object, the others will apply. Otherwise as DENIED
DENIED	Right is explicitly denied. If several permissions for the group or application pertain to an object, DENIED will always apply.

Links

Relation	Operations	Media type	Resource
self	GET, PUT, DELETE	application/hal+json	Permission

Changing a permission

If you want to make changes to an existing permission, you can apply the PUT method to the URI of the permission resource.

Request

PUT <URI to permission resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "name": "All bills",
  "restrictions": [
    {
      "key": "CATEGORY",
      "value": "BILL"
    },
    {
      "key": "9",
      "value": "|-1000"
    }
  ],
  "assignments": [
    {
      "subject": "89e6cbd9-af7f-46c8-9c86-2c12602476fe",
      "type": "GROUP",
      "read": "INHERITED",
      "write": "DENIED",
      "delete": "DENIED"
    }
  ]
}

Response

location: <URI of the changed permission resource>

Status code

200: The permission was updated successfully.
400: Invalid data was transferred or another permission with the name already exists.

Deleting a permission

You can delete a permission that is no longer required from the repository by applying the DELETE method to the URI of the permission resource.

Request

DELETE <URI to permission resource>
Origin: <Base-URI of the tenant>

Status code

204: The permission was deleted successfully.
404: No permission with the specified ID could be determined.

Restriction Sets

Restriction sets allow you to dynamically grant a user authorization for documents. You can define values for each group within a restriction set. You can define a restriction set via a placeholder for a Permission in the Restriction. The authorization is dynamic in that a list of values is calculated based on the user's group membership. The user receives the configured authorization if the value of the property containing the placeholder is included in this list.

Retrieving a list of all the restriction sets

Use an HTTP GET request to retrieve a list of all restriction sets.

Request

GET <URI to restrictionSets resource>
Accept: application/hal+json

In the response, you receive an array of restriction sets.

Response

{
  "restrictionsSets": [ ... ]   
}

Status code

200: The restriction sets were determined successfully.

Structure of a “restriction sets” resource

The restriction sets resource always contains the following elements:

Relation	Typ	Ressource
restrictionsSets	restrictionSet	Restriction Set

Creating a restriction set

To create a restriction set, you need at least one name. This name must be unique and not empty.

While executing the POST method as the request body, transfer a restriction set resource.

Request

POST <URI to restrictionSets resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
 "caption": "My New Set"
}

You cannot enter an ID when creating a restriction set. This ID is created automatically by the system. After a restriction set has been created, you will find the URI of the new restriction set in the Location header.

Response

location: <URI of the created restrictionSet resource>

Status code

201: The restriction set was created successfully.
400: Invalid data was transmitted, e.g. an empty caption.
409: Another restriction set with the caption already exists.

Restriction Set

Represents a restriction set within a d.3 repository. A restriction set allows you to dynamically grant a user authorization for a document. Authorization is granted by calculating a list of values. This list results from the user's group membership. If a restriction set is assigned to a property within a permission, the user receives the configured authorization if the value is contained in the calculated list.

Below, you learn how to configure a restriction set.

Viewing the configuration of a restriction set

If you want to display the configuration of an existing restriction set, you can apply the GET method to the URI of the restrictionSet resource.

Request

GET <URI to restrictionSet resource>/<id>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified restriction set:

Response

{
  "id": "7e74ff4b-8fb0-4748-a516-22414c940dce",
  "caption": "My New Set"
}

Status code

200: The restriction set was determined successfully.
404: No restriction set with the entered ID could be determined.

Structure of a "restrictionSet" resource

The restrictionSet resource always contains the following elements:

Property	Type	Meaning	Required
id	string	The unique ID of the restriction set.	yes
caption	string	Name, only relevant for differentiation by the administrator.	yes

Changing a restriction set

If you want to make changes to an existing restriction set, you can apply the PUT method to the URI of the restriction set resource.

Request

PUT <URI to restrictionSets resource>/<id>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "caption": "Changed Set"
}

Status code

201: The restriction set was updated successfully.
400: Invalid data was transmitted, e.g. an empty caption.
409: Another restriction set with the caption already exists.

Deleting a restriction set

You can delete a restriction set that is no longer required from the repository by applying the DELETE method to the URI of the restriction set resource.

A restriction set can only be deleted if it is no longer assigned to any permission.

Request

DELETE <URI to restrictionSets resource>/<id>
Origin: <Base-URI of the tenant>

Status code

204: The restriction set was deleted successfully.
404: No restriction set with the specified ID could be determined.
409: The restriction set is assigned to a permission. The Ids of the affected permission can be found in the response.

Response 409

{
   "additionalInfo": {
      "permissions": [
         "bd0f7ca7-7ccf-4b89-aa41-052c1867ec9e",
         "52ad0156-c4f7-4cbf-a25c-eaad85a05cfd",
         ...
      ]
   },
   "message": "Restriction set is still in use."
}

Assign values to Restriction sets

The values of a restriction set are calculated dynamically based on the user's group membership. You can define individual values for each group. You can also define values that apply to all groups.

Retrieving a list of all restriction set assignments

Use an HTTP GET request to retrieve a list of all restriction set assignments.

Request

GET <URI to restrictionSet resource>/assignments/
Accept: application/hal+json

In the response, you will receive an array of restriction set assignments in the assignments section.

Response

{
  "assignments": [
      { "type": "GROUP",    
        "id": "f5b1ce00-7c24-40e7-8ae8-7efa4e44d302"
      }
   ]   
}

Status code

200: The restriction set assignments were determined successfully.

Structure of a "assignments" resource

The assignments resource always contains the following elements:

Relation	Typ	Ressource
assignments	assignment	Assignment

Creating a restriction set assignment

Creating a restriction set assignment using the POST method. While executing the POST method as the request body, transfer a assignment resource.

Request

POST <URI to restrictionSet resource>/assignments/
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "type": "GROUP",
  "id": "df2d4c8c-90de-47c8-a5f6-ba2324966407"
  "values": [
        "Value A",
        "Value B",
        "Value C",
        "Value D"
 ]
}

The type descript the kind of assignment. If an assignment refers to a specific group, enter "GROUP" as type. To specify the group, enter the id field with the group ID of the identity provider app. If you want to specify values for all groups, enter "NO_ASSIGNMENT" as type.

ATTENTION: type with the value "NO_ASSIGNMENT" also contains groups that were created after the configuration.

After a assignment has been created, you will find the URI of the new assignment in the Location header.

Response

location: <URI of the created assignment resource>

Statuscode

201: The assignment was created successfully.
400: Invalid data was transmitted.
409: An assignment with this group already exists.
422: An assignment contains invalid values.

Structure of a restriction set assignment

The assignment resource always contains the following elements:

Property	Type	Meaning	Required
type	string	"GROUP" for a group assignment; "NO_ASSIGNMENT" to assign all groups.	yes
id	string
The ID of a group from the identity provider app. Required if the type has the value "GROUP"	yes
values	string	Array of values. Attention: An empty array allows all values.	ja

Changing a restriction set assignment

If you want to make changes to an existing restriction set assignment, you can apply the PUT method to the URI of the restriction set assignment resource.

Request

PUT <URI to assignment resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "type": "GROUP",
  "id": "df2d4c8c-90de-47c8-a5f6-ba2324966407"
  "values": [
        "Value A",
        "Value B",
        "Value C",
        "Value D"
 ]
}

Response

location: <URI of the changed assignment resource>

Statuscode

200: The assignment was updated successfully.
400: Invalid data was transmitted.
422: The assignment contains invalid values.

Delete a restriction set assignment

You can delete a restriction set assignment that is no longer required from the repository by applying the DELETE method to the URI of the assignments resource.

Request

DELETE <URI to assignment resource>
Origin: <Base-URI of the tenant>

Statuscode

204: The assignment was deleted successfully.
404: No assignment set with the specified ID could be determined.

Defining values for an assignment

You can define values for each assignment. These values serve as a filter for the assigned property of a given permission. If the value of the property is contained in this list of values, the user receives the configured authorization.

ATTENTION: If the list of filter values is empty, the user receives the corresponding authorization.

Load all values of a restriction set assignment

Use an HTTP GET request to retrieve a list of all values of a restriction set assignment.

Request

GET <URI to assignment resource>/values/
Accept: application/hal+json

In the response, you will receive an array of string values.

Response

{
  "values": ["Val1","Val2"]
}

Response

location: <URI of the created assignment resource>

Statuscode

200: The values of a restriction set assignment were determined successfully.

Changing the values of a restriction set assignment

Apply the PUT or PATCH method to the URI of the Values resource if you want to replace or add values of an existing assignment. You will always find the Values resource under the Assignment resource.
PUT replaces the list of values with the trasmitted list.
PATCH appends the transmitted list to the existing values.

Request

PUT/PATCH <URI to assignment-resource/values>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "values": [
    "Value A",
    "Value B",
    "Value C",
    "Value D",
 ]
}

Response

location: <URI of the changed values resource>

Statuscode

200: The values was updated successfully.
400: Invalid data was transmitted.
422: The array contains invalid values.

Structures

Represents a list of structurerule resources.

Retrieving a list of all the structure rules

Use an HTTP GET request to retrieve a list of all the structure rules.

Request

GET <URI to structures resource>
Accept: application/hal+json

You will receive an array of individual structure rules within the object _embedded in the response.

Response

{
  "_links": { ... },
  "_embedded": {
    "structures": [ ... ]
  }
}

Status code

200: The structure rules were determined successfully.

Structure of a “structures” resource

The structures resource always contains the following elements.

Embedded (embedded resources)

Relation	Type	Resource
structures	structurerule	Structurerule

Creating a structure rule

Creating a structure rule using the POST method.

You can create a structure rule with the following function. While executing the POST method as the request body, transfer a structurerule resource.

Request

POST <URI to structures resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "parent": "CUST",
  "child": "BILL",
  "createSiblingDossiers": true,
  "recognition": [
    {
      "propertyId": "",
      "parentId": "1",
      "childId": "2"
    }
  ],
  "inheritance": [
    {
      "propertyId": "3"
    }
  ]
}

You cannot specify an ID when you create a structure rule. This is generated automatically by the system. After the structure rule has been successfully created, you can find the URI of the new structure rule in the location header.

Response

location: <URI of the created structurerule resource>

Status code

201: The structure rule was created successfully.
400: Invalid data was transferred or a structure rule with the specified parent and child already exists.

Structurerule

Represents a structure rule within a d.3 repository. Within a d.3 repository, you can use structure rules to provide a pre-configured dossier structure for your users. The structure rules are used to automatically link elements that your users save in dossiers or with documents. You can choose which properties are used to identify the parent element. You can also define properties that the element automatically applies for the child document. You can use the configuration of structures to define which categories are linked to each other under which conditions.

Below you can learn how to configure a structure rule.

Viewing the configuration of a structure rule

If you want to display the configuration of an existing structure rule, you can apply the GET method to the URI of the structurerule resource.

Request

GET <URI to structurerule resource>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified structure rule:

Response

{
  "id": "1",
  "parent": "CUST",
  "child": "BILL",
  "createSiblingDossiers": true,
  "recognition": [
    {
      "propertyId": "",
      "parentId": "1",
      "childId": "2"
    }
  ],
  "inheritance": [
    {
      "propertyId": "3"
    }
  ],
  "_links": { ... }
}

Status code

200: The structure rule was determined successfully.
404: No structure rule with the entered ID could be determined.

Structure of a “structurerule” resource

The structurerule resource always contains the following elements.

Property	Type	Meaning	Required
id	string	The unique ID of the structure rule.	yes
parent	string	The parent category to which a document or dossier is to be linked.	yes
child	string	The child category whose elements are to be linked under parent. Circular references must not be defined.	yes
createSiblingDossiers	boolean	All child dossiers with the same parent dossier are also created automatically when the selected child dossier is created.	no
recognition	Recognition	A list of identification properties. If these properties are the same in a parent element and a child element, they are linked to each other.	yes
inheritance	Inheritance	A list of properties whose values are transferred from the parent element to the child element. If a property in the child element already has a value for the property, it is not transferred from the parent element.	no

Recognition

A Recognition object describes a property or combination of properties that is used to link the parent to child. It is not necessary for this property to exist in both the parent and child categories. Different properties can be combined with each other. If the value of these properties is identical in both objects, a corresponding structure is created in the system.

Property	Type	Meaning	Required
propertyId	string	The ID of a property. This property must be available in both the parent and child category.	yes if parentId and childId are empty
parentId	string	The ID of a property. This property must be available in the parent category. Must be set if you want to use a property for linking that is only defined in the parent category.	yes if propertyId is empty
childId	string	The ID of a property. This property must be available in the child category. Must be set if you want to use a property for linking that is only defined in the child category.	yes if propertyId is empty

Inheritance

An inheritance object describes a property that is inherited during a link. If a link is made using a recognition property, the values of the properties specified under Inheritance are inherited from the parent object to the child object.

Property	Type	Meaning	Required
propertyId	string	The ID of a property. This property must be available in both the parent and child category. In addition, this property must not have been defined yet under recognition.	yes
type	string	Indicates the type of inheritance. The properties of the parent category are transferred to the newly created elements of the child category: FROM_CHILD_TO_PARENT When automatically creating a dossier of the parent category, the properties of the element of the child category are applied: FROM_PARENT_TO_CHILD	yes

Links

Relation	Operations	Media type	Resource
self	GET, PUT, DELETE	application/hal+json	Structurerule

Changing a structure rule

If you want to make changes to an existing structure rule, you can apply the PUT method to the URI of the structurerule resource.

Request

PUT <URI to structurerule resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "parent": "CUST",
  "child": "BILL",
  "createSiblingDossiers": true,
  "recognition": [
    {
      "propertyId": "",
      "parentId": "1",
      "childId": "2"
    }
  ],
  "inheritance": [
    {
      "propertyId": "2"
    }
  ]
}

Response

location: <URI of the changed structurerule resource>

Status code

201: The structure rule was updated successfully.
400: Invalid data was transferred.

Deleting a structure rule

You can delete a structure rule that is no longer required from the repository by applying the DELETE method to the URI of the structurerule resource.

Request

DELETE <URI to structurerule resource>
Origin: <Base-URI of the tenant>

Status code

204: The structure rule was deleted successfully.
404: No structure rule with the specified ID could be determined.

Events

Represents a list of event resources.

Retrieving a list of all the events

Use an HTTP GET request to retrieve a list of all the events.

Request

GET <URI to events resource>
Accept: application/hal+json

In the response, you receive a list of all the available events in the object _links and the individual events in the object _embedded.

Response

{
  "_links": {
    "presearch": { ... },
    "postsearch": { ... },
  },
  "_embedded": {
    "presearch": { ... },
    "postsearch": { ... },
    ...
  }
}

Status code

200: The events were determined successfully.

Structure of an "events" resource

The events resource always contains the following elements.

Embedded (embedded resources)

Eventname	Typ	Ressource	Description
presearch	event	Event	Before searching
postsearch	event	Event	After searching
validateimport	event	Event	Validate storage dialog
preimport	event	Event	Before creating a document or a dossier
postimport	event	Event	After creating a document or a dossier
prenewversion	event	Event	Before creating a new version
postnewversion	event	Event	After creating a new version
validateupdateproperties	event	Event	Validate properties
preupdateproperties	event	Event	Before updating properties
postupdateproperties	event	Event	After updating properties
predelete	event	Event	Before deleting a document or a dossier
postdelete	event	Event	After deleting a document or a dossier
prelink	event	Event	Before linking items
postlink	event	Event	After linking items
pretransfer	event	Event	Before changing the status
posttransfer	event	Event	After changing the status
pregenerateddocument	event	Event	Before creating a generated document
postgenerateddocument	event	Event	After creating a generated document
prereleasedocument	event	Event	Before releasing a document
postreleasedocument	event	Event	After releasing a document

Event

Represents a d.3 repository event. Events run during specific processes. All the specified webhooks in an event are then activated in the specified order. You find details on the individual events, such as execution times, in the webhook documentation.

Viewing the configuration of an event

If you want to display the configuration of an event, you can apply the GET method to the URI of the event resource.

Request

GET <URI to event resource>/<Eventname>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified event:

Response

{
  "order": [
    "05F3AC34-EF06-43CE-81B6-11CA7E5E4C9E",
    "1D7341B4-547C-4FFD-A309-68B871959CD8",
    "E5FE04F2-6432-469F-9191-8C1DCCEE3752"
  ],
  "_links": { ... },
  "_embedded": {
    "webhooks": [ ... ]
  }
}

Status code

200: The event was determined successfully.
404: The specified event does not exist.

Structure of an "Event" resource

The event resource always contains the following elements.

Property	Type	Meaning
order	string	Contains the IDs of the assigned webhooks. Defines the order in which the webhooks are executed.

Links

Relation	Operations	Media type	Resource
self	GET, PUT, POST	application/hal+json	Event

Embedded (embedded resources)

Relation	Type	Resource
webhooks	webhook	Webhook

Creating a webhook

If you want to set up a webhook for an event, you can use the POST method. While executing the POST method as the request body, transfer a webhook resource.

Request

POST <URI to event resource>/<Eventname>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "uri": "https://my-company.com/webhooks",
  "description": "This is a description of my webhook.",
  "enabled": true,
  "handleResponse": "STATUS_AND_BODY",
  "timeout": 300,
  "apiKey": "key",
  "restrictions": [
    {
      "key": "CATEGORY",
      "value": "BILL"
    }
  ]
}

You cannot specify an ID when you create a webhook. The ID is generated automatically by the system. After a webhook has been created, you can find the URI of the new webhook in the location header.

Response

location: <URI of the created webhook resource>

Status code

201: The webhook was created successfully.
400: Invalid data was transferred.

Changing the calling sequence within an event

If you want to make changes to an event, you can apply the PUT method to the URI of the event resource. However, you can only change the order of the webhooks. To make changes to a webhook, you must use the webhook resource.

Request

PUT <URI to event resource>/<Eventname>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "order": [
    "E5FE04F2-6432-469F-9191-8C1DCCEE3752",
    "05F3AC34-EF06-43CE-81B6-11CA7E5E4C9E",
    "1D7341B4-547C-4FFD-A309-68B871959CD8"
  ]
}

Status code

201: The event was updated successfully.
400: Invalid data was transferred.

Webhook

Represents a user-defined function that is defined for an event within a d.3 repository. With the aid of a webhook, you can use a URI to define a function that can control the standard DMS behavior or other subsequent actions.

Below, you can learn how to configure a webhook.

Viewing the configuration of a webhook

If you want to display the configuration of an existing webhook, you can apply the GET method to the URI of the webhook resource.

Request

GET <URI to webhook resource>
Accept: application/hal+json

In the response to the HTTP GET request, you receive the detailed information about the specified webhook:

Response

{
  "id": "05F3AC34-EF06-43CE-81B6-11CA7E5E4C9E",
  "uri": "https://my-company.com/webhooks",
  "description": "Webhook for the validation of invoices.",
  "enabled": true,
  "handleResponse": "STATUS_AND_BODY",
  "timeout": 300,
  "apiKey": "key",
  "restrictions": [
    {
      "key": "CATEGORY",
      "value": "BILL"
    }
  ]
  "_links": { ... }
}

Status code

200: The webhook was determined successfully.
404: No webhook with the entered ID could be determined.

Structure of a "webhook" resource

The webhook resource always contains the following elements.

Property	Type	Meaning	Required
id	string	The unique ID of the webhook.	yes
uri	string	URI to be activated when the webhook is executed. Must be a valid HTTP(S) URI. Relative URIs begin with a slash.	yes
description	string	A freely selectable description of the webhook. Used only as a summary and description.	yes
enabled	boolean	Indicates whether a webhook is to be executed. Webhooks that are not executed remain stored in the system. Default value: false	no
handleResponse	string	Indicates how the HTTP response returned by the webhook is processed. Response is not processed: NONE Only the status code of the HTTP response is evaluated: STATUS The status code and response body are evaluated: STATUS_AND_BODY	yes
timeout	number	Time in milliseconds after which a timeout is assumed. Default value: 300	no
retry	boolean	Indicates whether a webhook should be executed again for up to three times in case of a timeout or an incorrect answer. Default value: true	no
apiKey	string	Authentication key that can be sent to the webhook.	no
restrictions	restriction	Filters that you can use to define the categories for which this webhook is to be executed. If you do not make an entry, the webhook is executed for all categories.	no

Restriction

The restriction object describes a filter that defines the documents and dossiers for which this webhook is to be executed.

Property	Type	Meaning	Required
key	string	As the key, you can currently specify only CATEGORY to filter for one category or more categories.	yes
value	string	The ID of the category.	yes

Links

Relation	Operations	Media type	Resource
self	GET, PUT, DELETE	application/hal+json	Webhook

Changing a webhook

If you want to make changes to an existing webhook, you can apply the PUT method to the URI of the webhook resource.

Request

PUT <URI to webhook resource>
Content-Type: application/hal+json
Origin: <Base-URI of the tenant>

{
  "uri": "https://my-company.com/webhooks",
  "description": "Webhook for the validation of invoices.",
  "enabled": true,
  "handleResponse": "STATUS_AND_BODY",
  "timeout": 300,
  "apiKey": "key",
  "restrictions": [
    {
      "key": "CATEGORY",
      "value": "BILL"
    }
  ]
}

Response

location: <URI of the changed webhook resource>

Status code

201: The webhook was updated successfully.
400: Invalid data was transferred.

Deleting a webhook

You can delete a webhook that is no longer required from the repository by applying the DELETE method to the URI of the webhook resource.

Request

DELETE <URI to webhook resource>
Origin: <Base-URI of the tenant>

Status code

204: The webhook was deleted successfully.
404: No webhook with the specified ID could be determined.

Packages

You can use packages to enhance your d.3 repository by adding predefined repository configurations. You may have created these configurations yourself, but they can also have been deployed for you. A package can contain metadata (categories, properties, datasets), structures, authorizations, and webhooks.

Installing a package

If you would like to install a package from a package file, you can apply the method POST to the URI in the link relation installation. You get this link relation by requesting the "packages" resource using the "repository" resource.

The package is installed asynchronously. This means that the POST only creates a job to install the package. The response to the HTTP POST request will contain a "Job" resource and a URI to query the current status of the job. If the job was completed successfully, the package was also installed completely and successfully.

Request

POST <URI to installation package resource>
Content-Type: application/octet-stream

<Package file stream>

Response

location: <URI of created job resource>

{
  "id": "05F3AC34-EF06-43CE-81B6-11CA7E5E4C9E",
  "status": "CREATED"
  "_links": { ... }
}

Status code

202: The job to install the package was created successfully.

Job

The Job object describes the status of an asynchronously running process.

Property	Type	Meaning	Required
id	string	The unique ID of the job.	yes
status	string	Status of the job: Job was created: CREATED Job is running: RUNNING Job was performed successfully: COMPLETED Job failed: FAILED	yes

Links

Relation	Operations	Media type	Resource
self	GET	application/hal+json	Job

DMS API for configuring d.3 repositories

Embedded (embedded resources)

Links

Embedded (embedded resources)

PropertyRef

TitleRef

Retention

Protection

Links

Embedded (embedded resources)

Embedded (embedded resources)

Links

Embedded (embedded resources)

Embedded (embedded resources)

Value

Links

Links

Embedded (embedded resources)

Viewing all mappings of permissions to the groups and applications

Structure of an "assignments" resource

Assignment

Links

Restriction

PermissionAssignment

Links

Retrieving a list of all restriction set assignments

Structure of a "assignments" resource

Creating a restriction set assignment

Structure of a restriction set assignment

Changing a restriction set assignment

Delete a restriction set assignment

Defining values for an assignment

Load all values of a restriction set assignment

Changing the values of a restriction set assignment

Embedded (embedded resources)

Recognition

Inheritance

Links

Embedded (embedded resources)

Links

Embedded (embedded resources)

Restriction

Links

Links