Skip to main content
API docs by Redocly

dmss-archive-services (24.2.0.11)

Download OpenAPI specification:Download

TrustLynx: sales@trustlynx.com URL: https://trustlynx.com

document-controller

Upload new document version

Upload new document version

path Parameters
id
required
string

Document id from archive service

Request Body schema: multipart/form-data
file
required
string <binary>

Attached file

object (DocumentData)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "version_number": "string",
  • "dataUpdated": true,
  • "nameUpdated": true,
  • "externalid": "string",
  • "archiveName": "string"
}

Upload new document version in Base64

Upload new document version in Base64

path Parameters
id
required
string

Document id from archive service

Request Body schema: application/json
required

Document data parameters

documentFilename
string
Example: "SWRENT-FAILURE-1.pdf"
fileName
string
objectName
string
Example: "SWRENT-FAILURE-1.pdf"
contentType
string
Example: "application/pdf"
fileContent
string
documentType
string
Example: "DMSSDoc"
documentPath
string
siteId
string
documentData
string
Example: "{}"

Responses

Request samples

Content type
application/json
{
  • "documentFilename": "SWRENT-FAILURE-1.pdf",
  • "fileName": "string",
  • "objectName": "SWRENT-FAILURE-1.pdf",
  • "contentType": "application/pdf",
  • "fileContent": "string",
  • "documentType": "DMSSDoc",
  • "documentPath": "string",
  • "siteId": "string",
  • "documentData": "{}"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version_number": "string",
  • "dataUpdated": true,
  • "nameUpdated": true,
  • "externalid": "string",
  • "archiveName": "string"
}

Update document metadata

Update document metadata

path Parameters
id
required
string

Document id from archive service

Request Body schema: application/json
required

Document metadata parameters

create_date
string <date-time>
description
string
external_create_date
string <date-time>
external_identity
string
external_identity_type
string
file_name
string
file_size
string
file_type
string
id
string
mime_type
string
version_id
integer <int32>
version_number
string
objectName
string
name
string

Responses

Request samples

Content type
application/json
{
  • "create_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "external_create_date": "2019-08-24T14:15:22Z",
  • "external_identity": "string",
  • "external_identity_type": "string",
  • "file_name": "string",
  • "file_size": "string",
  • "file_type": "string",
  • "id": "string",
  • "mime_type": "string",
  • "version_id": 0,
  • "version_number": "string",
  • "objectName": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "dataUpdated": true,
  • "nameUpdated": true
}

Get simple document

Downloads simple file using document ID and document version

path Parameters
id
required
string

Document id from archive service

query Parameters
version
string

Document version

Responses

Response samples

Content type
application/json
{
  • "uuid": "request uuid",
  • "message": "some error message"
}

Get document in Base64 format

Downloads file in Base64 format using document ID and document version

path Parameters
id
required
string

Document id from archive service

query Parameters
version
string

Document version

Responses

Response samples

Content type
application/json
{
  • "fileName": "string",
  • "content": "string",
  • "contentType": "string"
}

Delete document

Delete document by document ID

path Parameters
id
required
string

Document id from archive service

Responses

Response samples

Content type
application/json
{
  • "deleted": true
}

document-search-controller

searchDocument

Request Body schema: application/json
required
documentType
string
limit
integer <int32>
object
object
returnAttributes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentType": "string",
  • "limit": 0,
  • "metaData": {
    • "property1": "string",
    • "property2": "string"
    },
  • "searchData": {
    • "property1": "string",
    • "property2": "string"
    },
  • "returnAttributes": [
    • "string"
    ]
}

searchDocumentReport

Create a new document

Request Body schema: application/json
required
documentType
string
limit
integer <int32>
object
object
returnAttributes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentType": "string",
  • "limit": 0,
  • "metaData": {
    • "property1": "string",
    • "property2": "string"
    },
  • "searchData": {
    • "property1": "string",
    • "property2": "string"
    },
  • "returnAttributes": [
    • "string"
    ]
}

external-auth-controller

getDocumentInfoById

Get authentication info

path Parameters
archiveName
required
string

Document from archive name

Request Body schema: application/json
required

User authentication request

username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

create-document-controller

createOrUpdateDocument

Create new or replace document

Request Body schema: multipart/form-data
required

Document data parameters

documentFilename
string
Example: "SWRENT-FAILURE-1.pdf"
fileName
string
objectName
string
Example: "SWRENT-FAILURE-1.pdf"
contentType
string
Example: "application/pdf"
fileContent
string
documentType
string
Example: "DMSSDoc"
documentPath
string
siteId
string
documentData
string
Example: "{}"

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "version_number": "string",
  • "dataUpdated": true,
  • "nameUpdated": true,
  • "externalid": "string",
  • "archiveName": "string"
}

