Download OpenAPI specification:Download
id required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
"Continue"
id required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "Id": 0,
- "Name": "string",
- "ParentId": 0,
- "DmsDocumentTypeId": 0,
- "TenantId": 0,
- "IsActive": true
}
id required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
"Continue"
id required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "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": {
- "Id": 0,
- "Name": "string"
}
}
documentid required | integer <int32> |
ownerid required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
"Continue"
documentid required | integer <int32> |
ownerid required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "Id": 0,
- "Name": "string",
- "ParentId": 0,
- "DmsDocumentTypeId": 0,
- "TenantId": 0,
- "IsActive": true
}
]
Id | integer <int32> |
Name | string Nullable |
ParentId | integer <int32> Nullable |
DmsDocumentTypeId | integer <int32> |
TenantId | integer <int32> |
IsActive | boolean Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "Id": 0,
- "Name": "string",
- "ParentId": 0,
- "DmsDocumentTypeId": 0,
- "TenantId": 0,
- "IsActive": true
}
0
Success
Bad Request
Unauthorized
Forbidden
Server Error
[- {
- "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": {
- "Id": 0,
- "Name": "string"
}
}
]
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) |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "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": {
- "Id": 0,
- "Name": "string"
}
}
0
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) |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "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": {
- "Id": 0,
- "Name": "string"
}
}
[- {
- "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": {
- "Id": 0,
- "Name": "string"
}
}
]
Search | string Nullable |
Skip | integer <int32> |
Take | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "TotalCount": 0,
- "Items": [
- {
- "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": {
- "Id": 0,
- "Name": "string"
}
}
]
}
metadataid required | integer <int32> |
ownerid required | integer <int32> |
contractid required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
metadataid required | integer <int32> |
ownerid required | integer <int32> |
externalid required | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
ownerid required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
[- {
- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
]
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- 0
]
[- {
- "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": {
- "Id": 0,
- "Name": "string"
}
}
]
There are two possible types of storing the document (depends on DmsDocumentMetadata's IsMultiInstance flag):
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 |
Successfully saved document
Bad Request
Unauthorized
Forbidden
Couldn't save the document. DocumentMetadata was not found
UnprocessableEntity
Server Error
{- "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"
}
0
startdate required | string <date-time> |
enddate required | string <date-time> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- 0
]
[- {
- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
]
numberofdays required | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
[- 0
]
[- {
- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
]
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
"string"
"string"
OwnerIds | Array of integers <int32> Nullable |
StartDate | string <date-time> |
EndDate | string <date-time> |
CategoryIds | Array of integers <int32> Nullable |
Successfully retrieved the client documents
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "OwnerIds": [
- 0
], - "StartDate": "2020-11-23T16:28:43Z",
- "EndDate": "2020-11-23T16:28:43Z",
- "CategoryIds": [
- 0
]
}
[- {
- "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": {
- "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": {
- "Id": 0,
- "Name": "string"
}
}, - "File": "string"
}
]