PDF
Download PDF
Download page Document Management APIs.
Document Management APIs
{
"openapi": "3.0.1",
"info": {
"title": "",
"version": "v1"
},
"servers": [
{
"url": "https://{baseURL}"
}
],
"paths": {
"/api/document-management/v1/documents": {
"post": {
"tags": [
"Documents"
],
"summary": "Upload documents",
"description": "Uploads multiple documents and returns a list of metadata for each document.",
"parameters": [
{
"name": "objectType",
"in": "query",
"description": "Type of object",
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "query",
"description": "Object ID",
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"description": "Description",
"schema": {
"type": "string"
}
},
{
"name": "checkoutBy",
"in": "query",
"description": "Checkedout by information",
"schema": {
"type": "string"
}
},
{
"name": "checkoutDate",
"in": "query",
"description": "Checkedout date",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"in": "query",
"description": "Tags available for documents",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
},
"customProperties": {
"type": "object",
"additionalProperties": { }
}
}
},
"encoding": {
"files": {
"style": "form"
},
"customProperties": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataListAPIResponse"
},
"example": {"Success":true,"Data":[{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"bfe4f4ee-9b4b-4734-b0bf-785021c8b011","DocumentId":"e7d1ce61-69bc-4360-bb4a-3f8670585839","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"84b89368-34e8-4c95-9a69-be4d170e8214","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.396822+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.3968237+00:00","ExternalId":null,"ETag":null}]}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Documents"
],
"summary": "Delete multiple documents",
"description": "Deletes multiple documents and returns the status of the request.",
"requestBody": {
"description": "List of document IDs",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":{"IsDeleted":true,"Message":"4bcfc757-eaa0-47da-9385-02dc5dd1d812,503fb770-eeea-47ec-922d-7ab11ca2c377 deleted successfully."}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/upload": {
"post": {
"tags": [
"Documents"
],
"summary": "Upload a single document",
"description": "Uploads a single document and returns the document's metadata.",
"parameters": [
{
"name": "objectType",
"in": "query",
"description": "Type of the object",
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "query",
"description": "Object ID",
"schema": {
"type": "string"
}
},
{
"name": "newVersionId",
"in": "query",
"description": "ID of the new document version",
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"description": "Description",
"schema": {
"type": "string"
}
},
{
"name": "checkoutBy",
"in": "query",
"description": "Checkedout by details",
"schema": {
"type": "string"
}
},
{
"name": "checkoutDate",
"in": "query",
"description": "Checkedout date",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"in": "query",
"description": "Tags available for the document",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "documentId",
"in": "query",
"description": "Document Id",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"customProperties": {
"type": "object",
"additionalProperties": { }
}
}
},
"encoding": {
"file": {
"style": "form"
},
"customProperties": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"b72fd42b-a4eb-4e50-b99f-6ff2951705a5","DocumentId":"cdc064ea-5be9-4088-ba3e-5f3893921abb","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"3cb7f212-af59-47ee-842d-85c1a9001342","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.401294+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4012955+00:00","ExternalId":null,"ETag":null}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/multipart-uploads": {
"post": {
"tags": [
"Documents"
],
"summary": "Initiate a multipart upload",
"description": "Initiates multipart upload and returns the upload ID, key, and document metadata.",
"requestBody": {
"description": "Document request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DocumentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DocumentRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitMultipartUploadResponseAPIResponse"
},
"example": {"Success":true,"Data":{"UploadId":"7162","Key":"1465","Metadata":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"4e6a0dbe-ef13-414a-9562-a3d745eb24ad","DocumentId":"884de371-e80f-461b-ace4-1f03136898d5","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"01f63b3d-496a-4e49-bf22-4eb80f897edf","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4043447+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4043461+00:00","ExternalId":null,"ETag":null}}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/{documentId}/multipart-uploads": {
"put": {
"tags": [
"Documents"
],
"summary": "Upload a single part of a large file",
"description": "Uploads a single part of a large file and returns the Etag and part number.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The key that identifies the file location. It is defined in the multipart initiate response.",
"schema": {
"type": "string"
}
},
{
"name": "uploadId",
"in": "query",
"description": "Upload ID. It is defined in the multipart initiate response.",
"schema": {
"type": "string"
}
},
{
"name": "partNumber",
"in": "query",
"description": "A part number uniquely identifies a part and its position in the object you are uploading.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadPartResponseAPIResponse"
},
"example": {"Success":true,"Data":{"ETag":"16562","PartNumber":1}}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"post": {
"tags": [
"Documents"
],
"summary": "Complete multipart upload",
"description": "Completes multipart upload by combining single uploaded parts and returns the status of the request.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Multipart upload data request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteMultipartUploadRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CompleteMultipartUploadRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CompleteMultipartUploadRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Multipart upload completed successfully"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Documents"
],
"summary": "Abort an incomplete multipart upload and deletes the associated metadata and version",
"description": "Aborts an incomplete multipart upload, deletes the metadata and version associated with it, and returns the status of the request.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Multipart upload data request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultipartUploadRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MultipartUploadRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MultipartUploadRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"Multipart upload aborted successfully"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/{documentId}": {
"put": {
"tags": [
"Documents"
],
"summary": "Update a document",
"description": "Updates a document and returns the updated document's metadata.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "newVersionId",
"in": "query",
"description": "ID of the new document version",
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"description": "Description",
"schema": {
"type": "string"
}
},
{
"name": "checkoutBy",
"in": "query",
"description": "Checkedout by details",
"schema": {
"type": "string"
}
},
{
"name": "checkoutDate",
"in": "query",
"description": "Checkedout date",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"customProperties": {
"type": "object",
"additionalProperties": { }
}
}
},
"encoding": {
"file": {
"style": "form"
},
"customProperties": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"b3aaf27a-f365-48ae-ace5-f5446b056cd0","DocumentId":"e017a8b5-0b64-4c0d-8d6b-827cd2a7c7bd","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"4d92f2ee-4741-4373-9e5c-ca448fd1b232","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4119359+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4119374+00:00","ExternalId":null,"ETag":null}}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Documents"
],
"summary": "Delete a document",
"description": "Deletes a document and returns the status of the request.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":{"IsDeleted":true,"Message":"242616e3-64bd-43e4-b650-e8b2b92ebbd7 deleted successfully."}}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve a document by ID",
"description": "Retrieves a document using ID as an input.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponseAPIResponse"
},
"example": {"Success":true,"Data":{"DocumentMetadata":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"8325b16c-2722-421e-b342-e1c5ef1ba1b7","DocumentId":"00eceb90-7529-44ce-ba1a-61a2cee8cf48","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"3947e0a8-7da8-4f70-90e8-e02b26cfd35d","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4151651+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4151674+00:00","ExternalId":null,"ETag":null},"BlobData":"UEFO"}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/{documentId}/metadata": {
"put": {
"tags": [
"Documents"
],
"summary": "Update the document metadata information for all versions",
"description": "Updates the document metadata information for all versions and returns the status of the request.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Metadata of the document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve the metadata of the document",
"description": "Retrieves the document metadata by passing a document ID as an input.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"92238957-cdb1-4b54-91a2-8a5b5cd16b41","DocumentId":"46cf3324-a882-4939-90da-7eceef23da66","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"2d12c4f3-5dca-45d1-aff3-a6e83bcd7918","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4182017+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4182032+00:00","ExternalId":null,"ETag":null}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/{documentId}/download": {
"get": {
"tags": [
"Documents"
],
"summary": "Download a document by ID",
"description": "Downloads a document by passing a ID as an input.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Id not provided."
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/bulk": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve multiple documents",
"description": "Retrieves multiple documents by passing a list of IDs as input.",
"parameters": [
{
"name": "documentId",
"in": "query",
"description": "List of string values of the documentIds",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponseListAPIResponse"
},
"example": {"Success":true,"Data":[{"DocumentMetadata":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"003d9994-2650-44e5-899f-d99eb23272ed","DocumentId":"dc8697fc-e3a9-450b-9315-f2c1e1ba02fd","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"5022cf02-31cf-42e7-864c-f72d64e4d149","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4210259+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4210273+00:00","ExternalId":null,"ETag":null},"BlobData":"UEFO"}]}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/objects/{objectType}/{objectId}": {
"delete": {
"tags": [
"Documents"
],
"summary": "Delete documents by object ID",
"description": "Deletes documents by passing the object type and object ID as inputs.",
"parameters": [
{
"name": "objectType",
"in": "path",
"description": "Type of the object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "path",
"description": "Object ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":{"IsDeleted":true,"Message":"Documents associated to 81c1fd34-f68a-4c54-abea-4d7b14daf1f9 are deleted successfully."}}
}
}
}
}
},
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve documents by object ID",
"description": "Retrieves documents by passing the object type and object ID as inputs",
"parameters": [
{
"name": "objectId",
"in": "path",
"description": "Object ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectType",
"in": "path",
"description": "Type of the object",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponseListAPIResponse"
},
"example": {"Success":true,"Data":[{"DocumentMetadata":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"2c18f7e8-7fed-4f90-95e0-a934eda76572","DocumentId":"32cdbe9c-8213-4f08-82d2-ed6298f6a3b8","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"657b2e6a-2ba8-4386-82a9-f42031fee39f","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4236466+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.423648+00:00","ExternalId":null,"ETag":null},"BlobData":"UEFO"}]}
}
}
}
}
}
},
"/api/document-management/v1/documents/objects/{objectType}/{objectId}/versions": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document version details by object ID",
"description": "Retrieves document version details by passing the object type and object ID as inputs.",
"parameters": [
{
"name": "objectId",
"in": "path",
"description": "Object ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "objectType",
"in": "path",
"description": "Type of the object",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataListAPIResponse"
},
"example": {"Success":true,"Data":[{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"f01dcbc0-c716-4666-87bf-527ad240957f","DocumentId":"259dbba9-607d-4eeb-b2d7-f5602a0d2609","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"bc4872d6-9b8a-4fa1-9283-079f93abe173","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4249619+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4249633+00:00","ExternalId":null,"ETag":null}]}
}
}
}
}
}
},
"/api/document-management/v1/documents/{documentId}/clone": {
"post": {
"tags": [
"Documents"
],
"summary": "Clone a document",
"description": "Takes a document ID as an input and clones the document.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"514b4d58-45c3-44a1-a947-49230a382bc5","DocumentId":"58481e0c-4fc8-4d1a-a51d-c8a43d8348b7","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"3306f878-cd62-40b4-9715-b07ed911adf8","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4262003+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4262017+00:00","ExternalId":null,"ETag":null}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/{documentId}/exists": {
"get": {
"tags": [
"Documents"
],
"summary": "Check whether the document exists or not",
"description": "Takes a document ID as an input and checks whether the document exists or not.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success"
}
}
}
},
"/api/document-management/v1/documents/{documentId}/versions": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document versions",
"description": "Retrieves document versions by passing a document ID as an input.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataListAPIResponse"
},
"example": {"Success":true,"Data":[{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"5ddd6f1c-22cb-4479-9976-5240ade99fe5","DocumentId":"d4cd75c9-d37e-489c-8f6e-cd78d133ad17","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"47ceed97-0e83-4d2a-9b2a-66fbbf8e0ad6","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4282321+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4282336+00:00","ExternalId":null,"ETag":null}]}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/{documentId}/versions/{versionId}": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve a specific document version",
"description": "Takes the document ID and version ID as inputs and retrieves specific document version.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionId",
"in": "path",
"description": "Document version ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponseAPIResponse"
},
"example": {"Success":true,"Data":{"DocumentMetadata":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"aa2f4ef2-7fe1-4321-a973-62cb33fdea06","DocumentId":"c90343b1-cfbf-4de4-8c9a-1861d879d737","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"2c521266-e6ed-4850-854d-3f3dc870d849","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4295748+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4295763+00:00","ExternalId":null,"ETag":null},"BlobData":"UEFO"}}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Documents"
],
"summary": "Delete a document version",
"description": "Deletes a document version by passing the document ID and version ID as inputs.",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionId",
"in": "path",
"description": "Document version ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":{"IsDeleted":true,"Message":"c706b1e1-a1ac-45db-83a8-0a0182bf3b3d deleted successfully."}}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/document-management/v1/documents/search": {
"post": {
"tags": [
"Documents"
],
"summary": "Search documents",
"description": "Takes a document query as an input and returns all document metadata that meet the condition.",
"parameters": [
{
"name": "includeTotalCount",
"in": "query",
"description": "Optional parameter for specifying whether the total record count should be included in the response.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "Query parameters for document searching.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DocumentQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DocumentQuery"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentMetadataListAPIResponse"
},
"example": {"Success":true,"Data":[{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"f808831e-6f60-4eb2-aa41-90aa10d2d19b","DocumentId":"0e83debe-502f-4688-9073-db697e73ea81","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"a5b70a11-cecd-4138-9ae1-dd7579f4a611","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4328425+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.432844+00:00","ExternalId":null,"ETag":null}]}
}
}
}
}
}
},
"/api/document-management/v1/documents/objects/{objectId}": {
"get": {
"tags": [
"Documents"
],
"summary": "Get documents by object ID and file type",
"description": "Retrieves documents by passing file type and object ID as inputs.",
"parameters": [
{
"name": "objectId",
"in": "path",
"description": "Object ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileType",
"in": "query",
"description": "Type of the file",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"OrganizationFriendlyId is not defined."}],"StatusCode":"OK"}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponseListAPIResponse"
},
"example": {"Success":true,"Data":[{"DocumentMetadata":{"Description":"Desc","Extension":".txt","Tags":"","ObjectType":"Agreement","ObjectId":"4f0de398-abe7-4017-ab8b-b32820a79431","DocumentId":"3c7a40d4-3763-4331-a2da-d3efa00afd64","DocumentVersion":1,"IsDeleted":false,"CheckoutBy":"","CheckoutDate":"2022-01-01T00:00:00","FileSize":100,"FileType":"text/plain","IsLatest":true,"Id":"30217e47-7c83-485e-ae5a-a9baa4622912","Name":"Doc1.txt","CreatedBy":{"Id":"","Name":""},"CreatedDate":"2023-09-29T12:06:15.4342787+00:00","ModifiedBy":{"Id":"","Name":""},"ModifiedDate":"2023-09-29T12:06:15.4342801+00:00","ExternalId":null,"ETag":null},"BlobData":"UEFO"}]}
}
}
}
}
}
}
},
"components": {
"schemas": {
"CompleteMultipartUploadRequest": {
"type": "object",
"properties": {
"DocumentId": {
"type": "string",
"description": "A unique identifier of the document",
"nullable": true
},
"Key": {
"type": "string",
"description": "Multipart upload key",
"nullable": true
},
"UploadId": {
"type": "string",
"description": "Upload request identifier",
"nullable": true
},
"ETags": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "A collection of unique identifiers (entity tags).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Complete multipart upload request"
},
"DocumentMetadata": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"ETag": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Extension": {
"type": "string",
"description": "File Extension **For example :** .doc, .docx, .pdf etc",
"nullable": true
},
"Tags": {
"type": "string",
"description": "Additioal information about document",
"nullable": true
},
"ObjectType": {
"type": "string",
"description": "Object type for uploading/storing document **For example :** Agreement",
"nullable": true
},
"ObjectId": {
"type": "string",
"description": "A unique identifier of the object for which the document is stored",
"nullable": true
},
"DocumentId": {
"type": "string",
"description": "A unique identifier of the document",
"nullable": true
},
"DocumentVersion": {
"type": "integer",
"description": "Version number",
"format": "int32"
},
"IsDeleted": {
"type": "boolean",
"description": "Document deleted flag"
},
"CheckoutBy": {
"type": "string",
"description": "Checkout by",
"nullable": true
},
"CheckoutDate": {
"type": "string",
"description": "Checkout date",
"format": "date-time"
},
"FileSize": {
"type": "integer",
"description": "Document file size",
"format": "int64"
},
"FileType": {
"type": "string",
"description": "Document file type **For example :** txt/plain",
"nullable": true
},
"IsLatest": {
"type": "boolean",
"description": "Is latest document flag"
}
},
"additionalProperties": { },
"description": "Document metadata"
},
"DocumentMetadataAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentMetadataListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentMetadataUpdateRequest": {
"type": "object",
"properties": {
"CheckoutBy": {
"type": "string",
"description": "Checkout by",
"nullable": true
},
"CheckoutDate": {
"type": "string",
"description": "Checkout date",
"format": "date-time",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description for document",
"nullable": true
},
"CustomProperties": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "Document specific additional properties **For instance :* {Property Name, Property Value}",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional information about document",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request to update metadata/schema information of the document"
},
"DocumentQuery": {
"type": "object",
"properties": {
"Criteria": {
"type": "string",
"description": "Criteria based on which documents will be fetched",
"nullable": true
},
"Limit": {
"type": "integer",
"description": "Number of documents to be fetched",
"format": "int32",
"nullable": true
},
"Skip": {
"type": "integer",
"description": "Number of documents to be skipped",
"format": "int32",
"nullable": true
},
"Sort": {
"$ref": "#/components/schemas/Sort"
}
},
"additionalProperties": false
},
"DocumentRequest": {
"type": "object",
"properties": {
"DocumentName": {
"type": "string",
"description": "Document name",
"nullable": true
},
"ObjectType": {
"type": "string",
"description": "Object type for uploading/storing document **For example :** Agreement",
"nullable": true
},
"ObjectId": {
"type": "string",
"description": "A unique identifier of the object",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additioal information about document",
"nullable": true
},
"Description": {
"type": "string",
"description": "Document description",
"nullable": true
},
"CheckoutBy": {
"type": "string",
"description": "Checkout by",
"nullable": true
},
"CheckoutDate": {
"type": "string",
"description": "Checkout Date",
"format": "date-time",
"nullable": true
},
"NewVersionId": {
"type": "string",
"description": "New version Id for document",
"nullable": true
},
"CustomProperties": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "Document specific additional properties **For instance :* {Property Name, Property Value}",
"nullable": true
},
"DocumentId": {
"type": "string",
"description": "A unique identifier of the document",
"nullable": true
}
},
"additionalProperties": false,
"description": "Schema for document"
},
"DocumentResponse": {
"type": "object",
"properties": {
"DocumentMetadata": {
"$ref": "#/components/schemas/DocumentMetadata"
},
"BlobData": {
"type": "string",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentResponseAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/DocumentResponse"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentResponseListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ErrorDetail": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HttpStatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"Processing",
"EarlyHints",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultiStatus",
"AlreadyReported",
"IMUsed",
"MultipleChoices",
"MovedPermanently",
"Found",
"SeeOther",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"PermanentRedirect",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"MisdirectedRequest",
"UnprocessableEntity",
"Locked",
"FailedDependency",
"UpgradeRequired",
"PreconditionRequired",
"TooManyRequests",
"RequestHeaderFieldsTooLarge",
"UnavailableForLegalReasons",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported",
"VariantAlsoNegotiates",
"InsufficientStorage",
"LoopDetected",
"NotExtended",
"NetworkAuthenticationRequired"
],
"type": "string"
},
"InitMultipartUploadResponse": {
"type": "object",
"properties": {
"UploadId": {
"type": "string",
"description": "A unique identfier used for consecutive request for multipart upload.",
"nullable": true
},
"Key": {
"type": "string",
"description": "Storage document key",
"nullable": true
},
"Metadata": {
"$ref": "#/components/schemas/DocumentMetadata"
}
},
"additionalProperties": false,
"description": "Init multipart upload response"
},
"InitMultipartUploadResponseAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/InitMultipartUploadResponse"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"LookupObject": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MultipartUploadRequest": {
"type": "object",
"properties": {
"DocumentId": {
"type": "string",
"description": "A unique identifier of the document",
"nullable": true
},
"Key": {
"type": "string",
"description": "Multipart upload key",
"nullable": true
},
"UploadId": {
"type": "string",
"description": "Upload request identifier",
"nullable": true
}
},
"additionalProperties": false,
"description": "Multipart uplaod request"
},
"OrderBy": {
"enum": [
"Ascending",
"Descending"
],
"type": "string"
},
"Sort": {
"type": "object",
"properties": {
"FieldName": {
"type": "string",
"nullable": true
},
"OrderBy": {
"$ref": "#/components/schemas/OrderBy"
}
},
"additionalProperties": false
},
"StringAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "string",
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"UploadPartResponse": {
"type": "object",
"properties": {
"ETag": {
"type": "string",
"description": "A unique identifier (entity tag)",
"nullable": true
},
"PartNumber": {
"type": "integer",
"description": "Part number",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Upload part response"
},
"UploadPartResponseAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/UploadPartResponse"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}