{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Document Management Command", "description": "Command API to manage the documents uploaded from FenX app. The documents can be linked with Entity Id, Journey Id and Document Requirement ", "version": "1.0" }, "servers": [ { "url": "/documentmanagementcommand" } ], "paths": { "/api/acceptabledocument/set": { "post": { "tags": [ "AcceptableDocument" ], "summary": "Create acceptable document set model", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateAcceptableDocumentSet", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Acceptable document set model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}": { "post": { "tags": [ "AcceptableDocument" ], "summary": "Create acceptable document set version by version number", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateAcceptableDocumentSetVersionByVersionNumber", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to be cloned", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Acceptable document set model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "put": { "tags": [ "AcceptableDocument" ], "summary": "Update acceptable document set version", "description": "\nUpdates an existing acceptable document set version. Only draft and rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "UpdateAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update requirement set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Acceptable Document set version updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable Document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "AcceptableDocument" ], "summary": "Delete acceptable document set version", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationDelete", "operationId": "DeleteAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Acceptable document set version deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}": { "post": { "tags": [ "AcceptableDocument" ], "summary": "Create acceptable document set version with given acceptable documents", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request body containing the acceptable document set version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Acceptable document set model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "AcceptableDocument" ], "summary": "Delete acceptable document set and all its versions", "description": "\nDeletes an existing acceptable document set and all its versions.

Required permissions:
Following permissions are required: DocumentConfigurationDelete", "operationId": "DeleteAcceptableDocumentSet", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Acceptable document set deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "AcceptableDocument" ], "summary": "Submit acceptable document set version for approval", "description": "\nSubmits the selected version of an existing acceptable document set for approval.

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "SubmitForApprovalAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to submit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Acceptable document set version submitted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}/sign": { "put": { "tags": [ "AcceptableDocument" ], "summary": "Sign acceptable document set version", "description": "\nSigns the selected version of an existing acceptable document set and changes the version status accordingly to the action (Approve/Reject).

Required permissions:
Following permissions are required: DocumentConfigurationApprove", "operationId": "SignAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to sign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Sign acceptable document set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success.Acceptable document set version signed" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}/archive": { "put": { "tags": [ "AcceptableDocument" ], "summary": "Archive acceptable document set version", "description": "\nArchives the selected version of an existing acceptable document set.

Required permissions:
Following permissions are required: DocumentConfigurationArchive", "operationId": "ArchiveAcceptableDocumentSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to archive", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Acceptable document set version archived" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument": { "post": { "tags": [ "AcceptableDocument" ], "summary": "Create acceptable document model", "description": "\nThis method will create a new acceptable document model\r\n\nThe model will initialize with the DTO data of \"Type\", \"Description\", and \"DataKey\"

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateAcceptableDocument", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number where the acceptable document will be added", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the CreateAcceptableDocumentRequestDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Acceptable document model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Acceptable document set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument/{id}": { "put": { "tags": [ "AcceptableDocument" ], "summary": "Update an existing acceptable document model", "description": "\nThis method will update an existing acceptable document model

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "UpdateAcceptableDocument", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number where the acceptable document to be updated lives", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "The id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the updated data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Acceptable document model updated successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Acceptable document model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "AcceptableDocument" ], "summary": "Delete an existing acceptable document model", "description": "\nThis method will delete an existing acceptable document model

Required permissions:
Following permissions are required: DocumentConfigurationDelete", "operationId": "DeleteAcceptableDocument", "parameters": [ { "name": "setId", "in": "path", "description": "Acceptable document set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number where the acceptable document to be deleted lives", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "The id of the existing model to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Acceptable document model deleted successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Acceptable document model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement": { "post": { "tags": [ "DocumentModel" ], "summary": "Upload a document", "description": "\nThis method will upload the file in the AWS S3 bucket and publish an event to store the metadata related with the document.\r\n\nThe method will return an object with some basic information to show the result to the user in the UI like status, \r\n document requirement and document type. The Id as well can be used in the query api to get the URL signed to show the document.

Required permissions:
Following permissions are required: DocumentManagementCreate", "operationId": "UploadDocumentModel", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Data.EntityId", "Data.File" ], "type": "object", "properties": { "Data.File": { "type": "string", "description": "File to be saved in the S3 storage", "format": "binary" }, "Data.EntityId": { "type": "string", "description": "Entity Id from FenX to link the document with the entity", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "Data.JourneyId": { "type": "string", "description": "Journey Id from FenX to link the document with the journey", "example": "61413fc2-0381-48f5-825b-225692f4d793" }, "Data.DocumentType": { "type": "string", "description": "The type of the document", "example": "Driver license" }, "Data.FriendlyName": { "type": "string", "description": "The friendly name of the document" }, "Data.DocumentRequirementIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Hash Set of Document Requirement Ids from FenX to link the document to document requirements" }, "Data.DocumentDataKey": { "type": "string", "description": "The unique identifier of the document requirement that the document is linked to", "example": "identificationDocuments" }, "Data.Properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Custom document properties.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } } }, "encoding": { "Data.File": { "style": "form" }, "Data.EntityId": { "style": "form" }, "Data.JourneyId": { "style": "form" }, "Data.DocumentType": { "style": "form" }, "Data.FriendlyName": { "style": "form" }, "Data.DocumentRequirementIds": { "style": "form" }, "Data.DocumentDataKey": { "style": "form" }, "Data.Properties": { "style": "form" } } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.UploadDocumentResponseDto class with some metadata that represent the file uploaded", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadDocumentResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadDocumentResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadDocumentResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/{id}": { "put": { "tags": [ "DocumentModel" ], "summary": "Updates a document", "description": "\nThis method will update an existing Document Model with the data contained in the request Dto

Required permissions:
Following permissions are required: DocumentManagementEdit", "operationId": "UpdateDocument", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The update document request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Document Model updated successfully" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "DocumentModel" ], "summary": "Delete a document model", "description": "Deletes the document model in the database, if the associated physical file is linked to multiple models it will remain in s3.\r\nOn deletion of the last document model the physical file in s3 will also be removed.

Required permissions:
Following permissions are required: DocumentManagementDelete", "operationId": "DeleteDocumentModel", "parameters": [ { "name": "id", "in": "path", "description": "The id of the document existing", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Document deleted successfully" }, "400": { "description": "Document not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/{id}/requirement-ids": { "put": { "tags": [ "DocumentModel" ], "summary": "Update the requirements linked to a document", "description": "\nThis method will update the Document Requirement Ids linked to an existing Document Model

Required permissions:
At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete", "operationId": "UpdateRequirementIds", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The list of requirements to update the document model with", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } }, "responses": { "202": { "description": "Document Model updated successfully" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentmanagement/updateFile": { "put": { "tags": [ "DocumentModel" ], "summary": "Update a document", "description": "\nThis method will generate an URL signed to upload the stream to update an existing Document File in the S3 bucket.

Required permissions:
At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementCreate", "operationId": "UpdateDocumentFile", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Data.File", "Data.Id" ], "type": "object", "properties": { "Data.Id": { "type": "string", "description": "Id of the document", "example": "e8854547-40af-478f-8013-cd10c13e7f94" }, "Data.File": { "type": "string", "description": "File to be saved in the S3 storage", "format": "binary" } } }, "encoding": { "Data.Id": { "style": "form" }, "Data.File": { "style": "form" } } } } }, "responses": { "202": { "description": "Document Model updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentFileResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "deprecated": true } }, "/api/documentmanagement/{id}/datakey": { "put": { "tags": [ "DocumentModel" ], "summary": "Update the requirement datakey linked to a document", "description": "\nThis method will update the Document Requirement Ids linked to an existing Document Model

Required permissions:
At least one of the following permissions is required: DocumentManagementEdit, DocumentManagementDelete", "operationId": "UpdateDataKey", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The datakey of requirement to update the document model with", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "202": { "description": "Document Model updated successfully" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement": { "post": { "tags": [ "DocumentRequirement" ], "summary": "Creates a new DocumentRequirement.", "description": "\nThis method will create a new DocumentRequirement model.

Required permissions:
Following permissions are required: DocumentManagementCreate", "operationId": "CreateDocumentRequirement", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the DocumentRequirement to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "DocumentRequirementDto model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRequirementResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRequirementResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/{id}": { "put": { "tags": [ "DocumentRequirement" ], "summary": "Updates an existing DocumentRequirement", "description": "

Required permissions:
At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementApprove, DocumentManagementDeferOrWaive", "operationId": "UpdateDocumentRequirement", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the DocumentRequirement to update", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "DocumentRequirement Model updated successfully" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirement/{id}/properties": { "put": { "tags": [ "DocumentRequirement" ], "summary": "Updates the existing properties on a DocumentRequirement", "description": "

Required permissions:
At least one of the following permissions is required: DocumentManagementEdit", "operationId": "UpdateDocumentRequirementProperties", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the DocumentRequirement to update", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "DocumentRequirement Model properties updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. DocumentRequirementModel with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set": { "post": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Create a document requirement metadata set model", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateDocumentRequirementMetadataSet", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Document Requirement Metadata set model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}": { "post": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Create document requirement metadata set version by version number", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateDocumentRequirementMetadataSetVersionByVersionNumber", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to be cloned", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Document Requirement Metadata set model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "put": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Update document requirement metadata set version", "description": "\nUpdates an existing document requirement metadata set version. Only draft and rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "UpdateDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update requirement set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Document Requirement Metadata set version updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Delete document requirement metadata set version", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationDelete", "operationId": "DeleteDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Document Requirement Metadata set version deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}": { "post": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Create document requirement metadata set version with given document requirement metadata", "description": "

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request body containing the document requirement metadata set version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Document Requirement Metadata set model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Delete document requirement metadata set and all its versions", "description": "\nDeletes an existing document requirement metadata set and all its versions.

Required permissions:
Following permissions are required: DocumentConfigurationDelete", "operationId": "DeleteDocumentRequirementMetadataSet", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Document Requirement Metadata set deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Submit document requirement metadata set version for approval", "description": "\nSubmits the selected version of an existing document requirement metadata set for approval.

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "SubmitForApprovalDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to submit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Document Requirement Metadata set version submitted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/sign": { "put": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Sign document requirement metadata set version", "description": "\nSigns the selected version of an existing document requirement metadata set and changes the version status accordingly to the action (Approve/Reject).

Required permissions:
Following permissions are required: DocumentConfigurationApprove", "operationId": "SignDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to sign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Sign document requirement metadata set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success.Document Requirement Metadata set version signed" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/archive": { "put": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Archive document requirement metadata set version", "description": "\nArchives the selected version of an existing document requirement metadata set.

Required permissions:
Following permissions are required: DocumentConfigurationArchive", "operationId": "ArchiveDocumentRequirementMetadataSetVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to archive", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Document Requirement Metadata set version archived" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata": { "post": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Create document requirement metadata model", "description": "\nThis method will create a new document requirement metadata model\r\n\nThe model will initialize with the DTO data of \"Name\", \"DatabaseFieldName\", and \"Type\"

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "CreateDocumentRequirementMetadata", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number where the document requirement metadata will be added", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the CreateDocumentRequirementMetadataRequestDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Document Requirement Metadata model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document Requirement Metadata set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata/{id}": { "put": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Update an existing document requirement metadata model", "description": "\nThis method will update an existing document requirement metadata model

Required permissions:
Following permissions are required: DocumentConfigurationEdit", "operationId": "UpdateDocumentRequirementMetadata", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number where the document requirement metadata to be updated lives", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "The id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the updated data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Document Requirement Metadata model updated successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Document Requirement Metadata model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "DocumentRequirementMetadata" ], "summary": "Delete an existing document requirement metadata model", "description": "\nThis method will delete an existing document requirement metadata model

Required permissions:
Following permissions are required: DocumentConfigurationDelete", "operationId": "DeleteDocumentRequirementMetadata", "parameters": [ { "name": "setId", "in": "path", "description": "Document Requirement Metadata set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number where the document requirement metadata to be deleted lives", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "The id of the existing model to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Document Requirement Metadata model deleted successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Document Requirement Metadata model not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignature": { "post": { "tags": [ "ESignature" ], "summary": "Sends a request with documents to external provider for eSignature.", "description": "\nThis method will send documents to external provider for eSignature

Required permissions:
Following permissions are required: DocumentManagementSendForSignature", "operationId": "SendDocumentsForSignature", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the documents and mandatory signers to send", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "DocumentSignatureResponseDto model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentSignatureResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSignatureResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentSignatureResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignature/cancel": { "post": { "tags": [ "ESignature" ], "summary": "Voids existing eSignature and resets document requirement status.", "description": "

Required permissions:
Following permissions are required: DocumentManagementEdit", "operationId": "CancelESignature", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the documents and mandatory signers to send", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Signature cancelled", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Document Requirement not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignatureconfiguration/provider/{providerId}/status": { "put": { "tags": [ "ESignatureConfiguration" ], "summary": "Save Provider status", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "SaveProviderStatus", "parameters": [ { "name": "providerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BooleanServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BooleanServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BooleanServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignatureconfiguration/provider/{providerId}/configuration": { "put": { "tags": [ "ESignatureConfiguration" ], "summary": "Save Configuration", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "SaveProviderConfiguration", "parameters": [ { "name": "providerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Provider added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignatureconfiguration/provider/{providerId}/refreshLookups": { "put": { "tags": [ "ESignatureConfiguration" ], "summary": "Refresh IDV Provider List", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "refreshLookups", "parameters": [ { "name": "providerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Provider added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturedocumentrequirement": { "post": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Creates a new eSignatureDocumentRequirement.", "description": "\nThis method will create a new eSignatureDocumentRequirement model.

Required permissions:
Following permissions are required: DocumentManagementCreate", "operationId": "CreateESignatureDocumentRequirement", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the DocumentRequirement to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "DocumentRequirementDto model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureDocumentRequirementResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturedocumentrequirement/{id}": { "put": { "tags": [ "ESignatureDocumentRequirement" ], "summary": "Updates an existing eSignatureDocumentRequirement", "description": "

Required permissions:
At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementApprove, DocumentManagementDeferOrWaive", "operationId": "UpdateESignatureDocumentRequirement", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the DocumentRequirement to update", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateESignatureDocumentRequirementDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateESignatureDocumentRequirementDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateESignatureDocumentRequirementDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "DocumentRequirement Model updated successfully" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/esignaturetypeconfiguration": { "put": { "tags": [ "ESignatureTypeConfiguration" ], "summary": "Save eSignature Type Configuration", "description": "

Required permissions:
Following permissions are required: ESignatureConfigurationAccess", "operationId": "SaveSignatureTypeConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ESignatureTypeConfigurationRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Type configuration added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ESignatureTypeConfigurationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/temporarydocumentmanagement": { "post": { "tags": [ "TemporaryDocumentModel" ], "summary": "Save temporary document metadata and generate the URL to upload the file for multiple Document Requirements", "description": "\nThis method will create temporary document model metadata and generate a signed URL to allow \r\n the user to upload temporary file directly in the AWS S3 bucket. When multiple document Requirements need to be fulfilled\r\n\n\r\n Important: The returned `SignedUrlToUpload` is a presigned S3 URL that includes the\r\n `x-amz-tagging` header in its signature. When uploading the file via HTTP PUT to this URL, the caller\r\n must include the following header exactly as shown:\r\n```x-amz-tagging: TTL=enabled```\r\n\nOmitting this header or providing a different value will result in a `403 SignatureDoesNotMatch` error\r\n from S3, because the header is part of the presigned URL's HMAC signature.

Required permissions:
At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementEdit", "operationId": "CreateTemporaryDocumentMultipleRequirements", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The upload multiple document requirements request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSignedUrlToUploadTemporaryFileMultipleRequirementsRequestServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSignedUrlToUploadTemporaryFileMultipleRequirementsRequestServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSignedUrlToUploadTemporaryFileMultipleRequirementsRequestServiceRequest" } ] } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.DocumentManagement.Command.Application.DTO.CreateSignedUrlToUploadFileMultipleRequirementsResponse class with some metadata that represent the files uploaded", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. Document model or Document Requirement model with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AcceptableDocumentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the acceptable document", "format": "uuid", "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" }, "type": { "type": "string", "description": "The type of the acceptable document", "nullable": true, "example": "A recent utility bill" }, "description": { "type": "string", "description": "The description of the acceptable document", "nullable": true, "example": "A utility bill that has been issued in the last 6 months" }, "dataKey": { "type": "string", "description": "The datakey of the acceptable document", "nullable": true, "example": "utilityBill" }, "extractData": { "type": "boolean", "description": "The entity data will be extracted from the document", "example": true }, "extractRelatedParties": { "type": "boolean", "description": "The entity related parties data will be extracted from the document", "example": true }, "extractFromMostRecentVersionOnly": { "type": "boolean", "description": "When true, extraction runs only against the most recently uploaded version of this document type", "example": false }, "extractionCategories": { "type": "array", "items": { "type": "string" }, "description": "Policy Categories that will be used to extract data from the document", "nullable": true, "example": [ "Basic Details" ] } }, "additionalProperties": false }, "AcceptableDocumentDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentDto" } ], "nullable": true } }, "additionalProperties": false }, "AcceptableDocumentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AcceptableDocumentDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AccessLayerDto": { "type": "object", "properties": { "geographic": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers", "nullable": true, "example": [ "Global" ] }, "businessRelated": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers", "nullable": true, "example": [ "Enterprise" ] } }, "additionalProperties": false, "description": "DTO representing access layers attached" }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ApproveActionServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AssignmentCreatedDto": { "type": "object", "properties": { "sourceEntityId": { "type": "string", "description": "Entity Id from where documents will be sourced.", "format": "uuid", "example": "d9d626fa-e3d0-4809-be94-d712493e1c8e" }, "targetEntityId": { "type": "string", "description": "Entity Id where documents will be placed", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "documentId": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" } }, "additionalProperties": false, "description": "Dto representing single document assignment." }, "AssignmentDto": { "type": "object", "properties": { "targetEntityId": { "type": "string", "description": "Entity Id where documents will be placed", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "documentId": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" } }, "additionalProperties": false, "description": "Dto representing single document assignment." }, "AssignmentUpdatedDto": { "type": "object", "properties": { "sourceEntityId": { "type": "string", "description": "Entity Id from where documents will be sourced.", "format": "uuid", "example": "d9d626fa-e3d0-4809-be94-d712493e1c8e" }, "targetEntityId": { "type": "string", "description": "Entity Id where documents will be placed.", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "documentId": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" } }, "additionalProperties": false, "description": "Dto representing single document assignment." }, "AssociationSnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the existing Association", "format": "uuid", "example": "23aec85d-7015-458e-8fd8-1b04de244d9f" }, "sourceId": { "type": "string", "description": "The unique identifier of source Entity", "format": "uuid", "example": "05fe8079-5db7-4732-832c-addb614c37ff" }, "targetId": { "type": "string", "description": "The unique identifier of target Entity", "format": "uuid", "example": "05fe8079-5db7-4732-832c-addb614c37ff" }, "type": { "type": "string", "description": "Association type", "nullable": true, "example": "Shareholder" } }, "additionalProperties": false, "description": "Association snapshot" }, "BaseDocumentRequirementMetadataDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the property", "nullable": true, "example": "Pre-Status" }, "databaseFieldName": { "type": "string", "description": "The database field name of the property", "nullable": true, "example": "preStatus" }, "type": { "type": "string", "description": "The type of the property", "nullable": true, "example": "text" }, "lookup": { "type": "string", "description": "The Lookup name if the property type is a dropdown", "nullable": true, "example": "PreStatusList" }, "defaultValue": { "type": "string", "description": "The default value of the property", "nullable": true, "example": "Pending" }, "value": { "type": "string", "description": "The value of the property", "nullable": true, "example": "Approved" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to document requirement metadata field", "nullable": true } }, "additionalProperties": false }, "BaseDocumentRequirementMetadataDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BaseDocumentRequirementMetadataDto" } ], "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false }, "BooleanServiceRequest": { "type": "object", "properties": { "data": { "type": "boolean" } }, "additionalProperties": false }, "CreateAcceptableDocumentRequestDto": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the acceptable document", "nullable": true, "example": "A recent utility bill" }, "description": { "type": "string", "description": "The description of the acceptable document", "nullable": true, "example": "A utility bill that has been issued in the last 6 months" }, "dataKey": { "type": "string", "description": "The datakey of the acceptable document", "nullable": true, "example": "utilityBill" }, "extractData": { "type": "boolean", "description": "The entity data will be extracted from the document", "example": true }, "extractRelatedParties": { "type": "boolean", "description": "The entity related parties data will be extracted from the document", "example": true }, "extractFromMostRecentVersionOnly": { "type": "boolean", "description": "When true, extraction runs only against the most recently uploaded version of this document type", "example": false }, "extractionCategories": { "type": "array", "items": { "type": "string" }, "description": "Policy Categories that will be used to extract data from the document", "nullable": true, "example": [ "Basic Details" ] } }, "additionalProperties": false }, "CreateAcceptableDocumentRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "CreateAcceptableDocumentSetResponseDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the Acceptable Document Set that the version belongs to", "format": "uuid", "example": "3e1c5137-453a-48df-8d26-c70ee8059b4a" }, "versionNumber": { "type": "integer", "description": "The version number", "format": "int32", "example": 2 } }, "additionalProperties": false, "description": "Response DTO representing Acceptable Document Set Version data" }, "CreateAcceptableDocumentSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDto" } ], "description": "Response DTO representing Acceptable Document Set Version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateAcceptableDocumentSetVersionDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the acceptable document set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "acceptableDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/CreateAcceptableDocumentRequestDto" }, "description": "List of Acceptable Documents", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Request DTO representing set of properties which define a new version of AcceptableDocument set" }, "CreateAcceptableDocumentSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDto" } ], "description": "Request DTO representing set of properties which define a new version of AcceptableDocument set", "nullable": true } }, "additionalProperties": false }, "CreateDocReqMetadataResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the document requirement metadata", "format": "uuid", "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" } }, "additionalProperties": false, "description": "Response DTO representing Document Requirement Metadata Set Version data" }, "CreateDocReqMetadataResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDocReqMetadataResponseDto" } ], "description": "Response DTO representing Document Requirement Metadata Set Version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDocReqMetadataSetResponseDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the Document Requirement Metadata Set that the version belongs to", "format": "uuid", "example": "3e1c5137-453a-48df-8d26-c70ee8059b4a" }, "versionNumber": { "type": "integer", "description": "The version number", "format": "int32", "example": 2 } }, "additionalProperties": false, "description": "Response DTO representing Document Requirement Metadata Set Version data" }, "CreateDocReqMetadataSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDocReqMetadataSetResponseDto" } ], "description": "Response DTO representing Document Requirement Metadata Set Version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDocReqMetadataSetVersionDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the Document Requirement Metadata set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "documentRequirementMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/BaseDocumentRequirementMetadataDto" }, "description": "List of Document Requirement Metadata", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Request DTO representing set of properties which define a new version of DocumentRequirementMetadata set" }, "CreateDocReqMetadataSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDocReqMetadataSetVersionDto" } ], "description": "Request DTO representing set of properties which define a new version of DocumentRequirementMetadata set", "nullable": true } }, "additionalProperties": false }, "CreateDocumentAssignmentDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id containing documents", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "journeyId": { "type": "string", "description": "Journey Id where document assignment id performed.", "format": "uuid", "example": "fa4ae2af-eb80-410c-b0ce-b97be8cfbe5e" }, "taskId": { "type": "string", "description": "Task Id of document assignment", "format": "uuid", "example": "625cbe82-7f6b-4c3c-a159-ac8fbfe42e48" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentDto" }, "description": "Assignments for document from main entity", "nullable": true }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/SnapshotDto" } ], "description": "Current state of document, entities and associations.", "nullable": true } }, "additionalProperties": false, "description": "Dto representing model of document assignation. One document assignation per entity, journey and task." }, "CreateDocumentAssignmentDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateDocumentAssignmentDto" } ], "description": "Dto representing model of document assignation. One document assignation per entity, journey and task.", "nullable": true } }, "additionalProperties": false }, "CreateSignedUrlToUploadFileMultipleRequirementsResponse": { "type": "object", "properties": { "DocumentRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementBulkDto" }, "description": "List of Document Requirement properties that the document Models are linked to", "nullable": true }, "documentType": { "type": "string", "description": "The type of the document", "nullable": true, "example": "Driver license" }, "status": { "type": "string", "description": "The status of the uploaded document", "nullable": true, "example": "Complete" }, "signedUrlToUpload": { "type": "string", "description": "Presigned URL to upload the file into S3 bucket.\r\nWhen this response originates from the temporary document endpoint, the URL's signature includes\r\nthe `x-amz-tagging` header. The caller must include `x-amz-tagging: TTL=enabled` as an\r\nHTTP header in the PUT request, otherwise the upload will fail with a 403 error.", "nullable": true }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "List of warnings generated during document upload (e.g., DocuSign size limit warnings)", "nullable": true } }, "additionalProperties": false, "description": "Basic information from the upload document api for multiple requirements" }, "CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateSignedUrlToUploadFileMultipleRequirementsResponse" } ], "description": "Basic information from the upload document api for multiple requirements", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateSignedUrlToUploadTemporaryFileMultipleRequirementsRequest": { "required": [ "entityId", "fileName" ], "type": "object", "properties": { "fileName": { "minLength": 1, "type": "string", "description": "Original file name", "example": "passport.pdf" }, "entityId": { "minLength": 1, "type": "string", "description": "Entity Id from FenX to link the document with the entity", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id from FenX to link the document with the journey", "nullable": true, "example": "61413fc2-0381-48f5-825b-225692f4d793" }, "documentType": { "type": "string", "description": "The type of the document", "nullable": true, "example": "Driver license" }, "friendlyName": { "type": "string", "description": "The friendly name of the document", "nullable": true }, "documentRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequirementDto" }, "description": "List of Document Requirements to be fulfilled by this document", "nullable": true }, "isDocumentForESignature": { "type": "boolean", "description": "Is the document for eSignature", "nullable": true, "example": false }, "comesFromESignatureProvider": { "type": "boolean", "description": "Does document come from eSignature provider", "nullable": true, "example": false }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Custom document properties.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers", "nullable": true }, "policyEnforcedAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Access layers enforced by policy. The minimal set of access layers. The property is immutable", "nullable": true }, "fileSize": { "type": "integer", "description": "The size of the file in bytes. Used to validate DocuSign size limits for eSignature documents.", "format": "int64", "nullable": true, "example": 1048576 } }, "additionalProperties": false, "description": "Metadata needed to create Temporary Document models to fulfill multiple requirements and generate signed Url to upload file.\r\nContains all properties needed to fill the metadata of the document being uploaded." }, "CreateSignedUrlToUploadTemporaryFileMultipleRequirementsRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateSignedUrlToUploadTemporaryFileMultipleRequirementsRequest" } ], "description": "Metadata needed to create Temporary Document models to fulfill multiple requirements and generate signed Url to upload file.\r\nContains all properties needed to fill the metadata of the document being uploaded.", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minDate": { "type": "string", "description": "Minimum date", "format": "date-time", "nullable": true, "example": "2020-01-01T14:48:00.000Z" }, "maxDate": { "type": "string", "description": "Maximum date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DocumentAssignmentCreatedDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of document assignment.", "format": "uuid", "example": "44018bcd-a88c-45ae-9bd8-04087a1fef6d" }, "entityId": { "type": "string", "description": "Entity Id containing documents", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "journeyId": { "type": "string", "description": "Journey Id where document assignment id performed.", "format": "uuid", "example": "fa4ae2af-eb80-410c-b0ce-b97be8cfbe5e" }, "taskId": { "type": "string", "description": "Task Id of document assignment", "format": "uuid", "example": "625cbe82-7f6b-4c3c-a159-ac8fbfe42e48" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentCreatedDto" }, "description": "Assignments for document from main entity", "nullable": true }, "status": { "type": "string", "description": "Status of assignment.", "nullable": true, "example": "In Progress" }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/SnapshotDto" } ], "description": "Current state of document, entities and associations.", "nullable": true } }, "additionalProperties": false, "description": "Dto representing model of document assignation. One document assignation per entity, journey and task." }, "DocumentAssignmentCreatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentAssignmentCreatedDto" } ], "description": "Dto representing model of document assignation. One document assignation per entity, journey and task.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentAssignmentUpdatedDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of document assignment.", "format": "uuid", "example": "44018bcd-a88c-45ae-9bd8-04087a1fef6d" }, "entityId": { "type": "string", "description": "Entity Id containing documents", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "journeyId": { "type": "string", "description": "Journey Id where document assignment id performed.", "format": "uuid", "example": "fa4ae2af-eb80-410c-b0ce-b97be8cfbe5e" }, "taskId": { "type": "string", "description": "Task Id of document assignment", "format": "uuid", "example": "625cbe82-7f6b-4c3c-a159-ac8fbfe42e48" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentUpdatedDto" }, "description": "Assignments for document from main entity", "nullable": true }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/SnapshotDto" } ], "description": "Current state of document, entities and associations.", "nullable": true }, "status": { "type": "string", "description": "Status of assignment.", "nullable": true, "example": "In Progress" } }, "additionalProperties": false, "description": "Dto representing model of document assignation. One document assignation per entity, journey and task." }, "DocumentAssignmentUpdatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentAssignmentUpdatedDto" } ], "description": "Dto representing model of document assignation. One document assignation per entity, journey and task.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequirementBulkDto": { "type": "object", "properties": { "Id": { "type": "string", "description": "The Id of the requirement the document requirement belongs to", "format": "uuid", "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" }, "RequirementId": { "type": "string", "description": "Alternative JSON property name for RequirementId to support internal generic lambda client implementations.\r\nMaps to the same underlying value as RequirementId.", "format": "uuid" }, "DocumentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "DataKey": { "type": "string", "description": "Alternative JSON property name for DataKey to support internal generic lambda client implementations.\r\nMaps to the same underlying value as DataKey.", "nullable": true }, "Name": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "RequirementName": { "type": "string", "description": "Alternative JSON property name for RequirementName to support internal generic lambda client implementations.\r\nMaps to the same underlying value as RequirementName.", "nullable": true }, "IsMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "DocumentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Policy set access layers", "nullable": true }, "requirementModelId": { "type": "string", "description": "Id of the requirement aggregate model the document is linked to", "format": "uuid", "nullable": true, "example": "4719bcc0-9a73-46ea-9857-5fe5edb97d63" }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "DocumentId": { "type": "string", "description": "The Id of the document that is satisfying the requirement", "format": "uuid", "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" } }, "additionalProperties": false, "description": "Contains document requirement attributes set during the bulk upload for multiple requirements" }, "DocumentRequirementDto": { "type": "object", "properties": { "Id": { "type": "string", "description": "The Id of the requirement the document requirement belongs to", "format": "uuid", "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" }, "RequirementId": { "type": "string", "description": "Alternative JSON property name for RequirementId to support internal generic lambda client implementations.\r\nMaps to the same underlying value as RequirementId.", "format": "uuid" }, "DocumentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "DataKey": { "type": "string", "description": "Alternative JSON property name for DataKey to support internal generic lambda client implementations.\r\nMaps to the same underlying value as DataKey.", "nullable": true }, "Name": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "RequirementName": { "type": "string", "description": "Alternative JSON property name for RequirementName to support internal generic lambda client implementations.\r\nMaps to the same underlying value as RequirementName.", "nullable": true }, "IsMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "DocumentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Policy set access layers", "nullable": true }, "requirementModelId": { "type": "string", "description": "Id of the requirement aggregate model the document is linked to", "format": "uuid", "nullable": true, "example": "4719bcc0-9a73-46ea-9857-5fe5edb97d63" }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" } }, "additionalProperties": false, "description": "Contains document requirement attributes need to be deserialized as input of Initialize Lambda" }, "DocumentRequirementMetadataDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the property", "nullable": true, "example": "Pre-Status" }, "databaseFieldName": { "type": "string", "description": "The database field name of the property", "nullable": true, "example": "preStatus" }, "type": { "type": "string", "description": "The type of the property", "nullable": true, "example": "text" }, "lookup": { "type": "string", "description": "The Lookup name if the property type is a dropdown", "nullable": true, "example": "PreStatusList" }, "defaultValue": { "type": "string", "description": "The default value of the property", "nullable": true, "example": "Pending" }, "value": { "type": "string", "description": "The value of the property", "nullable": true, "example": "Approved" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to document requirement metadata field", "nullable": true }, "id": { "type": "string", "description": "Id of the document requirement metadata", "format": "uuid", "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" } }, "additionalProperties": false }, "DocumentRequirementMetadataDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementMetadataDto" } ], "nullable": true } }, "additionalProperties": false }, "DocumentRequirementPropertyDto": { "type": "object", "properties": { "value": { "type": "string", "description": "The custom property value", "nullable": true, "example": "Country" } }, "additionalProperties": false, "description": "Contains the attributes needed in order to add custom properties to the document requirement model" }, "DocumentRequirementRequestDto": { "type": "object", "properties": { "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement belongs to", "nullable": true, "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "315df981-38a0-4145-836b-8d22745887b6" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status is linked to", "nullable": true, "example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769" }, "status": { "type": "string", "description": "The status of the document requirement", "nullable": true, "example": "Submit for Approval" }, "comment": { "type": "string", "description": "A comment relating to the updated status of the document requirement", "nullable": true }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "deferUntil": { "type": "string", "description": "The deferral date of the document requirement if Status is set to Deferral Requested", "format": "date-time", "nullable": true, "example": null }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document requirement access layers. The property is immutable.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementPropertyDto" }, "description": "Custom document requirement properties", "nullable": true } }, "additionalProperties": false, "description": "A document requirement model" }, "DocumentRequirementRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementRequestDto" } ], "description": "A document requirement model", "nullable": true } }, "additionalProperties": false }, "DocumentRequirementResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the Document Requirement", "format": "uuid", "example": "8e306281-9c38-41b6-b264-31a901821ff3" }, "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement belongs to", "nullable": true, "example": "dfbe7566-8d61-42bd-a922-dcb21de17b94" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "c8cf5092-6c6a-4bc5-9012-8234408849cf" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status is linked to", "nullable": true, "example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769" }, "status": { "type": "string", "description": "The status of the document requirement", "nullable": true, "example": "Submit for Approval" }, "comment": { "type": "string", "description": "A comment relating to the updated status of the document requirement", "nullable": true }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "deferUntil": { "type": "string", "description": "The deferral date of the document requirement if Status is set to Deferral Requested", "format": "date-time", "nullable": true, "example": null }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementPropertyDto" }, "description": "Custom document requirement properties", "nullable": true } }, "additionalProperties": false, "description": "A document requirement model" }, "DocumentRequirementResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequirementResponseDto" } ], "description": "A document requirement model", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentSignatureCancellationRequestDto": { "type": "object", "properties": { "providerName": { "type": "string", "description": "The name of external provider", "nullable": true, "example": "DocuSign" }, "eSignatureDocumentRequirementId": { "type": "string", "description": "ESignatureDocumentRequirement identifier", "format": "uuid", "example": "4ec8f1bc-d745-4d0d-a9e7-cde0d0e7a614" } }, "additionalProperties": false, "description": "A document requirement model for external eSignature provider" }, "DocumentSignatureCancellationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureCancellationRequestDto" } ], "description": "A document requirement model for external eSignature provider", "nullable": true } }, "additionalProperties": false }, "DocumentSignatureCancellationResponseDto": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string" }, "description": "The list of possible warnings", "nullable": true } }, "additionalProperties": false, "description": "A document requirement model for an external eSignature provider" }, "DocumentSignatureCancellationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureCancellationResponseDto" } ], "description": "A document requirement model for an external eSignature provider", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentSignatureRequestDto": { "type": "object", "properties": { "taskId": { "type": "string", "description": "The Id of the task", "format": "uuid", "example": "315df981-38a0-4145-836b-8d22745887b6" }, "entityId": { "type": "string", "description": "The Id of the entity", "format": "uuid", "example": "315df981-38a0-4145-836b-8d22745887b6" }, "journeyId": { "type": "string", "description": "The Id of the journey", "format": "uuid", "example": "315df981-38a0-4145-836b-8d22745887b6" }, "entityName": { "type": "string", "description": "The name of entity", "nullable": true, "example": "Fenergo Limited" }, "providerName": { "type": "string", "description": "The name of external provider", "nullable": true, "example": "DocuSign" }, "documentRequirementsIds": { "type": "array", "items": { "type": "string" }, "description": "List of document requirements identifiers which will be send", "nullable": true }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerDto" }, "description": "List of persons required to sign off", "nullable": true }, "isDraft": { "type": "boolean", "description": "Flag which determines which status will be send to external provider", "nullable": true, "example": false } }, "additionalProperties": false, "description": "A document requirement model for external eSignature provider" }, "DocumentSignatureRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureRequestDto" } ], "description": "A document requirement model for external eSignature provider", "nullable": true } }, "additionalProperties": false }, "DocumentSignatureResponseDto": { "type": "object", "properties": { "envelopeId": { "type": "string", "description": "EnvelopeId attribute of the eSignature Document Requirement defined by eSignature Service", "nullable": true, "example": "4ec8f1bc-d745-4d0d-a9e7-cde0d0e7a614" }, "dateSent": { "type": "string", "description": "The sent date to external eSignature service", "format": "date-time", "nullable": true, "example": "2021-09-09 09:26:03.478039" }, "externalProviderUrl": { "type": "string", "description": "The URL which navigates to External Provider Envelope", "nullable": true, "example": "https://docusign.net/" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "The list of possible warnings", "nullable": true } }, "additionalProperties": false, "description": "A document requirement model for an external eSignature provider" }, "DocumentSignatureResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentSignatureResponseDto" } ], "description": "A document requirement model for an external eSignature provider", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentSnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Document Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" }, "name": { "type": "string", "description": "Document name", "nullable": true }, "documentType": { "type": "string", "description": "The type of the document", "nullable": true, "example": "Driver license" }, "uploadedBy": { "type": "string", "description": "User who uploaded the document", "nullable": true }, "uploadedOn": { "type": "string", "description": "Date and time when document was uploaded", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Dto representing document information at the time of document assignment creation." }, "ESignatureDocumentRequirementRequestDto": { "type": "object", "properties": { "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement belongs to", "nullable": true, "example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "315df981-38a0-4145-836b-8d22745887b6" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status is linked to", "nullable": true, "example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769" }, "status": { "type": "string", "description": "The status of the document requirement", "nullable": true, "example": "Submit for Approval" }, "comment": { "type": "string", "description": "A comment relating to the updated status of the document requirement", "nullable": true }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "deferUntil": { "type": "string", "description": "The deferral date of the document requirement if Status is set to Deferral Requested", "format": "date-time", "nullable": true, "example": null }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document requirement access layers. The property is immutable.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementPropertyDto" }, "description": "Custom document requirement properties", "nullable": true }, "envelopeId": { "type": "string", "description": "EnvelopeId attribute of the eSignature document requirement defined by eSignature Service", "nullable": true }, "dateSent": { "type": "string", "description": "The sent date to external eSignature service", "format": "date-time", "nullable": true }, "lastNotificationDate": { "type": "string", "description": "The last notification date from external eSignature service", "format": "date-time", "nullable": true }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerDto" }, "description": "List of persons needed to sign off", "nullable": true } }, "additionalProperties": false, "description": "A document requirement model for external eSignature provider" }, "ESignatureDocumentRequirementRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementRequestDto" } ], "description": "A document requirement model for external eSignature provider", "nullable": true } }, "additionalProperties": false }, "ESignatureDocumentRequirementResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the Document Requirement", "format": "uuid", "example": "8e306281-9c38-41b6-b264-31a901821ff3" }, "requirementId": { "type": "string", "description": "The Id of the requirement the document requirement belongs to", "nullable": true, "example": "dfbe7566-8d61-42bd-a922-dcb21de17b94" }, "requirementName": { "type": "string", "description": "The Name of the document requirement defined in policy configuration", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "The unique identifier of the document requirement defined in policy configuration", "nullable": true, "example": "identificationDocuments" }, "isMandatory": { "type": "boolean", "description": "IsMandatory attribute of the document requirement defined in policy configuration", "example": false }, "journeyId": { "type": "string", "description": "The Id of the journey the document requirement belongs to", "nullable": true, "example": "c8cf5092-6c6a-4bc5-9012-8234408849cf" }, "entityId": { "type": "string", "description": "The Id of the entity the document requirement status is linked to", "nullable": true, "example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769" }, "status": { "type": "string", "description": "The status of the document requirement", "nullable": true, "example": "Submit for Approval" }, "comment": { "type": "string", "description": "A comment relating to the updated status of the document requirement", "nullable": true }, "targetEntity": { "type": "string", "description": "The target entity of the requirement", "nullable": true, "example": "Client" }, "deferUntil": { "type": "string", "description": "The deferral date of the document requirement if Status is set to Deferral Requested", "format": "date-time", "nullable": true, "example": null }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementPropertyDto" }, "description": "Custom document requirement properties", "nullable": true }, "envelopeId": { "type": "string", "description": "EnvelopeId attribute of the eSignature document requirement defined by eSignature Service", "nullable": true }, "dateSent": { "type": "string", "description": "The sent date to external eSignature service", "format": "date-time", "nullable": true }, "lastNotificationDate": { "type": "string", "description": "The last notification date from external eSignature service", "format": "date-time", "nullable": true }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerDto" }, "description": "List of persons needed to sign off", "nullable": true } }, "additionalProperties": false, "description": "A document requirement model for an external eSignature provider" }, "ESignatureDocumentRequirementResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureDocumentRequirementResponseDto" } ], "description": "A document requirement model for an external eSignature provider", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ESignatureLookup": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookupValue" }, "nullable": true } }, "additionalProperties": false }, "ESignatureLookupValue": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "ESignatureTypeConfigurationRequestDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "signatureType": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookup" }, "nullable": true }, "defaultSignatureType": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookup" }, "nullable": true }, "conditions": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "DTO representing eSignature type configuration" }, "ESignatureTypeConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureTypeConfigurationRequestDto" } ], "description": "DTO representing eSignature type configuration", "nullable": true } }, "additionalProperties": false }, "ESignatureTypeConfigurationResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "DTO representing response after saving eSignature type configuration" }, "ESignatureTypeConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ESignatureTypeConfigurationResponseDto" } ], "description": "DTO representing response after saving eSignature type configuration", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntitySnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity Id", "format": "uuid", "example": "53aec85d-7015-458e-8fd8-1b04de244d9f" }, "fullName": { "type": "string", "description": "Name of entity", "nullable": true }, "type": { "type": "string", "description": "Entity type", "nullable": true }, "role": { "type": "string", "description": "Entity Role", "nullable": true }, "created": { "type": "string", "description": "Entity creation date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Entity snapshot" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { "type": "object" } }, "PropertyDto": { "type": "object", "properties": { "value": { "type": "string", "description": "The custom property value", "nullable": true, "example": "Ireland" }, "type": { "type": "string", "description": "The custom property type", "nullable": true, "example": "Country" }, "customTypeId": { "type": "string", "description": "The custom property type identifier", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "properties": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Nested properties that compose our custom property", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false, "description": "Contains all the attributes needed in order to add custom fields to the document metadata" }, "PropertyMetadata": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rights": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationDto": { "type": "object", "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "description": "Dictionary with provider configuration settings", "nullable": true } }, "additionalProperties": false, "description": "DTO representing provider configuration" }, "ProviderConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDto" } ], "description": "DTO representing provider configuration", "nullable": true } }, "additionalProperties": false }, "RecipientIdentityInputOption": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phoneNumberList": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientIdentityPhoneNumber" }, "nullable": true }, "valueType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecipientIdentityPhoneNumber": { "type": "object", "properties": { "countryCode": { "type": "string", "nullable": true }, "countryCodeLock": { "type": "string", "nullable": true }, "countryCodeMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true }, "extension": { "type": "string", "nullable": true }, "extensionMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true }, "number": { "type": "string", "nullable": true }, "numberMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true } }, "additionalProperties": false }, "RecipientIdentityVerification": { "type": "object", "properties": { "inputOptions": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientIdentityInputOption" }, "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "workflowIdMetadata": { "allOf": [ { "$ref": "#/components/schemas/PropertyMetadata" } ], "nullable": true }, "workflowLabel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "isCaseSensitive": { "type": "boolean", "description": "Flag that indicate if regex is case sensitive", "example": false }, "regexValue": { "type": "string", "description": "Regex expression", "nullable": true, "example": "^[\\\\w-\\\\.]+@([\\\\w-]+\\\\.)+[\\\\w-]{2,4}$" } }, "additionalProperties": false }, "SaveProviderConfigurationLookupsResponseDto": { "type": "object", "properties": { "status": { "type": "string", "description": "Provider Status", "nullable": true }, "enabled": { "type": "boolean", "description": "Is Provider Enabled" }, "errorMessage": { "type": "string", "description": "Optional user readable error message", "nullable": true }, "lookups": { "type": "array", "items": { "$ref": "#/components/schemas/ESignatureLookup" }, "nullable": true } }, "additionalProperties": false, "description": "DTO representing response after saving the provider configuration" }, "SaveProviderConfigurationLookupsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SaveProviderConfigurationLookupsResponseDto" } ], "description": "DTO representing response after saving the provider configuration", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SaveProviderConfigurationResponseDto": { "type": "object", "properties": { "status": { "type": "string", "description": "Provider Status", "nullable": true }, "enabled": { "type": "boolean", "description": "Is Provider Enabled" }, "errorMessage": { "type": "string", "description": "Optional user readable error message", "nullable": true } }, "additionalProperties": false, "description": "DTO representing response after saving the provider configuration" }, "SaveProviderConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SaveProviderConfigurationResponseDto" } ], "description": "DTO representing response after saving the provider configuration", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SignerDto": { "type": "object", "properties": { "signerType": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "relationship": { "type": "string", "nullable": true }, "hasSigned": { "type": "boolean", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "accessCode": { "type": "string", "nullable": true }, "recipientIdentityVerification": { "allOf": [ { "$ref": "#/components/schemas/RecipientIdentityVerification" } ], "nullable": true }, "signatureType": { "type": "string", "nullable": true }, "smsNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SnapshotDto": { "type": "object", "properties": { "associationsSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationSnapshotDto" }, "description": "List of associations", "nullable": true }, "documentSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSnapshotDto" }, "description": "List of documents", "nullable": true }, "entitiesSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySnapshotDto" }, "description": "List of entities", "nullable": true } }, "additionalProperties": false, "description": "Snapshots of entities, documents and associations at the time when assignments are created.\r\nThis data will be presented on completed task." }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "description": "Array of special characters, which will be ignored by validation e.g. [\"!\",\"@\",\"#\"]", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateAcceptableDocumentSetVersionDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the acceptable document set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Request DTO representing set of properties which define a new version of AcceptableDocument set" }, "UpdateAcceptableDocumentSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDto" } ], "description": "Request DTO representing set of properties which define a new version of AcceptableDocument set", "nullable": true } }, "additionalProperties": false }, "UpdateDocReqMetadataSetVersionDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "The UiD of the Document Requirement Metadata set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Request DTO representing set of properties which define a new version of DocumentRequirementMetadata set" }, "UpdateDocReqMetadataSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocReqMetadataSetVersionDto" } ], "description": "Request DTO representing set of properties which define a new version of DocumentRequirementMetadata set", "nullable": true } }, "additionalProperties": false }, "UpdateDocumentAssignmentDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id containing documents", "format": "uuid", "example": "73f5a5d0-885e-4bf0-b6bb-810d96e97c39" }, "journeyId": { "type": "string", "description": "Journey Id where document assignment id performed.", "format": "uuid", "example": "fa4ae2af-eb80-410c-b0ce-b97be8cfbe5e" }, "taskId": { "type": "string", "description": "Task Id of document assignment", "format": "uuid", "example": "625cbe82-7f6b-4c3c-a159-ac8fbfe42e48" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentDto" }, "description": "Assignments for document from main entity", "nullable": true }, "snapshot": { "allOf": [ { "$ref": "#/components/schemas/SnapshotDto" } ], "description": "Current state of document, entities and associations.", "nullable": true } }, "additionalProperties": false, "description": "Dto representing model of document assignation. One document assignation per entity, journey and task." }, "UpdateDocumentAssignmentDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentAssignmentDto" } ], "description": "Dto representing model of document assignation. One document assignation per entity, journey and task.", "nullable": true } }, "additionalProperties": false }, "UpdateDocumentDto": { "type": "object", "properties": { "documentType": { "type": "string", "description": "The type of the document", "nullable": true, "example": "Driver license" }, "friendlyName": { "type": "string", "description": "The friendly name of the document", "nullable": true }, "documentRequirementIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Hash Set of Document Requirement Ids from FenX to link the document to document requirements", "nullable": true }, "documentDataKey": { "type": "string", "description": "String represented Document DataKey to uniquely identity a document requirement linked with multiple document models", "nullable": true, "example": "identificationDocuments" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Custom document properties", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "skipStatusReset": { "type": "boolean", "description": "Optional flag to skip document requirement history status reset", "nullable": true }, "documentURL": { "type": "string", "description": "URL of the virtual file", "nullable": true } }, "additionalProperties": false, "description": "Properties to update the metadata related to an uploaded document" }, "UpdateDocumentDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentDto" } ], "description": "Properties to update the metadata related to an uploaded document", "nullable": true } }, "additionalProperties": false }, "UpdateDocumentFileResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "status": { "type": "string", "description": "The status of the uploaded document", "nullable": true, "example": "Complete" }, "signedUrlToUpload": { "type": "string", "description": "Url to upload the file into S3 bucket", "nullable": true } }, "additionalProperties": false, "description": "Basic information from the upload document api." }, "UpdateDocumentFileResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentFileResponseDto" } ], "description": "Basic information from the upload document api.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateDocumentRequirementDto": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the document requirement", "nullable": true, "example": "Submit for Approval" }, "comment": { "type": "string", "description": "A comment relating to the updated status of the document requirement", "nullable": true }, "deferUntil": { "type": "string", "description": "The deferral date of the document requirement if Status is set to Deferral Requested", "format": "date-time", "nullable": true, "example": null } }, "additionalProperties": false, "description": "A document requirement model" }, "UpdateDocumentRequirementDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementDto" } ], "description": "A document requirement model", "nullable": true } }, "additionalProperties": false }, "UpdateDocumentRequirementPropertiesDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentRequirementPropertyDto" }, "description": "Custom document requirement properties", "nullable": true } }, "additionalProperties": false, "description": "Metadata required to update a document requirement model's custom properties" }, "UpdateDocumentRequirementPropertiesDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDto" } ], "description": "Metadata required to update a document requirement model's custom properties", "nullable": true } }, "additionalProperties": false }, "UpdateDocumentRequirementPropertiesDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDocumentRequirementPropertiesDto" } ], "description": "Metadata required to update a document requirement model's custom properties", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateESignatureDocumentRequirementDto": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the document requirement", "nullable": true, "example": "Submit for Approval" }, "comment": { "type": "string", "description": "A comment relating to the updated status of the document requirement", "nullable": true }, "deferUntil": { "type": "string", "description": "The deferral date of the document requirement if Status is set to Deferral Requested", "format": "date-time", "nullable": true, "example": null }, "envelopeId": { "type": "string", "description": "EnvelopeId attribute of the eSignature document requirement defined by eSignature Service", "nullable": true }, "dateSent": { "type": "string", "description": "The sent date to external eSignature service", "format": "date-time", "nullable": true }, "lastNotificationDate": { "type": "string", "description": "The last notification date from external eSignature service", "format": "date-time", "nullable": true }, "signers": { "type": "array", "items": { "$ref": "#/components/schemas/SignerDto" }, "description": "List of persons needed to sign off", "nullable": true }, "doNotOverrideESignature": { "type": "boolean", "description": "The flag which indicates whether override eSignature properties", "nullable": true } }, "additionalProperties": false, "description": "An update document requirement model for external eSignature provider" }, "UpdateESignatureDocumentRequirementDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateESignatureDocumentRequirementDto" } ], "description": "An update document requirement model for external eSignature provider", "nullable": true } }, "additionalProperties": false }, "UploadDocumentResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the document", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "documentRequirementIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of Document Requirement Ids that the document is linked to", "nullable": true }, "documentType": { "type": "string", "description": "The type of the document", "nullable": true, "example": "Driver license" }, "status": { "type": "string", "description": "The status of the uploaded document", "nullable": true, "example": "Complete" } }, "additionalProperties": false, "description": "Basic information from the upload document api." }, "UploadDocumentResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UploadDocumentResponseDto" } ], "description": "Basic information from the upload document api.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "description": "Special characters validation rule - does not allow special characters,\r\nbut allows define array of characters which can be ignored by the validation", "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow numbers", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "description": "Validation rule that validates the value against provided regex", "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set minimum and maximum count of characters", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set number range", "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow future dates", "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow past dates", "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set selection range", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minValue": { "type": "integer", "description": "Minimum value", "format": "int32", "nullable": true, "example": 1 }, "maxValue": { "type": "integer", "description": "Maximum value", "format": "int32", "nullable": true, "example": 10 } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }