openapi: 3.2.0 info: title: Fenergo Document Requirement Metadata API version: '1.0' description: 'Operations tagged DocumentRequirementMetadata 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: DocumentRequirementMetadata paths: /api/documentrequirementmetadata/set: post: tags: - DocumentRequirementMetadata summary: Create a document requirement metadata set model description: 'Creates a new document requirement metadata 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: CreateDocumentRequirementMetadataSet parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Document Requirement Metadata set model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - DocumentRequirementMetadata summary: Gets the default Document Requirement Metadata Set of the tenant description: 'This method returns a Document Requirement Metadata set and it''s versions Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetDefaultDocumentRequirementMetadataSet 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: DocumentRequirementMetadataSet model returned successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementMetadataSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataSetDtoServiceResponse' '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: DocumentRequirementMetadataSet 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/documentrequirementmetadata/set/{setId}/version/{versionNumber}: post: tags: - DocumentRequirementMetadata summary: Create document requirement metadata set version by version number description: 'Creates a new version from an existing document requirement metadata 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: CreateDocumentRequirementMetadataSetVersionByVersionNumber parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to be cloned required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Document Requirement Metadata set model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT put: tags: - DocumentRequirementMetadata summary: Update document requirement metadata set version description: 'Updates an existing document requirement metadata set version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: UpdateDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest' responses: '202': description: Success. Document Requirement Metadata set version updated '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - DocumentRequirementMetadata summary: Delete document requirement metadata set version description: 'Deletes the selected version of an existing document requirement metadata 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: DeleteDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set version deleted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - DocumentRequirementMetadata summary: Gets a Document Requirement Metadata Set Version by setId and version number description: 'This method returns a Document Requirement Metadata set version and it''s document requirement metadata Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: The ID of the Document Requirement Metadata 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: DocumentRequirementMetadataSetVersion returned successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementMetadataSetVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataSetVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataSetVersionDtoServiceResponse' '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: DocumentRequirementMetadataSet or DocumentRequirementMetadataSetVersion 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/documentrequirementmetadata/set/{setId}: post: tags: - DocumentRequirementMetadata summary: Create document requirement metadata set version with given document… description: 'Creates a new version from the given document requirement metadata. 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: CreateDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Request body containing the document requirement metadata set version data content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest' responses: '202': description: Document Requirement Metadata set model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - DocumentRequirementMetadata summary: Delete document requirement metadata set and all its versions description: 'Deletes an existing document requirement metadata set and all its versions. Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: DeleteDocumentRequirementMetadataSet parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set deleted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - DocumentRequirementMetadata summary: Submit document requirement metadata set version for approval description: 'Submits the selected version of an existing document requirement metadata set for approval. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: SubmitForApprovalDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set version submitted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/sign: put: tags: - DocumentRequirementMetadata summary: Sign document requirement metadata set version description: 'Signs the selected version of an existing document requirement metadata set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: DocumentConfigurationApprove' operationId: SignDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Sign document requirement metadata set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Success.Document Requirement Metadata set version signed '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/archive: put: tags: - DocumentRequirementMetadata summary: Archive document requirement metadata set version description: 'Archives the selected version of an existing document requirement metadata set. Required permissions: Following permissions are required: DocumentConfigurationArchive' operationId: ArchiveDocumentRequirementMetadataSetVersion parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set version archived '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata: post: tags: - DocumentRequirementMetadata summary: Create document requirement metadata model description: 'This method will create a new document requirement metadata model The model will initialize with the DTO data of "Name", "DatabaseFieldName", and "Type" Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: CreateDocumentRequirementMetadata parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number where the document requirement metadata will be added required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the CreateDocumentRequirementMetadataRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest' responses: '202': description: Document Requirement Metadata model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata/{id}: put: tags: - DocumentRequirementMetadata summary: Update an existing document requirement metadata model description: 'This method will update an existing document requirement metadata model Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: UpdateDocumentRequirementMetadata parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number where the document requirement metadata to be updated lives required: true schema: type: integer format: int32 - name: id in: path description: The id of the existing model required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the updated data content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceRequest' responses: '202': description: Document Requirement Metadata model updated successfully '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Document Requirement Metadata model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - DocumentRequirementMetadata summary: Delete an existing document requirement metadata model description: 'This method will delete an existing document requirement metadata model Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: DeleteDocumentRequirementMetadata parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number where the document requirement metadata to be deleted lives required: true schema: type: integer format: int32 - name: id in: path description: The id of the existing model to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Document Requirement Metadata model deleted successfully '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Document Requirement Metadata model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - DocumentRequirementMetadata summary: Gets a Document Requirement Metadata by Id description: 'This method returns a Document Requirement Metadata model Required permissions: Following permissions are required: DocumentConfigurationAccess' operationId: GetDocumentRequirementMetadataById parameters: - name: setId in: path description: The set id of the set where the document requirement metadata lives required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version the document requirement metadata lives required: true schema: type: integer format: int32 - name: id in: path description: The ID of the Document Requirement Metadata 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: DocumentRequirementMetadata model returned successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceResponse' '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: DocumentRequirementMetadata 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/documentrequirementmetadata/set: post: tags: - DocumentRequirementMetadata summary: Create a document requirement metadata set model description: 'Creates a new document requirement metadata 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: postApiV2DocumentrequirementmetadataSet parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Document Requirement Metadata set model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDocumentRequirementMetadataSet servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}/version/{versionNumber}: post: tags: - DocumentRequirementMetadata summary: Create document requirement metadata set version by version number description: 'Creates a new version from an existing document requirement metadata 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: postApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumber parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to be cloned required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Document Requirement Metadata set model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDocumentRequirementMetadataSetVersionByVersionNumber put: tags: - DocumentRequirementMetadata summary: Update document requirement metadata set version description: 'Updates an existing document requirement metadata set version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumber parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update requirement set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDtoServiceRequest' responses: '202': description: Success. Document Requirement Metadata set version updated '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateDocumentRequirementMetadataSetVersion delete: tags: - DocumentRequirementMetadata summary: Delete document requirement metadata set version description: 'Deletes the selected version of an existing document requirement metadata 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: deleteApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumber parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set version deleted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteDocumentRequirementMetadataSetVersion servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}: post: tags: - DocumentRequirementMetadata summary: Create document requirement metadata set version with given document… description: 'Creates a new version from the given document requirement metadata. 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: postApiV2DocumentrequirementmetadataSetBySetId parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Request body containing the document requirement metadata set version data content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDtoServiceRequest' responses: '202': description: Document Requirement Metadata set model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDocumentRequirementMetadataSetVersion delete: tags: - DocumentRequirementMetadata summary: Delete document requirement metadata set and all its versions description: 'Deletes an existing document requirement metadata set and all its versions. Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: deleteApiV2DocumentrequirementmetadataSetBySetId parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set deleted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteDocumentRequirementMetadataSet servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - DocumentRequirementMetadata summary: Submit document requirement metadata set version for approval description: 'Submits the selected version of an existing document requirement metadata set for approval. Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumberSubmitForApproval parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set version submitted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SubmitForApprovalDocumentRequirementMetadataSetVersion servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}/version/{versionNumber}/sign: put: tags: - DocumentRequirementMetadata summary: Sign document requirement metadata set version description: 'Signs the selected version of an existing document requirement metadata set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: DocumentConfigurationApprove' operationId: putApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumberSign parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Sign document requirement metadata set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Success.Document Requirement Metadata set version signed '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SignDocumentRequirementMetadataSetVersion servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}/version/{versionNumber}/archive: put: tags: - DocumentRequirementMetadata summary: Archive document requirement metadata set version description: 'Archives the selected version of an existing document requirement metadata set. Required permissions: Following permissions are required: DocumentConfigurationArchive' operationId: putApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumberArchive parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Document Requirement Metadata set version archived '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: ArchiveDocumentRequirementMetadataSetVersion servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata: post: tags: - DocumentRequirementMetadata summary: Create document requirement metadata model description: 'This method will create a new document requirement metadata model The model will initialize with the DTO data of "Name", "DatabaseFieldName", and "Type" Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: postApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumberDocumentRequirementMetadata parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number where the document requirement metadata will be added required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the CreateDocumentRequirementMetadataRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDtoServiceRequest' responses: '202': description: Document Requirement Metadata model created successfully content: text/plain: schema: $ref: '#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocReqMetadataResponseDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document Requirement Metadata set with given id does not exist type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDocumentRequirementMetadata servers: - url: /documentmanagementcommand /api/v2/documentrequirementmetadata/set/{setId}/version/{versionNumber}/documentRequirementMetadata/{id}: put: tags: - DocumentRequirementMetadata summary: Update an existing document requirement metadata model description: 'This method will update an existing document requirement metadata model Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumberDocumentRequirementMetadataById parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number where the document requirement metadata to be updated lives required: true schema: type: integer format: int32 - name: id in: path description: The id of the existing model required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the updated data content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDtoServiceRequest' responses: '202': description: Document Requirement Metadata model updated successfully '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Document Requirement Metadata model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateDocumentRequirementMetadata delete: tags: - DocumentRequirementMetadata summary: Delete an existing document requirement metadata model description: 'This method will delete an existing document requirement metadata model Required permissions: Following permissions are required: DocumentConfigurationDelete' operationId: deleteApiV2DocumentrequirementmetadataSetBySetIdVersionByVersionNumberDocumentRequirementMetadataById parameters: - name: setId in: path description: Document Requirement Metadata set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number where the document requirement metadata to be deleted lives required: true schema: type: integer format: int32 - name: id in: path description: The id of the existing model to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Document Requirement Metadata model deleted successfully '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Document Requirement Metadata model not found type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteDocumentRequirementMetadata servers: - url: /documentmanagementcommand /api/documentrequirementmetadata: get: tags: - DocumentRequirementMetadata summary: Gets all Document Requirement Metadata description: 'This method returns the Document Requirement Metadata models from the latest version of the Document Requirement Metadata Set Required permissions: At least one of the following permissions is required: DocumentConfigurationAccess, DocumentManagementAccess, PolicyConfigurationAccess' operationId: GetLatestDocumentRequirementMetadata 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: DocumentRequirementMetadata models returned successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementMetadataDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementMetadataDtoIEnumerableServiceResponse' '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 components: schemas: CreateDocReqMetadataSetResponseDto: type: object properties: setId: type: string description: The UiD of the Document Requirement Metadata Set that the version belongs to format: uuid example: 3e1c5137-453a-48df-8d26-c70ee8059b4a versionNumber: type: integer description: The version number format: int32 example: 2 additionalProperties: false description: Response DTO representing Document Requirement Metadata Set Version data SpecialCharactersRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false CreateDocReqMetadataSetVersionDto: type: object properties: setId: type: string description: The UiD of the Document Requirement Metadata set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f documentRequirementMetadata: type: - array - 'null' items: $ref: '#/components/schemas/BaseDocumentRequirementMetadataDto' description: List of Document Requirement Metadata 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 DocumentRequirementMetadata set 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 UpdateDocReqMetadataSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDocReqMetadataSetVersionDto' description: Request DTO representing set of properties which define a new version of DocumentRequirementMetadata set additionalProperties: false ValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set selection range additionalProperties: false CreateDocReqMetadataSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetVersionDto' description: Request DTO representing set of properties which define a new version of DocumentRequirementMetadata set additionalProperties: false UpdateDocReqMetadataSetVersionDto: type: object properties: setId: type: string description: The UiD of the Document Requirement Metadata set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f signees: type: - array - '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 DocumentRequirementMetadata set DocumentRequirementMetadataDto: type: object properties: name: type: - string - 'null' description: The name of the property example: Pre-Status databaseFieldName: type: - string - 'null' description: The database field name of the property example: preStatus type: type: - string - 'null' description: The type of the property example: text lookup: type: - string - 'null' description: The Lookup name if the property type is a dropdown example: PreStatusList defaultValue: type: - string - 'null' description: The default value of the property example: Pending value: type: - string - 'null' description: The value of the property example: Approved validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to document requirement metadata field id: type: string description: Id of the document requirement metadata format: uuid example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5 additionalProperties: false DocumentRequirementMetadataDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDto' additionalProperties: false ValueLimitRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false BasicRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false CreateDocReqMetadataResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataResponseDto' description: Response DTO representing Document Requirement Metadata Set Version data 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 CreateDocReqMetadataSetResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateDocReqMetadataSetResponseDto' description: Response DTO representing Document Requirement Metadata Set Version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Decision: enum: - Approve - Reject type: string DateLimitRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false BaseDocumentRequirementMetadataDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/BaseDocumentRequirementMetadataDto' 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 CreateDocReqMetadataResponseDto: type: object properties: id: type: string description: Id of the document requirement metadata format: uuid example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5 additionalProperties: false description: Response DTO representing Document Requirement Metadata Set Version data RegexRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false BaseDocumentRequirementMetadataDto: type: object properties: name: type: - string - 'null' description: The name of the property example: Pre-Status databaseFieldName: type: - string - 'null' description: The database field name of the property example: preStatus type: type: - string - 'null' description: The type of the property example: text lookup: type: - string - 'null' description: The Lookup name if the property type is a dropdown example: PreStatusList defaultValue: type: - string - 'null' description: The default value of the property example: Pending value: type: - string - 'null' description: The value of the property example: Approved validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to document requirement metadata field additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false SpecialCharactersRuleDto_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata DocumentRequirementMetadataDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataDto_2' description: Response DTO representing Document Requirement Metadata data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocumentRequirementMetadataSetDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataSetDto' description: Response DTO representing Document Requirement Metadata Set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto_2' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto_2' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Validation rule that allows to set selection range additionalProperties: false description: Request DTO representing validation data metadata DocumentRequirementMetadataDto_2: type: object properties: setId: type: string description: The UiD of the parent set format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd versionNumber: type: integer description: The version number of the parent set format: int32 example: 1 id: type: string description: The Id of the property format: uuid example: Pre-Status name: type: - string - 'null' description: The name of the property example: Pre-Status databaseFieldName: type: - string - 'null' description: The database field name of the property example: preStatus type: type: - string - 'null' description: The type of the property example: text lookup: type: - string - 'null' description: The Lookup name if the property type is a dropdown example: PreStatusList defaultValue: type: - string - 'null' description: The default value of the property example: Pending value: type: - string - 'null' description: The value of the property example: Approved validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' description: Document requirement metadata validation data additionalProperties: false description: Response DTO representing Document Requirement Metadata data ValueLimitRuleDto_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata BasicRuleDto_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata DocumentRequirementMetadataSetDto: type: object properties: id: type: string description: The UiD of the Document Requirement Metadata Set format: uuid example: cd1b619f-be96-45e2-ab6a-0f7597c4b811 versions: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementMetadataSetVersionDto' description: Versions associated to this Document Requirement Metadata Set additionalProperties: false description: Response DTO representing Document Requirement Metadata Set data DocumentRequirementMetadataSetVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementMetadataSetVersionDto' description: Response DTO representing Document Requirement Metadata Set Version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DateLimitRuleDto_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata DocumentRequirementMetadataDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementMetadataDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocumentRequirementMetadataSetVersionDto: type: object properties: id: type: string description: The UiD of the Document Requirement Metadata Set Version format: uuid example: 93878e7f-6a29-4660-a8f3-2bf7128ff1ac setId: type: string description: The UiD of the Document Requirement Metadata Set that the version belongs to format: uuid example: 3e1c5137-453a-48df-8d26-c70ee8059b4a versionNumber: type: integer description: The version number format: int32 example: 2 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published documentRequirementMetadata: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementMetadataDto_2' description: List of Document Requirement Metadata 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 Document Requirement Metadata Set Version data RegexRuleDto_2: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string 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