Loading

DFS DMS API (latest)

Download OpenAPI specification:Download

AccessPolicy

The Access Policy API

Retrieve a list of access policies

Retrieves a list of access policies supported by DMS.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v2.0/access-policies
https://example-host/v2.0/access-policies

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Retrieve a list of access policy levels

Retrieves a list of access policy levels supported by DMS.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v2.0/access-policies/levels
https://example-host/v2.0/access-policies/levels

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

DocumentAccessPolicy

The Document Access Policy API

Retrieve person-specific access to the specified document

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.

Authorizations:
path Parameters
documentId
required
integer <int32>

The Document ID

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.0/documents/{documentId}/access-policies
https://example-host/v2.0/documents/{documentId}/access-policies

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Assign person-specific access to a specific document

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.

Authorizations:
path Parameters
documentId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
accessPolicyItems
Array of objects (UpsertDocumentAccessPolicyRequestItem) Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v2.0/documents/{documentId}/access-policies
https://example-host/v2.0/documents/{documentId}/access-policies

Request samples

Content type
Copy
Expand all Collapse all
{
  • "accessPolicyItems":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

DocumentCategory

The Document Category API

Delete a document category

Deletes the document category specified by Id. If it is a parent document category it will also delete its children

Authorizations:
path Parameters
categoryId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v2.0/documents/categories/{categoryId}
https://example-host/v2.0/documents/categories/{categoryId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve a list of document categories

Retrieves a list of document categories.

Authorizations:
query Parameters
isActive
boolean
documentTypeId
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.1/documents/categories
https://example-host/v2.1/documents/categories

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create a document category

Creates a document category. An inactive category cannot be the parent of an active category.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
name
string Nullable
parentId
integer <int32> Nullable
dmsDocumentTypeId
integer <int32>
isActive
boolean Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.1/documents/categories
https://example-host/v2.1/documents/categories

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "parentId": 0,
  • "dmsDocumentTypeId": 0,
  • "isActive": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
0

Retrieve a document category

Retrieves the document category specified by Id.

Authorizations:
path Parameters
categoryId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.1/documents/categories/{categoryId}
https://example-host/v2.1/documents/categories/{categoryId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "parentId": 0,
  • "dmsDocumentTypeId": 0,
  • "isActive": true,
  • "key": "string"
}

Update a document category

Updates the document category specified by Id. An inactive category cannot be the parent of an active category and cannot be assigned to an active metadata.

Authorizations:
path Parameters
categoryId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
name
string Nullable
parentId
integer <int32> Nullable
dmsDocumentTypeId
integer <int32>
isActive
boolean Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v2.1/documents/categories/{categoryId}
https://example-host/v2.1/documents/categories/{categoryId}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "parentId": 0,
  • "dmsDocumentTypeId": 0,
  • "isActive": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Lookup document categories by given criteria Deprecated

Lookup document categories by given criteria.

This API is deprecated. Use POST GET /v2.1/documents/categories instead

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The lookup criteria

documentTypeId
integer <int32> Nullable
isActive
boolean Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.0/documents/categories/lookup
https://example-host/v2.0/documents/categories/lookup

Request samples

Content type
Copy
Expand all Collapse all
{
  • "documentTypeId": 0,
  • "isActive": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Document

The Document API

Delete a document

Deletes a document specified by Id. Only a person with "WRITE" access can successfully call this endpoint.

Authorizations:
path Parameters
documentId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v2.0/documents/{documentId}
https://example-host/v2.0/documents/{documentId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve a document by Document Id

Retrieves a document by Document Id. Only a person with "READ" access can successfully call this endpoint.

Authorizations:
path Parameters
documentId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.1/documents/{documentId}
https://example-host/v2.1/documents/{documentId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "storageFilename": "string",
  • "filename": "string",
  • "digitalSignature": "string",
  • "createDate": "2023-09-15T09:10:06Z",
  • "contractId": "string",
  • "customAttributes": "string",
  • "externalId": "string",
  • "dmsDocumentMetadataId": 0,
  • "validTill": "2023-09-15T09:10:06Z",
  • "isActive": true,
  • "extension": "string",
  • "mimeType": "string",
  • "languageTwoLetterIsoCode": "string",
  • "documentMetadata":
    {
    },
  • "file": "string"
}

Upload a new version of a document

Uploads a new version of an existing document. The caller will need to have “WRITE” access to the metadata or to the replaced document.

Possible ApiError.SubCode values:

FileNotInWhitelist: The format of the provided file is not in the whitelist defined in DMS settings.

Authorizations:
path Parameters
documentId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
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.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v2.1/documents/{documentId}
https://example-host/v2.1/documents/{documentId}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "filename": "string",
  • "customAttributes": "string",
  • "externalId": "string",
  • "validTill": "2023-09-15T09:10:06Z",
  • "file": "string",
  • "fileType": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve a document by External Id

Retrieves a document by External Id. Only a person with "READ" access can successfully call this endpoint.

Authorizations:
path Parameters
externalId
required
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.1/documents/externals/{externalId}
https://example-host/v2.1/documents/externals/{externalId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "storageFilename": "string",
  • "filename": "string",
  • "digitalSignature": "string",
  • "createDate": "2023-09-15T09:10:06Z",
  • "contractId": "string",
  • "customAttributes": "string",
  • "externalId": "string",
  • "dmsDocumentMetadataId": 0,
  • "validTill": "2023-09-15T09:10:06Z",
  • "isActive": true,
  • "extension": "string",
  • "mimeType": "string",
  • "languageTwoLetterIsoCode": "string",
  • "documentMetadata":
    {
    },
  • "file": "string"
}

Update document metadata

Updates document metadata of an existing document. The caller will need to have “WRITE” access to both the old and the new metadata, or to the document itself. If both metadata-id and metadata-reference-id are supplied, metadata-id takes precedence.

Authorizations:
path Parameters
documentId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
documentMetadataId
integer <int32> Nullable
documentMetadataReferenceId
string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/documents/{documentId}/metadata
https://example-host/v1.0/documents/{documentId}/metadata

Request samples

Content type
Copy
Expand all Collapse all
{
  • "documentMetadataId": 0,
  • "documentMetadataReferenceId": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Upload a document Deprecated

Uploads a document to DMS. Note the following:

  • 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. These properties should not be supplied if metadata is not proxied.

This API is deprecated. Use Use POST /v2.3/documents instead

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

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

set file type of the document.

languageTwoLetterIsoCode
string Nullable

Set a specific language for the document.

Responses

200

Successfully saved document

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.2/documents
https://example-host/v2.2/documents

Request samples

Content type
Copy
Expand all Collapse all
{
  • "filename": "string",
  • "contractId": "string",
  • "ownerIds":
    [
    ],
  • "customAttributes": "string",
  • "externalId": "string",
  • "validTill": "2023-09-15T09:10:06Z",
  • "dmsDocumentMetadataId": 0,
  • "metadataReferenceId": "string",
  • "file": "string",
  • "proxyParticipantId": 0,
  • "fileType": "string",
  • "languageTwoLetterIsoCode": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
0

Upload a document

Uploads a document to DMS. Note the following:

  • 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. These properties should not be supplied if metadata is not proxied.

    Possible ApiError.SubCode values:

    FileNotInWhitelist: The format of the provided file is not in the whitelist defined in DMS settings.
Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

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.

proxyParticipantUid
string <uuid> Nullable

specify if metadata is proxied.

fileType
string Nullable

set file type of the document.

languageTwoLetterIsoCode
string Nullable

Set a specific language for the document.

Responses

200

Successfully saved document

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.3/documents
https://example-host/v2.3/documents

Request samples

Content type
Copy
Expand all Collapse all
{
  • "filename": "string",
  • "contractId": "string",
  • "ownerIds":
    [
    ],
  • "customAttributes": "string",
  • "externalId": "string",
  • "validTill": "2023-09-15T09:10:06Z",
  • "dmsDocumentMetadataId": 0,
  • "metadataReferenceId": "string",
  • "file": "string",
  • "proxyParticipantUid": "string",
  • "fileType": "string",
  • "languageTwoLetterIsoCode": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
0

Upload a document

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 the following:

  • DMS storage type should be Azure Blob for streaming 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.
Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema: multipart/form-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.

languageTwoLetterIsoCode
string <string>

Set a specific language for the document.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.0/documents/stream
https://example-host/v2.0/documents/stream

Response samples

Content type
application/json
Copy
Expand all Collapse all
0

Generate a digital signature

Generates a digital signature.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
content
string <byte> Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.0/documents/digital-signature/generate
https://example-host/v2.0/documents/digital-signature/generate

Request samples

Content type
Copy
Expand all Collapse all
{
  • "content": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "digSig": "string"
}

Search documents by given criteria

Search documents by given criteria. The caller cannot retrieve documents for which he/she does not have “READ” access to.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
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

languageTwoLetterIsoCode
string Nullable

filter by language

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.0/documents/search
https://example-host/v2.0/documents/search

Request samples

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortOrder": "Ascending",
  • "sortBy": "string",
  • "documentTypeId": 0,
  • "documentMetadataIds":
    [
    ],
  • "documentCategoryIds":
    [
    ],
  • "createDateFrom": "2023-09-15T09:10:06Z",
  • "createDateTo": "2023-09-15T09:10:06Z",
  • "contractId": "string",
  • "isActive": true,
  • "filename": "string",
  • "languageTwoLetterIsoCode": "string",
  • "personAssignment":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

DocumentMetadataAccessPolicy

The Document Metadata Access Policy API

Retrieve access policies for the specified metadata

Retrieves a list of access policy levels and their assigned access policy for a specified metadata.

Authorizations:
path Parameters
metadataId
required
integer <int32>

The Metadata ID

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.0/documents/metadata/{metadataId}/access-policies
https://example-host/v2.0/documents/metadata/{metadataId}/access-policies

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Assign access policies for the specified metadata

Assign access policies to access-policy-levels for a specified metadata.

Authorizations:
path Parameters
metadataId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
accessPolicies
Array of objects (UpsertMetadataAccessPolicyRequestItem) Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v2.0/documents/metadata/{metadataId}/access-policies
https://example-host/v2.0/documents/metadata/{metadataId}/access-policies

Request samples

Content type
Copy
Expand all Collapse all
{
  • "accessPolicies":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

DocumentMetadata

The Document Metadata API

Delete a document metadata

Deletes a metadata specified by Id.

Authorizations:
path Parameters
metadataId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v2.0/documents/metadata/{metadataId}
https://example-host/v2.0/documents/metadata/{metadataId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve a metadata by Id

Retrieves a metadata by Id.

Authorizations:
path Parameters
metadataId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.1/documents/metadata/{metadataId}
https://example-host/v2.1/documents/metadata/{metadataId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "isMultiInstance": true,
  • "outputFilename": "string",
  • "documentReferenceId": "string",
  • "isActive": true,
  • "allowJointOwnership": true,
  • "documentCategory":
    {
    },
  • "documentType":
    {
    },
  • "isProxied": true
}

Update a document metadata

Updates the document metadata specified by Id. An inactive category cannot be assigned to an active metadata. Metadata may be inactivated even if there are active documents under it.

Authorizations:
path Parameters
metadataId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
name
string Nullable
isMultiInstance
boolean
dmsDocumentCategoryId
integer <int32>
outputFilename
string Nullable
documentReferenceId
string Nullable
allowJointOwnership
boolean
isActive
boolean Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v2.1/documents/metadata/{metadataId}
https://example-host/v2.1/documents/metadata/{metadataId}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "isMultiInstance": true,
  • "dmsDocumentCategoryId": 0,
  • "outputFilename": "string",
  • "documentReferenceId": "string",
  • "allowJointOwnership": true,
  • "isActive": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve a metadata by MetadataReferenceId

Retrieves a metadata by MetadataReferenceId.

Authorizations:
path Parameters
metadataReferenceId
required
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v2.1/documents/metadata/reference/{metadataReferenceId}
https://example-host/v2.1/documents/metadata/reference/{metadataReferenceId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "isMultiInstance": true,
  • "outputFilename": "string",
  • "documentReferenceId": "string",
  • "isActive": true,
  • "allowJointOwnership": true,
  • "documentCategory":
    {
    },
  • "documentType":
    {
    },
  • "isProxied": true
}

Create a document metadata

Creates an active document metadata. An inactive category cannot be assigned to an active metadata.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
name
string Nullable
isMultiInstance
boolean
dmsDocumentCategoryId
integer <int32>
outputFilename
string Nullable
documentReferenceId
string Nullable
allowJointOwnership
boolean
isProxied
boolean Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.1/documents/metadata
https://example-host/v2.1/documents/metadata

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "isMultiInstance": true,
  • "dmsDocumentCategoryId": 0,
  • "outputFilename": "string",
  • "documentReferenceId": "string",
  • "allowJointOwnership": true,
  • "isProxied": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
0

Lookup accessible document metadata

Lookup accessible document metadata by a given criteria.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The lookup criteria

documentType
string (DocumentType)
Enum: "Client" "General"
documentCategoryIds
Array of integers <int32> Nullable
documentMetadataName
string Nullable
isActive
boolean Nullable
metadataAccessPolicy
string (MetadataAccessPolicyFlag)
Enum: "Read" "Write" "Manage" "Any"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.1/documents/metadata/lookup
https://example-host/v2.1/documents/metadata/lookup

Request samples

Content type
Copy
Expand all Collapse all
{
  • "documentType": "Client",
  • "documentCategoryIds":
    [
    ],
  • "documentMetadataName": "string",
  • "isActive": true,
  • "metadataAccessPolicy": "Read"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Search through all document metadata

Searches through all document metadata by a given criteria.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
page
integer <int32>
pageSize
integer <int32>
sortBy
string Nullable
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
searchTerm
string Nullable
searchMetadataBy
string (SearchMetadataBy)
Enum: "Name" "OutputFilename" "All"
documentTypeIds
Array of integers <int32> Nullable
documentCategoryIds
Array of integers <int32> Nullable
isActive
boolean Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/documents/metadata/search
https://example-host/v1.1/documents/metadata/search

Request samples

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "searchTerm": "string",
  • "searchMetadataBy": "Name",
  • "documentTypeIds":
    [
    ],
  • "documentCategoryIds":
    [
    ],
  • "isActive": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Lookup document metadata by given criteria Deprecated

This API is deprecated. Use POST /v2.1/documents/metadata/lookup instead.

Lookup document metadata by given criteria.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The lookup criteria

documentTypeId
integer <int32> Nullable
documentCategoryId
integer <int32> Nullable
isActive
boolean Nullable
metadataAccessPolicy
string (MetadataAccessPolicyFlag)
Enum: "Read" "Write" "Manage" "Any"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.0/documents/metadata/lookup
https://example-host/v2.0/documents/metadata/lookup

Request samples

Content type
Copy
Expand all Collapse all
{
  • "documentTypeId": 0,
  • "documentCategoryId": 0,
  • "isActive": true,
  • "metadataAccessPolicy": "Read"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Search for metadata by given filters Deprecated

This API is deprecated. Use POST /v1.1/documents/metadata/search instead.

Searches for metadata by given filters.

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
page
integer <int32>
pageSize
integer <int32>
sortBy
string Nullable
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
searchTerm
string Nullable
searchMetadataBy
string (SearchMetadataByV10)
Enum: "Name" "OutputFilename" "All"
documentTypeIds
Array of integers <int32> Nullable
documentCategoryIds
Array of integers <int32> Nullable
isActive
boolean Nullable
metadataAccessPolicy
string (MetadataAccessPolicyFlag)
Enum: "Read" "Write" "Manage" "Any"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/documents/metadata/search
https://example-host/v1.0/documents/metadata/search

Request samples

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "searchTerm": "string",
  • "searchMetadataBy": "Name",
  • "documentTypeIds":
    [
    ],
  • "documentCategoryIds":
    [
    ],
  • "isActive": true,
  • "metadataAccessPolicy": "Read"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

DocumentSet

The Document Set API

Retrieve document set

Retrieves document set

Authorizations:
path Parameters
documentSetId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/document-sets/{documentSetId}
https://example-host/v1.0/document-sets/{documentSetId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "key": "string",
  • "documentMetadata":
    [
    ]
}

Update a document set

Updates a document set

Authorizations:
path Parameters
documentSetId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
name
string Nullable
key
string Nullable
documentMetadata
Array of objects (additiv.Dfs.Dms.Api.Contracts.DocumentSet.DocumentMetadata) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/document-sets/{documentSetId}
https://example-host/v1.0/document-sets/{documentSetId}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "key": "string",
  • "documentMetadata":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Validate whether a person owns active documents under all mandatory metadata listed in a specific document set

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 had “READ“ access to are considered. If a contract is specified, the check would be performed only for documents which have this contract set for them. When returning information on unfulfilled metadatas, note that non-mandatory metadata will be returned as well.

Authorizations:
path Parameters
ownerId
required
integer <int32>
documentSetId
required
integer <int32>
query Parameters
contractId
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/document-sets/{documentSetId}/owners/{ownerId}/fulfillment
https://example-host/v1.0/document-sets/{documentSetId}/owners/{ownerId}/fulfillment

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "isFulfilled": true,
  • "unfulfilledMetadataIds":
    [
    ]
}

Validate whether a person owns active documents under all mandatory metadata listed in a specific document set Deprecated

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 had “READ“ access to are considered. If a contract is specified, the check would be performed only for documents which have this contract set for them. When returning information on unfulfilled metadatas, note that non-mandatory metadata will be returned as well.

Authorizations:
path Parameters
ownerId
required
integer <int32>
documentSetKey
required
string
query Parameters
contractId
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/owners/{ownerId}/document-sets/{documentSetKey}/fulfillment
https://example-host/v1.0/owners/{ownerId}/document-sets/{documentSetKey}/fulfillment

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "isFulfilled": true,
  • "unfulfilledMetadataIds":
    [
    ]
}

Create a document set

Creates a document set

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The document set to save

name
string Nullable
key
string Nullable
documentMetadata
Array of objects (additiv.Dfs.Dms.Api.Contracts.DocumentSet.DocumentMetadata) Nullable

Responses

200

Successfully saved document set

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/document-sets
https://example-host/v1.0/document-sets

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "key": "string",
  • "documentMetadata":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
0

DocumentType

The Document Type API

Retrieve list of document types

Retrieves list of document types

Authorizations:
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/documents/types
https://example-host/v1.0/documents/types

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]