openapi: 3.2.0 info: title: Fenergo Acceptable Document API version: '1.0' description: 'Operations tagged AcceptableDocument across 3 of this provider''s published API definitions: fenergo-documentmanagementcommand-v1-0-openapi.json, fenergo-documentmanagementcommand-v2-0-openapi.json, fenergo-documentmanagementquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /documentmanagementcommand - url: /documentmanagementquery security: - Bearer: [] tags: - name: AcceptableDocument paths: /api/acceptabledocument/set: post: tags: - AcceptableDocument summary: Create acceptable document set model description: 'Creates a new acceptable document set with a first draft version. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. 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 get: tags: - AcceptableDocument summary: Gets the default Acceptable Document Set of the tenant description: 'This method returns an Acceptable Document set and it''s versions Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetDefaultAcceptableDocumentSet 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: '200': description: AcceptableDocumentSet model returned successfully content: text/plain: schema: $ref: '#/components/schemas/AcceptableDocumentSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/AcceptableDocumentSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/AcceptableDocumentSetDtoServiceResponse' '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: AcceptableDocumentSet model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the request '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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}/version/{versionNumber}: post: tags: - AcceptableDocument summary: Create acceptable document set version by version number description: 'Creates a new version from an existing acceptable document version. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. 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: 'Updates 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: 'Deletes the selected version of an existing acceptable document set. If the version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as deleted and become unavailable. 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 get: tags: - AcceptableDocument summary: Gets an Acceptable Document Set Version by setId and version number description: 'This method returns an Acceptable Document set version and it''s acceptable documents Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetAcceptableDocumentSetVersion parameters: - name: setId in: path description: The ID of the Acceptable Document Set required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number to retrieve 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: '200': description: AcceptableDocumentSetVersion returned successfully content: text/plain: schema: $ref: '#/components/schemas/AcceptableDocumentSetVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/AcceptableDocumentSetVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/AcceptableDocumentSetVersionDtoServiceResponse' '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: AcceptableDocumentSet or AcceptableDocumentSetVersion not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the request '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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}: post: tags: - AcceptableDocument summary: Create acceptable document set version with given acceptable documents description: 'Creates a new version from the given acceptable documents. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. 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: 'Deletes 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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - AcceptableDocument summary: Submit acceptable document set version for approval description: 'Submits 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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}/version/{versionNumber}/sign: put: tags: - AcceptableDocument summary: Sign acceptable document set version description: 'Signs 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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}/version/{versionNumber}/archive: put: tags: - AcceptableDocument summary: Archive acceptable document set version description: 'Archives 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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument: post: tags: - AcceptableDocument summary: Create acceptable document model description: 'This method will create a new acceptable document model The 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 servers: - url: /documentmanagementcommand /api/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument/{id}: put: tags: - AcceptableDocument summary: Update an existing acceptable document model description: 'This 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: 'This 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 get: tags: - AcceptableDocument summary: Gets an Acceptable Document by Id description: 'This method returns an Acceptable Document model Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetAcceptableDocumentById parameters: - name: setId in: path description: The set id of the set where the acceptable document lives required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version the acceptable document lives required: true schema: type: integer format: int32 - name: id in: path description: The ID of the Acceptable Document 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: '200': description: AcceptableDocument model returned successfully content: text/plain: schema: $ref: '#/components/schemas/AcceptableDocumentDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/AcceptableDocumentDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/AcceptableDocumentDtoServiceResponse_2' '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: AcceptableDocument model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the request '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 servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set: post: tags: - AcceptableDocument summary: Create acceptable document set model description: 'Creates a new acceptable document set with a first draft version. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: postApiV2AcceptabledocumentSet 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 x-operation-id-source: normalized x-operation-id-original: CreateAcceptableDocumentSet servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}/version/{versionNumber}: post: tags: - AcceptableDocument summary: Create acceptable document set version by version number description: 'Creates a new version from an existing acceptable document version. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: postApiV2AcceptabledocumentSetBySetIdVersionByVersionNumber 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 x-operation-id-source: normalized x-operation-id-original: CreateAcceptableDocumentSetVersionByVersionNumber put: tags: - AcceptableDocument summary: Update acceptable document set version description: 'Updates an existing acceptable document set version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2AcceptabledocumentSetBySetIdVersionByVersionNumber 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 x-operation-id-source: normalized x-operation-id-original: UpdateAcceptableDocumentSetVersion delete: tags: - AcceptableDocument summary: Delete acceptable document set version description: 'Deletes the selected version of an existing acceptable document set. If the version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as deleted and become unavailable. Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: deleteApiV2AcceptabledocumentSetBySetIdVersionByVersionNumber 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 x-operation-id-source: normalized x-operation-id-original: DeleteAcceptableDocumentSetVersion servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}: post: tags: - AcceptableDocument summary: Create acceptable document set version with given acceptable documents description: 'Creates a new version from the given acceptable documents. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: postApiV2AcceptabledocumentSetBySetId 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 x-operation-id-source: normalized x-operation-id-original: CreateAcceptableDocumentSetVersion delete: tags: - AcceptableDocument summary: Delete acceptable document set and all its versions description: 'Deletes an existing acceptable document set and all its versions. Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: deleteApiV2AcceptabledocumentSetBySetId 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 x-operation-id-source: normalized x-operation-id-original: DeleteAcceptableDocumentSet servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - AcceptableDocument summary: Submit acceptable document set version for approval description: 'Submits the selected version of an existing acceptable document set for approval. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2AcceptabledocumentSetBySetIdVersionByVersionNumberSubmitForApproval 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 x-operation-id-source: normalized x-operation-id-original: SubmitForApprovalAcceptableDocumentSetVersion servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}/version/{versionNumber}/sign: put: tags: - AcceptableDocument summary: Sign acceptable document set version description: 'Signs 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: putApiV2AcceptabledocumentSetBySetIdVersionByVersionNumberSign 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 x-operation-id-source: normalized x-operation-id-original: SignAcceptableDocumentSetVersion servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}/version/{versionNumber}/archive: put: tags: - AcceptableDocument summary: Archive acceptable document set version description: 'Archives the selected version of an existing acceptable document set. Required permissions: Following permissions are required: DocumentConfigurationArchive' operationId: putApiV2AcceptabledocumentSetBySetIdVersionByVersionNumberArchive 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 x-operation-id-source: normalized x-operation-id-original: ArchiveAcceptableDocumentSetVersion servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument: post: tags: - AcceptableDocument summary: Create acceptable document model description: 'This method will create a new acceptable document model The model will initialize with the DTO data of "Type", "Description", and "DataKey" Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: postApiV2AcceptabledocumentSetBySetIdVersionByVersionNumberAcceptableDocument 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 x-operation-id-source: normalized x-operation-id-original: CreateAcceptableDocument servers: - url: /documentmanagementcommand /api/v2/acceptabledocument/set/{setId}/version/{versionNumber}/acceptableDocument/{id}: put: tags: - AcceptableDocument summary: Update an existing acceptable document model description: 'This method will update an existing acceptable document model Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2AcceptabledocumentSetBySetIdVersionByVersionNumberAcceptableDocumentById 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 x-operation-id-source: normalized x-operation-id-original: UpdateAcceptableDocument delete: tags: - AcceptableDocument summary: Delete an existing acceptable document model description: 'This method will delete an existing acceptable document model Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: deleteApiV2AcceptabledocumentSetBySetIdVersionByVersionNumberAcceptableDocumentById 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 x-operation-id-source: normalized x-operation-id-original: DeleteAcceptableDocument servers: - url: /documentmanagementcommand /api/acceptabledocument: get: tags: - AcceptableDocument summary: Gets all Acceptable Documents description: 'This method returns the Acceptable Document models from the latest version of the Acceptable Document Set Required permissions: At least one of the following permissions is required: DocumentConfigurationAccess, DocumentManagementAccess, PolicyConfigurationAccess' operationId: GetLatestAcceptableDocuments 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: '200': description: AcceptableDocument models returned successfully content: text/plain: schema: $ref: '#/components/schemas/AcceptableDocumentDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/AcceptableDocumentDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/AcceptableDocumentDtoIEnumerableServiceResponse' '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 request '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 servers: - url: /documentmanagementquery /api/acceptabledocument/set/metadata: get: tags: - AcceptableDocument summary: Gets the default Acceptable Document Set Metadata of the tenant description: 'This method returns an Acceptable Document set Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetDefaultAcceptableDocumentSetMetadata 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: '200': description: AcceptableDocumentSet model returned successfully content: text/plain: schema: $ref: '#/components/schemas/AcceptableDocumentSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/AcceptableDocumentSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/AcceptableDocumentSetDtoServiceResponse' '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: AcceptableDocumentSet model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the request '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 servers: - url: /documentmanagementquery /api/acceptabledocument/set/paged: get: tags: - AcceptableDocument summary: Gets paged default Acceptable Document Set of the tenant description: 'This method returns paged default Acceptable Document set and it''s versions Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetPagedDefaultAcceptableDocumentSet parameters: - name: pageSize in: query required: true schema: type: integer format: int32 - name: paginationToken in: query schema: type: string - 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: '200': description: Paged AcceptableDocumentSet model returned successfully content: text/plain: schema: $ref: '#/components/schemas/PagedAcceptableDocumentResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedAcceptableDocumentResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedAcceptableDocumentResponseDtoServiceResponse' '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: AcceptableDocumentSet model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the request '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 servers: - url: /documentmanagementquery components: schemas: Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: 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 - 'null' items: $ref: '#/components/schemas/CreateAcceptableDocumentRequestDto' description: List of Acceptable Documents notes: type: - string - 'null' 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. example: Example Notes additionalProperties: false description: Request DTO representing set of properties which define a new version of AcceptableDocument set AcceptableDocumentDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AcceptableDocumentDto' additionalProperties: false CreateAcceptableDocumentSetResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateAcceptableDocumentSetResponseDto' description: Response DTO representing Acceptable Document Set Version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version notes: type: - string - 'null' 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. example: Example Notes additionalProperties: false description: Request DTO representing set of properties which define a new version of AcceptableDocument set AcceptableDocumentDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AcceptableDocumentDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateAcceptableDocumentRequestDto: type: object properties: type: type: - string - 'null' description: The type of the acceptable document example: A recent utility bill description: type: - string - 'null' description: The description of the acceptable document example: A utility bill that has been issued in the last 6 months dataKey: type: - string - 'null' description: The datakey of the acceptable document 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 - 'null' items: type: string description: Policy Categories that will be used to extract data from the document example: - Basic Details additionalProperties: false 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 additionalProperties: false Decision: enum: - Approve - Reject type: string 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 ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false 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 additionalProperties: false CreateAcceptableDocumentRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateAcceptableDocumentRequestDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AcceptableDocumentDto: type: object properties: id: type: string description: Id of the acceptable document format: uuid example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5 type: type: - string - 'null' description: The type of the acceptable document example: A recent utility bill description: type: - string - 'null' description: The description of the acceptable document example: A utility bill that has been issued in the last 6 months dataKey: type: - string - 'null' description: The datakey of the acceptable document 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 - 'null' items: type: string description: Policy Categories that will be used to extract data from the document example: - Basic Details additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false AcceptableDocumentSetVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AcceptableDocumentSetVersionDto' description: Response DTO representing Acceptable Document Set Version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedAcceptableDocumentResponseDto: type: object properties: items: allOf: - $ref: '#/components/schemas/AcceptableDocumentSetDto' description: The items result set paginationToken: type: - string - 'null' description: Indicates if there is any more items to retrieve additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string AcceptableDocumentDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/AcceptableDocumentDto_2' description: Response DTO representing Acceptable Document data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AcceptableDocumentSetDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AcceptableDocumentSetDto' description: Response DTO representing Acceptable Document Set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AcceptableDocumentSetDto: type: object properties: id: type: string description: The UiD of the Acceptable Document Set format: uuid example: cd1b619f-be96-45e2-ab6a-0f7597c4b811 versions: type: - array - 'null' items: $ref: '#/components/schemas/AcceptableDocumentSetVersionDto' description: Versions associated to this Acceptable Document Set additionalProperties: false description: Response DTO representing Acceptable Document Set data AcceptableDocumentDto_2: type: object properties: id: type: string description: Acceptable Document Id format: uuid type: type: - string - 'null' description: Acceptable Document Type description: type: - string - 'null' description: The description of the acceptable document example: A utility bill that has been issued in the last 6 months dataKey: type: - string - 'null' description: The datakey of the acceptable document example: utilityBill extractData: type: boolean description: The entity data will be extracted from the document example: true extractRelatedParties: type: boolean description: Extract related party data 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 - 'null' items: type: string description: Policy Categories that will be used to extract data from the document example: - Basic Details additionalProperties: false description: Response DTO representing Acceptable Document data AcceptableDocumentDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AcceptableDocumentDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedAcceptableDocumentResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PagedAcceptableDocumentResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AcceptableDocumentSetVersionDto: type: object properties: id: type: string description: The UiD of the Acceptable Document Set Version format: uuid example: 93878e7f-6a29-4660-a8f3-2bf7128ff1ac 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 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published acceptableDocuments: type: - array - 'null' items: $ref: '#/components/schemas/AcceptableDocumentDto_2' description: List of Acceptable Documents created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' effectiveFrom: type: - string - 'null' description: The date that the version takes effect when published format: date-time example: '2023-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2023-02-02T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version was published format: date-time readOnly: true example: '2023-03-03T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version notes: type: - string - 'null' description: Version Notes example: Example Notes additionalProperties: false description: Response DTO representing Acceptable Document Set Version data securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-documentmanagementcommand-v1-0-openapi.json - fenergo-documentmanagementcommand-v2-0-openapi.json - fenergo-documentmanagementquery-v1-0-openapi.json