Loading
Documentation Powered by ReDoc

DMS API (v1)

Download OpenAPI specification:Download

DocumentManagement

Delete category

Authorizations:
BasicAppId_and_ApiKey
path Parameters
id
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

delete/v1.0/documents/categories/{id}
https://example-host/v1.0/documents/categories/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"Continue"

Get categories (by id)

Authorizations:
BasicAppId_and_ApiKey
path Parameters
id
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/categories/{id}
https://example-host/v1.0/documents/categories/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "ParentId": 0,
  • "DmsDocumentTypeId": 0,
  • "TenantId": 0,
  • "IsActive": true
}

Delete metadata (by id)

Authorizations:
BasicAppId_and_ApiKey
path Parameters
id
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

delete/v1.0/documents/metadata/{id}
https://example-host/v1.0/documents/metadata/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"Continue"

Get metadata (by id and tenant)

Authorizations:
BasicAppId_and_ApiKey
path Parameters
id
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/metadata/{id}
https://example-host/v1.0/documents/metadata/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "IsPrivate": true,
  • "IsMultiInstance": true,
  • "ShowToCustomer": true,
  • "OutputFilename": "string",
  • "DocumentReferenceId": "string",
  • "TenantId": 0,
  • "IsActive": true,
  • "IsUploadable": true,
  • "DmsDocumentCategoryId": 0,
  • "DmsDocumentCategoryName": "string",
  • "DmsDocumentType":
    {
    }
}

Delete document (by id)

Authorizations:
BasicAppId_and_ApiKey
path Parameters
documentid
required
integer <int32>
ownerid
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

delete/v1.0/documents/{documentid}/owners/{ownerid}
https://example-host/v1.0/documents/{documentid}/owners/{ownerid}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"Continue"

Get document

Authorizations:
BasicAppId_and_ApiKey
path Parameters
documentid
required
integer <int32>
ownerid
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/{documentid}/owners/{ownerid}
https://example-host/v1.0/documents/{documentid}/owners/{ownerid}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-11-23T16:28:43Z",
  • "OwnerId": 0,
  • "ContractId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "DmsDocumentMetadataId": 0,
  • "ValidTill": "2020-11-23T16:28:43Z",
  • "IsActive": true,
  • "Extension": "string",
  • "MimeType": "string",
  • "DocumentMetadata":
    {
    },
  • "File": "string"
}

Get types

Authorizations:
BasicAppId_and_ApiKey

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
[
  • {
    }
]

Get categories

Authorizations:
BasicAppId_and_ApiKey

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

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

Response samples

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

Create category

Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json
Id
integer <int32>
Name
string Nullable
ParentId
integer <int32> Nullable
DmsDocumentTypeId
integer <int32>
TenantId
integer <int32>
IsActive
boolean Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/documents/categories
https://example-host/v1.0/documents/categories

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "ParentId": 0,
  • "DmsDocumentTypeId": 0,
  • "TenantId": 0,
  • "IsActive": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
0

Get list metadata (by tenant)

Authorizations:
BasicAppId_and_ApiKey

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

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

Response samples

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

Create document metadata

Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json
Id
integer <int32>
Name
string Nullable
IsPrivate
boolean
IsMultiInstance
boolean
ShowToCustomer
boolean
OutputFilename
string Nullable
DocumentReferenceId
string Nullable
TenantId
integer <int32>
IsActive
boolean Nullable
IsUploadable
boolean
DmsDocumentCategoryId
integer <int32>
DmsDocumentCategoryName
string Nullable
DmsDocumentType
object (DmsDocumentType)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "IsPrivate": true,
  • "IsMultiInstance": true,
  • "ShowToCustomer": true,
  • "OutputFilename": "string",
  • "DocumentReferenceId": "string",
  • "TenantId": 0,
  • "IsActive": true,
  • "IsUploadable": true,
  • "DmsDocumentCategoryId": 0,
  • "DmsDocumentCategoryName": "string",
  • "DmsDocumentType":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
0

Update metadata (by id and tenant)

Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json
Id
integer <int32>
Name
string Nullable
IsPrivate
boolean
IsMultiInstance
boolean
ShowToCustomer
boolean
OutputFilename
string Nullable
DocumentReferenceId
string Nullable
TenantId
integer <int32>
IsActive
boolean Nullable
IsUploadable
boolean
DmsDocumentCategoryId
integer <int32>
DmsDocumentCategoryName
string Nullable
DmsDocumentType
object (DmsDocumentType)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v1.0/documents/metadata
https://example-host/v1.0/documents/metadata

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "IsPrivate": true,
  • "IsMultiInstance": true,
  • "ShowToCustomer": true,
  • "OutputFilename": "string",
  • "DocumentReferenceId": "string",
  • "TenantId": 0,
  • "IsActive": true,
  • "IsUploadable": true,
  • "DmsDocumentCategoryId": 0,
  • "DmsDocumentCategoryName": "string",
  • "DmsDocumentType":
    {
    }
}

Response samples

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

Get metadata (by tenant)

Authorizations:
BasicAppId_and_ApiKey
query Parameters
Search
string Nullable
Skip
integer <int32>
Take
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/metadata/pageitems
https://example-host/v1.0/documents/metadata/pageitems

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "TotalCount": 0,
  • "Items":
    [
    ]
}

Get actual document (with contractId)

Authorizations:
BasicAppId_and_ApiKey
path Parameters
metadataid
required
integer <int32>
ownerid
required
integer <int32>
contractid
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/metadata/{metadataid}/owners/{ownerid}/contracts/{contractid}
https://example-host/v1.0/documents/metadata/{metadataid}/owners/{ownerid}/contracts/{contractid}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-11-23T16:28:43Z",
  • "OwnerId": 0,
  • "ContractId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "DmsDocumentMetadataId": 0,
  • "ValidTill": "2020-11-23T16:28:43Z",
  • "IsActive": true,
  • "Extension": "string",
  • "MimeType": "string",
  • "DocumentMetadata":
    {
    },
  • "File": "string"
}

Get actual document (with externalId)

Authorizations:
BasicAppId_and_ApiKey
path Parameters
metadataid
required
integer <int32>
ownerid
required
integer <int32>
externalid
required
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/metadata/{metadataid}/owners/{ownerid}/externals/{externalid}
https://example-host/v1.0/documents/metadata/{metadataid}/owners/{ownerid}/externals/{externalid}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-11-23T16:28:43Z",
  • "OwnerId": 0,
  • "ContractId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "DmsDocumentMetadataId": 0,
  • "ValidTill": "2020-11-23T16:28:43Z",
  • "IsActive": true,
  • "Extension": "string",
  • "MimeType": "string",
  • "DocumentMetadata":
    {
    },
  • "File": "string"
}

Get user's documents

Authorizations:
BasicAppId_and_ApiKey
path Parameters
ownerid
required
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/documents/owners/{ownerid}
https://example-host/v1.0/documents/owners/{ownerid}

Response samples

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

Get list metadata (by tenant, types and categories)

Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json
Array
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
[
  • 0
]

Response samples

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

Saves the document on DMS

There are two possible types of storing the document (depends on DmsDocumentMetadata's IsMultiInstance flag):

  • upload the document as a new version of existing one (uploads the document and sets ReplacedById of the latest document with newly uploaded documentId)
  • upload the document as a new document (uploads the document)
Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json

The document to save

Id
integer <int32>
OriginalFilename
string Nullable
RetrieveFileAsName
string Nullable
DigitalSignature
string Nullable
ReplacedById
integer <int32> Nullable
CreateDate
string <date-time>
OwnerId
integer <int32>
TenantId
integer <int32>
StoragePath
string Nullable
CustomAttributes
string Nullable
ExternalId
string Nullable
ValidTill
string <date-time>
IsActive
boolean Nullable
DmsDocumentMetadataId
integer <int32>
MetadataReferenceId
string Nullable
File
string <byte> Nullable

Responses

200

Successfully saved document

400

Bad Request

401

Unauthorized

403

Forbidden

404

Couldn't save the document. DocumentMetadata was not found

422

UnprocessableEntity

500

Server Error

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

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-11-23T16:28:43Z",
  • "OwnerId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "ValidTill": "2020-11-23T16:28:43Z",
  • "IsActive": true,
  • "DmsDocumentMetadataId": 0,
  • "MetadataReferenceId": "string",
  • "File": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
0

Get documents by list of Owners and span of time Deprecated

Authorizations:
BasicAppId_and_ApiKey
path Parameters
startdate
required
string <date-time>
enddate
required
string <date-time>
Request Body schema:
application/json-patch+json
Array
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/documents/owners/startdate/{startdate}/enddate/{enddate}
https://example-host/v1.0/documents/owners/startdate/{startdate}/enddate/{enddate}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
[
  • 0
]

Response samples

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

Get documents by list of Owners and number of days from now Deprecated

Authorizations:
BasicAppId_and_ApiKey
path Parameters
numberofdays
required
integer <int32>
Request Body schema:
application/json-patch+json
Array
integer <int32>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/documents/owners/numberofdays/{numberofdays}
https://example-host/v1.0/documents/owners/numberofdays/{numberofdays}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
[
  • 0
]

Response samples

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

DigSig

Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json
string <byte> Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/v1.0/documents/generatedigsig
https://example-host/v1.0/documents/generatedigsig

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
"string"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Gets the list of documents with DMS Document Type set as "Client"

Authorizations:
BasicAppId_and_ApiKey
Request Body schema:
application/json-patch+json
OwnerIds
Array of integers <int32> Nullable
StartDate
string <date-time>
EndDate
string <date-time>
CategoryIds
Array of integers <int32> Nullable

Responses

200

Successfully retrieved the client documents

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/documents/client
https://example-host/v1.0/documents/client

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "OwnerIds":
    [
    ],
  • "StartDate": "2020-11-23T16:28:43Z",
  • "EndDate": "2020-11-23T16:28:43Z",
  • "CategoryIds":
    [
    ]
}

Response samples

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