Loading

Document Management Service (v1)

Download OpenAPI specification:Download

DocumentManagement

Get types

header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

Get categories

header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

Create category

header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
Id
integer <int32>
Name
string
ParentId
integer <int32>
DmsDocumentTypeId
integer <int32>
TenantId
integer <int32>
IsActive
boolean

Responses

200

OK

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

Request samples

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

Response samples

Content type
Copy
Expand all Collapse all
0

Get categories (by id)

path Parameters
id
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

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

Delete category

path Parameters
id
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
"Continue"

Get list metadata (by tenant)

header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

Update metadata (by id and tenant)

header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
Id
integer <int32>
Name
string
IsPrivate
boolean
IsMultiInstance
boolean
ShowToCustomer
boolean
OutputFilename
string
DocumentReferenceId
string
TenantId
integer <int32>
IsActive
boolean
IsUploadable
boolean
DmsDocumentCategoryId
integer <int32>
DmsDocumentCategoryName
string
DmsDocumentType
object (DmsDocumentType)

Responses

200

OK

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

Request samples

Content type
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
Copy
Expand all Collapse all
[
  • {
    }
]

Create document metadata

header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
Id
integer <int32>
Name
string
IsPrivate
boolean
IsMultiInstance
boolean
ShowToCustomer
boolean
OutputFilename
string
DocumentReferenceId
string
TenantId
integer <int32>
IsActive
boolean
IsUploadable
boolean
DmsDocumentCategoryId
integer <int32>
DmsDocumentCategoryName
string
DmsDocumentType
object (DmsDocumentType)

Responses

200

OK

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

Request samples

Content type
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
Copy
Expand all Collapse all
0

Get list metadata (by tenant, types and categories)

header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
Array
integer <int32>

Responses

200

OK

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

Request samples

Content type
Copy
Expand all Collapse all
[
  • 0
]

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

Get metadata (by id and tenant)

path Parameters
id
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
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 metadata (by id)

path Parameters
id
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
"Continue"

Get metadata (by tenant)

query Parameters
filter.search
string
filter.skip
integer <int32>
filter.take
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

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

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)
header Parameters
Authorization
string

The BasicAuth token

Request Body schema:

The document to save

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

Responses

200

Successfully saved document

404

Couldn't save the document. DocumentMetadata was not found

422

Couldn't process the request

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

Request samples

Content type
Copy
Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-06-26T13:45:09Z",
  • "OwnerId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "ValidTill": "2020-06-26T13:45:09Z",
  • "IsActive": true,
  • "DmsDocumentMetadataId": 0,
  • "MetadataReferenceId": "string",
  • "File": "string"
}

Get document

path Parameters
documentid
required
integer <int32>
ownerid
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-06-26T13:45:10Z",
  • "OwnerId": 0,
  • "ContractId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "DmsDocumentMetadataId": 0,
  • "ValidTill": "2020-06-26T13:45:10Z",
  • "IsActive": true,
  • "Extension": "string",
  • "MimeType": "string",
  • "DocumentMetadata":
    {
    },
  • "File": "string"
}

Delete document (by id)

path Parameters
documentid
required
integer <int32>
ownerid
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
"Continue"

Get actual document (with contractId)

path Parameters
metadataid
required
integer <int32>
ownerid
required
integer <int32>
contractid
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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
Copy
Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-06-26T13:45:10Z",
  • "OwnerId": 0,
  • "ContractId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "DmsDocumentMetadataId": 0,
  • "ValidTill": "2020-06-26T13:45:10Z",
  • "IsActive": true,
  • "Extension": "string",
  • "MimeType": "string",
  • "DocumentMetadata":
    {
    },
  • "File": "string"
}

Get actual document (with externalId)

path Parameters
metadataid
required
integer <int32>
ownerid
required
integer <int32>
externalid
required
string
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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
Copy
Expand all Collapse all
{
  • "Id": 0,
  • "OriginalFilename": "string",
  • "RetrieveFileAsName": "string",
  • "DigitalSignature": "string",
  • "ReplacedById": 0,
  • "CreateDate": "2020-06-26T13:45:10Z",
  • "OwnerId": 0,
  • "ContractId": 0,
  • "TenantId": 0,
  • "StoragePath": "string",
  • "CustomAttributes": "string",
  • "ExternalId": "string",
  • "DmsDocumentMetadataId": 0,
  • "ValidTill": "2020-06-26T13:45:10Z",
  • "IsActive": true,
  • "Extension": "string",
  • "MimeType": "string",
  • "DocumentMetadata":
    {
    },
  • "File": "string"
}

Get user's documents

path Parameters
ownerid
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Responses

200

OK

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

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

Get documents by list of Owners and span of time Deprecated

path Parameters
startdate
required
string <date-time>
enddate
required
string <date-time>
header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
Array
integer <int32>

Responses

200

OK

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

Request samples

Content type
Copy
Expand all Collapse all
[
  • 0
]

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

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

path Parameters
numberofdays
required
integer <int32>
header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
Array
integer <int32>

Responses

200

OK

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

Request samples

Content type
Copy
Expand all Collapse all
[
  • 0
]

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

DigSig

header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
string <byte>

Responses

200

OK

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

Request samples

Content type
Copy
Expand all Collapse all
"string"

Response samples

Content type
Copy
Expand all Collapse all
"string"

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

header Parameters
Authorization
string

The BasicAuth token

Request Body schema:
OwnerIds
Array of integers <int32>
StartDate
string <date-time>
EndDate
string <date-time>
CategoryIds
Array of integers <int32>

Responses

200

Successfully retrieved the client documents

422

Couldn't process the request due to unexpected error

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

Request samples

Content type
Copy
Expand all Collapse all
{
  • "OwnerIds":
    [
    ],
  • "StartDate": "2020-06-26T13:45:10Z",
  • "EndDate": "2020-06-26T13:45:10Z",
  • "CategoryIds":
    [
    ]
}