findDocumentByName

Get document info from

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

createDocument

Create a new document

Request Body schema: multipart/form-data
required
object (DocumentData)
file
required
string <binary>

Attached file

Responses

Response samples

Content type
application/json
{
  • "id": "generated document uuid",
  • "externalid": "generated document external uuid",
  • "archiveName": "'OTCS_AWS' or 'FS-MAIN'"
}

createDocumentBase64

Create a new document

Request Body schema: application/json
required

Document data

documentFilename
string
Example: "SWRENT-FAILURE-1.pdf"
fileName
string
objectName
string
Example: "SWRENT-FAILURE-1.pdf"
contentType
string
Example: "application/pdf"
fileContent
string
documentType
string
Example: "DMSSDoc"
documentPath
string
siteId
string
documentData
string
Example: "{}"

Responses

Request samples

Content type
application/json
{
  • "documentFilename": "SWRENT-FAILURE-1.pdf",
  • "fileName": "string",
  • "objectName": "SWRENT-FAILURE-1.pdf",
  • "contentType": "application/pdf",
  • "fileContent": "string",
  • "documentType": "DMSSDoc",
  • "documentPath": "string",
  • "siteId": "string",
  • "documentData": "{}"
}

Response samples

Content type
application/json
{
  • "id": "generated document uuid",
  • "externalid": "generated document external uuid",
  • "archiveName": "'OTCS_AWS' or 'FS-MAIN'"
}

createDocumentBase64_1

Create a new document

Request Body schema: application/json
required

Document data

documentFilename
string
Example: "SWRENT-FAILURE-1.pdf"
fileName
string
objectName
string
Example: "SWRENT-FAILURE-1.pdf"
contentType
string
Example: "application/pdf"
fileContent
string
documentType
string
Example: "DMSSDoc"
documentPath
string
siteId
string
documentData
string
Example: "{}"

Responses

Request samples

Content type
application/json
{
  • "documentFilename": "SWRENT-FAILURE-1.pdf",
  • "fileName": "string",
  • "objectName": "SWRENT-FAILURE-1.pdf",
  • "contentType": "application/pdf",
  • "fileContent": "string",
  • "documentType": "DMSSDoc",
  • "documentPath": "string",
  • "siteId": "string",
  • "documentData": "{}"
}

Response samples

Content type
application/json
{
  • "id": "generated document uuid",
  • "externalid": "generated document external uuid",
  • "archiveName": "'OTCS_AWS' or 'FS-MAIN'"
}

ping-controller

sayPong

Responses

v-2-document-info-controller

getDocumentInfoById_1

Get document info from

path Parameters
documentId
required
string

Document id from archive service

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fileName": "string",
  • "fileSize": "string",
  • "fileType": "string",
  • "mimeType": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "versionNumber": "string",
  • "versionId": 0,
  • "documentType": "string",
  • "metaData": {
    • "property1": { },
    • "property2": { }
    },
  • "owner": "string"
}

getExtendedDocumentInfoById

Get document info from

path Parameters
documentId
required
string

Document id from archive service

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fileName": "string",
  • "fileSize": "string",
  • "fileType": "string",
  • "mimeType": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "versionNumber": "string",
  • "versionId": 0,
  • "documentType": "string",
  • "metaData": {
    • "property1": { },
    • "property2": { }
    },
  • "owner": "string"
}

synchronisation-controller

uploadDocumentVersion_1

Responses

document-info-controller

Get object info from archive

path Parameters
documentId
required
string

Document id from archive service

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "objectName": "string",
  • "mimeType": "string"
}

Get document metadata info

path Parameters
documentId
required
string

Document id from archive service

Responses

Response samples

Content type
application/json
{
  • "create_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "external_create_date": "2019-08-24T14:15:22Z",
  • "external_identity": "string",
  • "external_identity_type": "string",
  • "file_name": "string",
  • "file_size": "string",
  • "file_type": "string",
  • "id": "string",
  • "mime_type": "string",
  • "version_id": 0,
  • "version_number": "string",
  • "objectName": "string",
  • "name": "string"
}

Get document from archive

path Parameters
documentId
required
string

Document id from archive service

Responses

Response samples

Content type
application/json
{
  • "archiveId": 0,
  • "archiveName": "string",
  • "documentType": "string",
  • "callBackUrl": "string"
}

archive-service-info-controller

Get document type categories

Responses

archive-request-controller

Get document with ID and Version

Downloads file

path Parameters
requestname
required
string
query Parameters
required
object (MultiValueMapStringString)

Responses