Download OpenAPI specification:Download
Retrieves a list of access policies supported by DMS.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "id": 0,
- "name": "string"
}
]
Retrieves a list of access policy levels supported by DMS.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "id": 0,
- "name": "string"
}
]
Retrieves a list of persons and their assigned access policy for a specified document. Only a member with “MANAGE” access can successfully call this endpoint.
documentId required | integer <int32> The Document ID |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
[- {
- "personId": 0,
- "accessPolicy": {
- "id": 0,
- "name": "string"
}
}
]
Assign access policies of specific persons to the specified document. Only a member with “MANAGE” access can successfully call this endpoint. A successful call will override existing person-specific access policies assigned to this document.
documentId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
accessPolicyItems | Array of objects (UpsertDocumentAccessPolicyRequestItem) Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "accessPolicyItems": [
- {
- "personId": 0,
- "accessPolicyId": 0
}
]
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Deletes the document category specified by Id. If it is a parent document category it will also delete its children
categoryId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves a list of document categories.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "id": 0,
- "name": "string",
- "parentId": 0,
- "dmsDocumentTypeId": 0,
- "isActive": true,
- "key": "string"
}
]
Creates a document category.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
name | string Nullable |
parentId | integer <int32> Nullable |
dmsDocumentTypeId | integer <int32> |
isActive | boolean Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "string",
- "parentId": 0,
- "dmsDocumentTypeId": 0,
- "isActive": true
}
0
Retrieves the document category specified by Id.
categoryId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "name": "string",
- "parentId": 0,
- "dmsDocumentTypeId": 0,
- "isActive": true,
- "key": "string"
}
Updates the document category specified by Id. ParentId can only be updated to an active category. IsActive can only be changed to false if there are no active metadata assigned to the specified category.
categoryId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
name | string Nullable |
parentId | integer <int32> Nullable |
dmsDocumentTypeId | integer <int32> |
isActive | boolean Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "name": "string",
- "parentId": 0,
- "dmsDocumentTypeId": 0,
- "isActive": true
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Lookup document categories by given criteria.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The lookup criteria
documentTypeId | integer <int32> Nullable |
isActive | boolean Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "documentTypeId": 0,
- "isActive": true
}
[- {
- "id": 0,
- "name": "string",
- "parentId": 0
}
]
Deletes a document specified by Id. Only a person with “WRITE” access or above can successfully call this endpoint.
documentId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves a document by Document Id. Only a person with “READ” access or above can successfully call this endpoint.
documentId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "storageFilename": "string",
- "filename": "string",
- "digitalSignature": "string",
- "createDate": "2022-12-20T12:45:21Z",
- "contractId": "string",
- "customAttributes": "string",
- "externalId": "string",
- "dmsDocumentMetadataId": 0,
- "validTill": "2022-12-20T12:45:21Z",
- "isActive": true,
- "extension": "string",
- "mimeType": "string",
- "documentMetadata": {
- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}
}, - "file": "string"
}
Updates an existing document in DMS. The caller will need to have “WRITE” access to the metadata or to the replaced document.
documentId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
filename | string Nullable |
customAttributes | string Nullable |
externalId | string Nullable |
validTill | string <date-time> Nullable |
file | string <byte> Nullable set the uploaded file in base64 format. Files bigger than 150MB might fail the call due to technical limitations. Do not specify file if metadata is proxied. |
fileType | string Nullable may be updated only if metadata is proxied. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "filename": "string",
- "customAttributes": "string",
- "externalId": "string",
- "validTill": "2022-12-20T12:45:21Z",
- "file": "string",
- "fileType": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves a document by External Id. Only a person with “READ” access or above can successfully call this endpoint.
externalId required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "storageFilename": "string",
- "filename": "string",
- "digitalSignature": "string",
- "createDate": "2022-12-20T12:45:21Z",
- "contractId": "string",
- "customAttributes": "string",
- "externalId": "string",
- "dmsDocumentMetadataId": 0,
- "validTill": "2022-12-20T12:45:21Z",
- "isActive": true,
- "extension": "string",
- "mimeType": "string",
- "documentMetadata": {
- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}
}, - "file": "string"
}
Uploads a document to DMS. The caller will need to have “WRITE” access to the metadata. If the access is given through owner-specific access policy, the uploader needs to have the right relation with at least one of the specified owners. A new document cannot be assigned to an inactive metadata. Upload of documents bigger than 150MB might fail due to technical limitations. If metadata is configured to be proxied, specify proxy participant and file type instead of the file itself.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The document to save
filename | string Nullable |
contractId | string <uuid> Nullable link the document to an entity in DFS through GUID. |
ownerIds | Array of integers <int32> Nullable set persons associated with the document. |
customAttributes | string Nullable set custom attributes to the document. |
externalId | string Nullable set externalId of the document. externalId must be unique. |
validTill | string <date-time> Nullable set validity of the document. This field does not effect the active state of the document. |
dmsDocumentMetadataId | integer <int32> set under which metadata will the document be using metadata id. If both metadata id and metadata reference id are supplied, this field takes precedence. |
metadataReferenceId | string Nullable set under which metadata will the document be using metadata reference id. |
file | string <byte> Nullable set the uploaded file in base64 format. Files bigger than 150MB might fail the call due to technical limitations. Do not specify file if metadata is proxied. |
proxyParticipantId | integer <int32> Nullable specify if metadata is proxied. |
fileType | string Nullable specify if metadata is proxied. |
Successfully saved document
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "filename": "string",
- "contractId": "string",
- "ownerIds": [
- 0
], - "customAttributes": "string",
- "externalId": "string",
- "validTill": "2022-12-20T12:45:21Z",
- "dmsDocumentMetadataId": 0,
- "metadataReferenceId": "string",
- "file": "string",
- "proxyParticipantId": 0,
- "fileType": "string"
}
0
Uploads a document to DMS as a stream. The values need to be passed as multipart/form-data and the actual document needs to be passed as a stream. Note that DMS storage type should be Azure Blob for this functionality to work. The caller will need to have “WRITE” access to the metadata. If the access is given through owner-specific access policy, the uploader needs to have the right relation with at least one of the specified owners. A new document cannot be assigned to an inactive metadata.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
file required | string <binary> The document stream to upload. |
filename required | string <string> The name of the document in the storage. |
contractId | string <uuid> Links the document to a contract in DFS. |
externalId | string <string> The external ID of the document. Must be unique if passed. |
ownerIds | Array of integers <int32> The persons owning the document. |
customAttributes | string <string> Custom attributes of the document |
validTill | string <date-time> The validity date of the document. This field does not effect the active state of the document. |
dmsDocumentMetadataId | integer <int32> Default: 0 The metadata ID of the document. If both dmsDocumentMetadataId and metadataReferenceId are supplied, this field takes precedence. |
metadataReferenceId | string <string> The metadata reference ID of the document. If both dmsDocumentMetadataId and metadataReferenceId are supplied, the field dmsDocumentMetadataId takes precedence. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
0
Generates a digital signature.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
content | string <byte> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "content": "string"
}
{- "digSig": "string"
}
Search documents by given criteria. The caller cannot retrieve documents for which he/she does not have “READ” access to.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
page | integer <int32> |
pageSize | integer <int32> |
sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
sortBy | string Nullable sort by one of the following fields: id (default), filename, createdate, DocumentCategoryId, DocumentMetadataId, mimeType, ValidTill |
documentTypeId | integer <int32> Nullable filter by document type |
documentMetadataIds | Array of integers <int32> Nullable filter by document metadata |
documentCategoryIds | Array of integers <int32> Nullable filter by document category |
createDateFrom | string <date-time> Nullable filter by CreateDateFrom |
createDateTo | string <date-time> Nullable filter by CreateDateTo |
contractId | string <uuid> Nullable filter by entities linked to documents. |
isActive | boolean Nullable filter by status of the document |
filename | string Nullable filter by file name |
personAssignment | object (PersonAssignment) filter by specific people with assignment to the document, either as owners or as people with direct document access. If no persons are specified, hierarchy access to documents will not be checked |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortOrder": "Ascending",
- "sortBy": "string",
- "documentTypeId": 0,
- "documentMetadataIds": [
- 0
], - "documentCategoryIds": [
- 0
], - "createDateFrom": "2022-12-20T12:45:21Z",
- "createDateTo": "2022-12-20T12:45:21Z",
- "contractId": "string",
- "isActive": true,
- "filename": "string",
- "personAssignment": {
- "ids": [
- 0
], - "scope": "Owner"
}
}
{- "results": [
- {
- "id": 0,
- "storageFilename": "string",
- "filename": "string",
- "digitalSignature": "string",
- "createDate": "2022-12-20T12:45:21Z",
- "contractId": "string",
- "customAttributes": "string",
- "externalId": "string",
- "dmsDocumentMetadataId": 0,
- "validTill": "2022-12-20T12:45:21Z",
- "isActive": true,
- "extension": "string",
- "mimeType": "string",
- "documentMetadata": {
- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}
}, - "file": "string"
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}
Retrieves a list of access policy levels and their assigned access policy for a specified metadata.
metadataId required | integer <int32> The Metadata ID |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
[- {
- "accessPolicy": {
- "id": 0,
- "name": "string"
}, - "accessPolicyLevel": {
- "id": 0,
- "name": "string"
}
}
]
Assign access policies of access policy levels for the specified metadata. A successful call will override existing access policies assigned to this metadata.
metadataId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
accessPolicies | Array of objects (UpsertMetadataAccessPolicyRequestItem) Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "accessPolicies": [
- {
- "accessPolicyLevelId": 0,
- "accessPolicyId": 0
}
]
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Deletes a metadata specified by Id.
metadataId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves a metadata by Id.
metadataId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}, - "isProxied": true
}
Updates the document metadata specified by Id. Metadata cannot be assigned to inactive category. IsActive can be changed to false even if there are active documents assigned to this metadata.
metadataId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
name | string Nullable |
isMultiInstance | boolean |
dmsDocumentCategoryId | integer <int32> |
outputFilename | string Nullable |
documentReferenceId | string Nullable |
allowJointOwnership | boolean |
isActive | boolean Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "name": "string",
- "isMultiInstance": true,
- "dmsDocumentCategoryId": 0,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "allowJointOwnership": true,
- "isActive": true
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves a metadata by MetadataReferenceId.
metadataReferenceId required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}, - "isProxied": true
}
Creates a document metadata.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
name | string Nullable |
isMultiInstance | boolean |
dmsDocumentCategoryId | integer <int32> |
outputFilename | string Nullable |
documentReferenceId | string Nullable |
allowJointOwnership | boolean |
isProxied | boolean Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "string",
- "isMultiInstance": true,
- "dmsDocumentCategoryId": 0,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "allowJointOwnership": true,
- "isProxied": true
}
0
Lookup document metadata by given criteria.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The lookup criteria
documentTypeId | integer <int32> Nullable |
documentCategoryId | integer <int32> Nullable |
isActive | boolean Nullable |
metadataAccessPolicy | string (MetadataAccessPolicyFlag) Enum: "Read" "Write" "ReadWrite" "Manage" "Any" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "documentTypeId": 0,
- "documentCategoryId": 0,
- "isActive": true,
- "metadataAccessPolicy": "Read"
}
[- {
- "id": 0,
- "name": "string"
}
]
Retrieves a list of metadata by given criteria.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
page | integer <int32> |
pageSize | integer <int32> |
sortBy | string Nullable |
sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
searchTerm | string Nullable |
searchMetadataBy | string (SearchMetadataBy) Enum: "Name" "OutputFilename" "DmsDocumentCategoryName" "DmsDocumentTypeName" "All" |
documentTypeId | integer <int32> Nullable |
documentCategoryId | integer <int32> Nullable |
isActive | boolean Nullable |
metadataAccessPolicy | string (MetadataAccessPolicyFlag) Enum: "Read" "Write" "ReadWrite" "Manage" "Any" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "searchTerm": "string",
- "searchMetadataBy": "Name",
- "documentTypeId": 0,
- "documentCategoryId": 0,
- "isActive": true,
- "metadataAccessPolicy": "Read"
}
{- "results": [
- {
- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}
Searches for metadata by given filters.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
page | integer <int32> |
pageSize | integer <int32> |
sortBy | string Nullable |
sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
searchTerm | string Nullable |
searchMetadataBy | string (SearchMetadataBy) Enum: "Name" "OutputFilename" "DmsDocumentCategoryName" "DmsDocumentTypeName" "All" |
documentTypeIds | Array of integers <int32> Nullable |
documentCategoryIds | Array of integers <int32> Nullable |
isActive | boolean Nullable |
metadataAccessPolicy | string (MetadataAccessPolicyFlag) Enum: "Read" "Write" "ReadWrite" "Manage" "Any" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "searchTerm": "string",
- "searchMetadataBy": "Name",
- "documentTypeIds": [
- 0
], - "documentCategoryIds": [
- 0
], - "isActive": true,
- "metadataAccessPolicy": "Read"
}
{- "results": [
- {
- "id": 0,
- "name": "string",
- "isMultiInstance": true,
- "outputFilename": "string",
- "documentReferenceId": "string",
- "isActive": true,
- "allowJointOwnership": true,
- "documentCategory": {
- "id": 0,
- "name": "string"
}, - "documentType": {
- "id": 0,
- "name": "string"
}
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}
Retrieves document set
documentSetId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "name": "string",
- "key": "string",
- "documentMetadata": [
- {
- "id": 0,
- "isMandatory": true
}
]
}
Updates a document set
documentSetId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
name | string Nullable |
key | string Nullable |
documentMetadata | Array of objects (DocumentMetadata) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "name": "string",
- "key": "string",
- "documentMetadata": [
- {
- "id": 0,
- "isMandatory": true
}
]
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Validates whether a person owns active documents under all mandatory metadata listed in a specific document set. Only documents which the calling person or app may access are considered. If a contract is specified, the check would be performed only for documents which have this contract set for them.
ownerId required | integer <int32> |
documentSetKey required | string |
contractId | string <uuid> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "isFulfilled": true
}
Creates a document set
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The document set to save
name | string Nullable |
key | string Nullable |
documentMetadata | Array of objects (DocumentMetadata) Nullable |
Successfully saved document set
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "string",
- "key": "string",
- "documentMetadata": [
- {
- "id": 0,
- "isMandatory": true
}
]
}
0
Retrieves list of document types
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "id": 0,
- "name": "string"
}
]