openapi: 3.2.0 info: title: Fenergo Document Requirement API version: '1.0' description: 'Operations tagged DocumentRequirement across 5 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, fenergo-policycommand-v2-0-openapi.json, fenergo-policyquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /documentmanagementcommand - url: /documentmanagementquery - url: /policycommand - url: /policyquery security: - Bearer: [] tags: - name: DocumentRequirement paths: /api/documentrequirement: post: tags: - DocumentRequirement summary: Creates a new DocumentRequirement description: 'This method will create a new DocumentRequirement model. Required permissions: Following permissions are required: DocumentManagementCreate' operationId: CreateDocumentRequirement parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to create content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' responses: '202': description: DocumentRequirementDto model created successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirement/{id}: put: tags: - DocumentRequirement summary: Updates an existing DocumentRequirement description: 'Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementApprove, DocumentManagementDeferOrWaive' operationId: UpdateDocumentRequirement parameters: - name: id in: path description: The Id of the existing model to update required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' responses: '202': description: DocumentRequirement Model updated successfully '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirement/{id}/properties: put: tags: - DocumentRequirement summary: Updates the existing properties on a DocumentRequirement description: 'Required permissions: At least one of the following permissions is required: DocumentManagementEdit' operationId: UpdateDocumentRequirementProperties parameters: - name: id in: path description: The Id of the existing model to update required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceRequest' responses: '202': description: DocumentRequirement Model properties updated successfully content: text/plain: schema: $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. DocumentRequirementModel with given id does not exist type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/v2/documentrequirement/{id}: put: tags: - DocumentRequirement summary: Updates an existing DocumentRequirement - UpdateDocumentRequirement description: 'Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementApprove, DocumentManagementDeferOrWaive' operationId: putApiV2DocumentrequirementById parameters: - name: id in: path description: The Id of the existing model to update required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' responses: '202': description: DocumentRequirement Model updated successfully '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateDocumentRequirement servers: - url: /documentmanagementcommand /api/v2/documentrequirement/product/{id}: put: tags: - DocumentRequirement summary: Updates an existing DocumentRequirement - product/UpdateDocumentRequirement description: 'Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementApprove, DocumentManagementDeferOrWaive' operationId: product/UpdateDocumentRequirement parameters: - name: id in: path description: The Id of the existing model to update required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' responses: '202': description: DocumentRequirement Model updated successfully '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/v2/documentrequirement/deal/{id}: put: tags: - DocumentRequirement summary: Updates an existing DocumentRequirement - deal/UpdateDocumentRequirement description: 'Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementApprove, DocumentManagementDeferOrWaive' operationId: deal/UpdateDocumentRequirement parameters: - name: id in: path description: The Id of the existing model to update required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDtoServiceRequest' responses: '202': description: DocumentRequirement Model updated successfully '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/v2/documentrequirement: post: tags: - DocumentRequirement summary: Creates a new DocumentRequirement. - CreateDocumentRequirement description: 'This method will create a new DocumentRequirement model. Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementLink' operationId: postApiV2Documentrequirement parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to create content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' responses: '202': description: DocumentRequirementDto model created successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDocumentRequirement servers: - url: /documentmanagementcommand /api/v2/documentrequirement/product/CreateDocumentRequirement: post: tags: - DocumentRequirement summary: Creates a new DocumentRequirement. - product/CreateDocumentRequirement description: 'This method will create a new DocumentRequirement model. Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementLink' operationId: product/CreateDocumentRequirement parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to create content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' responses: '202': description: DocumentRequirementDto model created successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/v2/documentrequirement/deal/CreateDocumentRequirement: post: tags: - DocumentRequirement summary: Creates a new DocumentRequirement. - deal/CreateDocumentRequirement description: 'This method will create a new DocumentRequirement model. Required permissions: At least one of the following permissions is required: DocumentManagementCreate, DocumentManagementLink' operationId: deal/CreateDocumentRequirement parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the DocumentRequirement to create content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest' responses: '202': description: DocumentRequirementDto model created successfully content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementcommand /api/documentrequirement/{journeyId}: get: tags: - DocumentRequirement summary: Gets all requirements for a Journey Id description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetAllRequirementModelsByJourneyId parameters: - name: journeyId in: path description: The journey identifier. 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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirements if found; \n otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementquery /api/documentrequirement/{journeyId}/{requirementId}: get: tags: - DocumentRequirement summary: Gets a DocumentRequirementModel by Journey Id and Requirement Id description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetDocumentRequirementModelById parameters: - name: journeyId in: path description: The journey identifier. required: true schema: type: string format: uuid - name: requirementId in: path description: The requirement identifier. 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: "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \n otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document requirement model with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementquery /api/documentrequirement/entity/{entityId}/journey/{journeyId}: get: tags: - DocumentRequirement summary: Gets all Document Requirement Statuses for an Entity Id and Journey Id description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetAllRequirementModelsByEntityIdAndJourneyId parameters: - name: entityId in: path description: The entity identifier. required: true schema: type: string format: uuid - name: journeyId in: path description: The journey identifier. 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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \n otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementquery /api/documentrequirement/entity/{entityId}: get: tags: - DocumentRequirement summary: Gets all Document Requirement Statuses for an Entity Id description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetAllRequirementModelsByEntityId parameters: - name: entityId in: path description: The entity identifier. 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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \n otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementquery /api/documentrequirement/entity/paged/lite: post: tags: - DocumentRequirement summary: Gets a paginated list of lightweight Document Requirement models for a given… description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocRequirementsLiteByEntityIdQuery parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Pagination options including entity ID, start index and page size. content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedDocumentRequirementsRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedDocumentRequirementsRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedDocumentRequirementsRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedDocumentRequirementLiteResponseDto containing the paginated lightweight requirement models. content: text/plain: schema: $ref: '#/components/schemas/PagedDocumentRequirementLiteResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedDocumentRequirementLiteResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedDocumentRequirementLiteResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementquery /api/documentrequirement/journey/{journeyId}/dataKey/{documentDataKey}: get: tags: - DocumentRequirement summary: Gets a DocumentRequirementModel by Journey Id and DocumentDataKey description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetDocumentRequirementModelByJourneyIdandDocumentDataKey parameters: - name: journeyId in: path description: The journey identifier. required: true schema: type: string format: uuid - name: documentDataKey in: path description: The requirement identifier defined in policy configuration. required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \n otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document requirement model with given id and datakey does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /documentmanagementquery /api/v2/policies/{entityPolicyId}/document-requirements: post: tags: - DocumentRequirement summary: Create a new policy document requirement description: 'Creates a new document requirement within the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: postApiV2PoliciesByEntityPolicyIdDocumentRequirements parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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: Create document requirement request content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest_2' description: Service request data responses: '202': description: Success. Document requirement created content: application/json: schema: $ref: '#/components/schemas/CreateDocumentRequirementResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDocumentRequirement servers: - url: /policycommand /api/v2/policies/{entityPolicyId}/document-requirements/{documentRequirementId}: put: tags: - DocumentRequirement summary: Update a policy document requirement description: 'Updates an existing document requirement within the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: putApiV2PoliciesByEntityPolicyIdDocumentRequirementsByDocumentRequirementId parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: documentRequirementId in: path description: Document Requirement ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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: Update document requirement request content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDtoServiceRequest_2' description: Service request data responses: '202': description: Success. Document requirement updated content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentRequirementResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or document requirement with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateDocumentRequirement delete: tags: - DocumentRequirement summary: Delete a policy document requirement description: 'Deletes an existing document requirement from the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: DeleteDocumentRequirement parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: documentRequirementId in: path description: Document requirement ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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 deleted '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or document requirement with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v2/policies/{entityPolicyId}/document-requirements/{documentRequirementId}/revert: put: tags: - DocumentRequirement summary: Revert a policy document requirement changes description: 'Reverts changes made to an existing document requirement within the specified workspace context. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: RevertDocumentRequirement parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: documentRequirementId in: path description: Document requirement ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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 updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or document requirement with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v4/policies/{entityPolicyId}/document-requirements/{documentRequirementId}: get: tags: - DocumentRequirement summary: Get document requirement from specific policy description: 'Returns document requirement. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetDocumentRequirement parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: documentRequirementId in: path description: ID of the document requirement required: true schema: type: string format: uuid - name: workspaceId in: query description: ID of the workspace. If not provided, the default workspace will be used 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: Success. Document requirement is returned content: application/json: schema: $ref: '#/components/schemas/DocumentRequirementViewModelDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/document-requirements/{documentRequirementId}: get: tags: - DocumentRequirement summary: Get document requirement from specific version of the policy description: 'Returns document requirement. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetHistoricDocumentRequirement parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: documentRequirementId in: path description: ID of the document requirement required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 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: Success. Document requirement is returned content: application/json: schema: $ref: '#/components/schemas/DocumentRequirementViewModelDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/document-requirements: post: tags: - DocumentRequirement summary: Get document requirements from the current version of the policy description: 'Returns document requirements. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListDocumentRequirements parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: workspaceId in: query description: ID of the workspace. If not provided, the default workspace will be used 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: Defines pagination, sorting and filtering content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchEntityDocumentRequirementsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. List of document requirements is returned content: application/json: schema: $ref: '#/components/schemas/DocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/document-requirements: post: tags: - DocumentRequirement summary: Get document requirements from the current version of the policy description: 'Returns document requirements. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListHistoricDocumentRequirements parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 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: Defines pagination, sorting and filtering content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchEntityDocumentRequirementsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. List of document requirements is returned content: application/json: schema: $ref: '#/components/schemas/DocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery components: schemas: DocumentRequirementRequestDto: type: object properties: requirementId: type: - string - 'null' description: The Id of the requirement the document requirement belongs to example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5 requirementName: type: - string - 'null' description: The Name of the document requirement defined in policy configuration example: Driver License documentDataKey: type: - string - 'null' description: The unique identifier of the document requirement defined in policy configuration example: identificationDocuments isMandatory: type: boolean description: IsMandatory attribute of the document requirement defined in policy configuration example: false journeyId: type: - string - 'null' description: The Id of the journey the document requirement belongs to example: 315df981-38a0-4145-836b-8d22745887b6 entityId: type: - string - 'null' description: The Id of the entity the document requirement status is linked to example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769 status: type: - string - 'null' description: The status of the document requirement example: Submit for Approval comment: type: - string - 'null' description: A comment relating to the updated status of the document requirement targetEntity: type: - string - 'null' description: The target entity of the requirement example: Client deferUntil: type: - string - 'null' description: The deferral date of the document requirement if Status is set to Deferral Requested format: date-time example: null accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Document requirement access layers. The property is immutable. properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DocumentRequirementPropertyDto' description: Custom document requirement properties additionalProperties: false description: A document requirement model ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code UpdateDocumentRequirementPropertiesDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDto' description: Metadata required to update a document requirement model's custom properties messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateDocumentRequirementDto: type: object properties: status: type: - string - 'null' description: The status of the document requirement example: Submit for Approval comment: type: - string - 'null' description: A comment relating to the updated status of the document requirement deferUntil: type: - string - 'null' description: The deferral date of the document requirement if Status is set to Deferral Requested format: date-time example: null additionalProperties: false description: A document requirement model UpdateDocumentRequirementPropertiesDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DocumentRequirementPropertyDto' description: Custom document requirement properties additionalProperties: false description: Metadata required to update a document requirement model's custom properties ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateDocumentRequirementDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementDto' description: A document requirement model additionalProperties: false UpdateDocumentRequirementPropertiesDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementPropertiesDto' description: Metadata required to update a document requirement model's custom properties additionalProperties: false DocumentRequirementPropertyDto: type: object properties: value: type: - string - 'null' description: The custom property value example: Country additionalProperties: false description: Contains the attributes needed in order to add custom properties to the document requirement model DocumentRequirementResponseDto: type: object properties: id: type: string description: The Id of the Document Requirement format: uuid example: 8e306281-9c38-41b6-b264-31a901821ff3 requirementId: type: - string - 'null' description: The Id of the requirement the document requirement belongs to example: dfbe7566-8d61-42bd-a922-dcb21de17b94 requirementName: type: - string - 'null' description: The Name of the document requirement defined in policy configuration example: Driver License documentDataKey: type: - string - 'null' description: The unique identifier of the document requirement defined in policy configuration example: identificationDocuments isMandatory: type: boolean description: IsMandatory attribute of the document requirement defined in policy configuration example: false journeyId: type: - string - 'null' description: The Id of the journey the document requirement belongs to example: c8cf5092-6c6a-4bc5-9012-8234408849cf entityId: type: - string - 'null' description: The Id of the entity the document requirement status is linked to example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769 status: type: - string - 'null' description: The status of the document requirement example: Submit for Approval comment: type: - string - 'null' description: A comment relating to the updated status of the document requirement targetEntity: type: - string - 'null' description: The target entity of the requirement example: Client deferUntil: type: - string - 'null' description: The deferral date of the document requirement if Status is set to Deferral Requested format: date-time example: null properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DocumentRequirementPropertyDto' description: Custom document requirement properties additionalProperties: false description: A document requirement model ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AccessLayerDto: type: object properties: geographic: uniqueItems: true type: - array - 'null' items: type: string description: Collection of geographic access layers example: - Global businessRelated: uniqueItems: true type: - array - 'null' items: type: string description: Collection of business related access layers example: - Enterprise additionalProperties: false description: DTO representing access layers attached DocumentRequirementRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDto' description: A document requirement model additionalProperties: false DocumentRequirementResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementResponseDto' description: A document requirement model messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 DocumentRequirementModelDto: type: object properties: id: type: string description: The unique identifier of the document requirement status format: uuid example: baee4b61-7ebb-48b2-a44b-18ce814b703b requirementId: type: - string - 'null' description: The Id of the requirement the document requirement status belongs to example: 86581ed9-3ebc-4e7c-b26d-16c1849fa43e requirementName: type: - string - 'null' description: The Name of the document requirement defined in policy configuration example: Driver License documentDataKey: type: - string - 'null' description: The unique identifier of the document requirement defined in policy configuration example: identificationDocuments journeyId: type: - string - 'null' description: The Id of the journey the document requirement belongs to example: 742ac1df-1296-4620-aa44-a34e09e859f4 entityId: type: - string - 'null' description: The Id of the entity the document requirement status belongs to example: 742ac1df-1296-4620-aa44-a34e09e859f4 isMandatory: type: boolean description: IsMandatory attribute of the document requirement defined in policy configuration example: false targetEntity: type: - string - 'null' description: The target entity of the requirement example: Client history: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementHistoryDto' description: The history of the requirement containing all updates to the status accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Document requirement access layers hasRequiredAccessLayers: type: boolean description: 'Flag indicating if current user has required access layers to access document requirement model If false, the sensitive properties with be masked by replacing with null or empty values' linkedDocumentCount: allOf: - $ref: '#/components/schemas/LinkedDocumentCountDto' description: Overall count and count by type of documents uploaded against this requirement properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DocumentRequirementProperty' description: Custom document requirement properties additionalProperties: false description: Document Requirement data PagedDocumentRequirementsRequestDto: type: object properties: entityId: type: string description: Gets or sets the entity ID that the document requirements are associated with format: uuid example: 8e7c1e5d-3875-2c81-a2ae-5506f9a98b75 startIndex: type: integer description: Gets or sets the starting index for pagination format: int32 example: 0 pageSize: type: integer description: Gets or sets the size of the page (result set) format: int32 example: 50 additionalProperties: false description: Represents options for setting up the paginated results for document requirements DocumentRequirementProperty: type: object properties: value: type: - string - 'null' additionalProperties: false LinkedDocumentCountDto: type: object properties: overallCount: type: integer description: Total count of documents linked format: int32 countByType: type: - object - 'null' additionalProperties: type: integer format: int32 description: Count of documents attached by document type additionalProperties: false DocumentRequirementModelDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementModelDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocumentRequirementModelDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementModelDto' description: Document Requirement data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedDocumentRequirementsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PagedDocumentRequirementsRequestDto' description: Represents options for setting up the paginated results for document requirements additionalProperties: false DocumentRequirementModelLiteDto: type: object properties: id: type: string description: The unique identifier of the document requirement status format: uuid example: baee4b61-7ebb-48b2-a44b-18ce814b703b requirementId: type: - string - 'null' description: The Id of the requirement the document requirement status belongs to example: 86581ed9-3ebc-4e7c-b26d-16c1849fa43e requirementName: type: - string - 'null' description: The Name of the document requirement defined in policy configuration example: Driver License documentDataKey: type: - string - 'null' description: The unique identifier of the document requirement defined in policy configuration example: identificationDocuments journeyId: type: - string - 'null' description: The Id of the journey the document requirement belongs to example: 742ac1df-1296-4620-aa44-a34e09e859f4 entityId: type: - string - 'null' description: The Id of the entity the document requirement status belongs to example: 742ac1df-1296-4620-aa44-a34e09e859f4 isMandatory: type: boolean description: IsMandatory attribute of the document requirement defined in policy configuration example: false targetEntity: type: - string - 'null' description: The target entity of the requirement example: Client accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Document requirement access layers hasRequiredAccessLayers: type: boolean description: 'Flag indicating if current user has required access layers to access document requirement model If false, the sensitive properties with be masked by replacing with null or empty values' linkedDocumentCount: allOf: - $ref: '#/components/schemas/LinkedDocumentCountDto' description: Overall count and count by type of documents uploaded against this requirement additionalProperties: false description: Document Requirement data AccessLayerDto_2: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers example: - Global businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers example: - Enterprise additionalProperties: false description: DTO representing access layers attached DocumentRequirementHistoryDto: type: object properties: status: type: - string - 'null' description: The Status of the Document Requirement example: Approved lastUpdated: type: string description: The date that the Document Requirement was last updated format: date-time comment: type: - string - 'null' description: A comment relating to the Document Requirement Status change deferUntil: type: - string - 'null' description: The deferral date of the requirement. This is only set if Status is "Defer Requested" format: date-time additionalProperties: false description: Document Requirement History PagedDocumentRequirementLiteResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PagedDocumentRequirementLiteResponseDto' description: Represents a paginated response containing lightweight document requirement models for an entity messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedDocumentRequirementLiteResponseDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementModelLiteDto' description: Gets or sets the collection of lightweight document requirement models itemsCount: type: integer description: Gets or sets the number of items in the current page format: int32 totalPagedItemsReturned: type: integer description: Gets or sets the total number of paged items returned so far (startIndex + pageSize) format: int32 hasMoreItems: type: boolean description: Gets or sets a value indicating whether there are more items available beyond the current page additionalProperties: false description: Represents a paginated response containing lightweight document requirement models for an entity DocumentRequirementRequestDto_2: required: - categories - conditions - dataKey - description - jurisdictionIds - name - references - tags - targetEntities type: object properties: name: maxLength: 700 minLength: 1 type: string description: Name of the document requirement example: First Name dataKey: maxLength: 700 minLength: 1 type: string description: Data key for the document requirement example: firstName description: maxLength: 1200 minLength: 1 type: string description: Description of the document requirement example: Client's first name tooltipDescription: maxLength: 1200 type: - string - 'null' description: Description of the document requirement tooltip example: Client's first name classification: type: - string - 'null' description: Classification of the document requirement example: FATCA categories: minItems: 1 type: array items: maxLength: 250 minLength: 1 type: string description: Categories the document requirement belongs to example: - Basic Details - Personal Information targetEntities: minItems: 1 type: array items: type: string description: Target entities for the document requirement example: - Client accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_3' description: Access layers for the document requirement references: type: array items: $ref: '#/components/schemas/ReferenceDto' description: References for the document requirement conditions: type: array items: $ref: '#/components/schemas/ConditionDto' description: Conditions for the document requirement legacyValidationRules: allOf: - $ref: '#/components/schemas/ValidationRuleDto' description: Legacy Validation Rule - required for compatibility deprecated: true validationRules: allOf: - $ref: '#/components/schemas/DocumentRequirementValidationRulesDto' description: Request DTO representing validation data for document requirements acceptableDocumentTypes: type: - array - 'null' items: type: string description: Acceptable document types for the document requirement tags: type: array items: type: string description: Tags for the document requirement example: - Required - Personal jurisdictionIds: minItems: 1 type: array items: type: string format: uuid description: 'A collection of unique identifiers that represent jurisdictions associated with the policy document requirement.' dataProtectionJurisdictionId: type: - string - 'null' description: Identifier for the jurisdiction in which the data protection regulations apply format: uuid additionalProperties: false description: Create policy document requirement BasicRuleDtoValidationRuleDto: required: - staticRule type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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 ExternalProviderRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata AccessLayerDto_3: required: - businessRelated - geographic type: object properties: geographic: type: array items: maxLength: 500 minLength: 1 type: string description: Collection of geographic access layers businessRelated: type: array items: maxLength: 500 minLength: 1 type: string description: Collection of business related access layers additionalProperties: false description: DTO representing associated access layers UpdateDocumentRequirementResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDocumentRequirementResponseDto' description: Represents the response for creating an updated policy document requirement. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection additionalProperties: false description: Request DTO representing validation data metadata ReferenceDto: required: - description - type - url type: object properties: type: maxLength: 256 minLength: 1 type: string description: Reference type example: FATCA description: maxLength: 2048 minLength: 1 type: string description: Reference description example: Foreign Account Tax Compliance Act url: maxLength: 2048 minLength: 1 type: string description: Reference URL example: www.irs.gov additionalProperties: false description: Request DTO representing reference metadata CollectionMaximumCountRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata ValueLimitRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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: 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 DocumentRequirementRequestDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementRequestDto_2' description: Create policy document requirement additionalProperties: false description: Service request data ConditionDto: required: - logicalOperation - name - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root example: id: 118313c6-91e6-4b05-a537-5a1ab906418f name: Company-type only description: Applicable only when EntityType=Company logicalOperation: AND operands: - fieldName: EntityType value: - string valueType: text operation: equal operands: [] ServiceResponse_2: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValueField: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false BasicRuleDto2: required: - errorMessage type: object properties: errorMessage: minLength: 1 type: string description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} CollectionMinimumCountRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ValidationRuleDto: type: object properties: id: type: string description: The UiD of the validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set/data group format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 propertyId: type: string description: The UiD of the requirement/data group field format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 dataGroupId: type: - string - 'null' description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup" format: uuid example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c isDataGroup: type: boolean description: Flag indicating it is validation rules for data group field example: true propertyName: type: - string - 'null' description: Requirement/data group field property name example: firstName friendlyName: type: - string - 'null' description: Requirement/data group field friendly Name example: First Name validationType: type: - string - 'null' description: Validation type example: text validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Request DTO representing validation data metadata additionalProperties: false description: Request DTO representing validation rule metadata DateLimitRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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 DocumentRequirementValidationRulesDto: type: object properties: mandatory: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Mandatory Rule - does not allow empty value additionalProperties: false description: Request DTO representing validation data for document requirements CreateDocumentRequirementResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateDocumentRequirementResponseDto' description: Represents the response for creating a new policy document requirement. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdateDocumentRequirementResponseDto: required: - documentRequirementId - documentRequirementVersion type: object properties: documentRequirementId: type: string description: Gets the unique identifier for a policy document requirement. format: uuid example: 10ea5b77-9cdf-4add-9158-778a33811653 documentRequirementVersion: type: integer description: Version number of the policy document requirement. format: int32 example: 7 additionalProperties: false description: Represents the response for creating an updated policy document requirement. ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition RegexRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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 ServiceResponseMessage_2: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response CreateDocumentRequirementResponseDto: required: - documentRequirementId type: object properties: documentRequirementId: type: string description: Gets the unique identifier for a policy document requirement. format: uuid example: e8283926-9059-4381-99b7-4f7e3da99a83 additionalProperties: false description: Represents the response for creating a new policy document requirement. BasicRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Static validation rule always applied when active additionalProperties: false SearchEntityDocumentRequirementsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchEntityDocumentRequirementsRequestDto' description: Represents a request DTO for searching document requirements additionalProperties: false description: Service request data SearchEntityDocumentRequirementsFiltersDto: type: object properties: filterText: type: - string - 'null' description: 'Name of the resource or entity to be filtered. It searches in the Name, DataKey, Jurisdictions and Categories. Requires at least 2 characters. Leave as null to ignore this filter.' example: Driving Licence changeTypes: type: - array - 'null' items: type: string description: Change type of the resource. Leave as null to ignore this filter. example: - Unchanged mandatoryTypes: type: - array - 'null' items: type: string description: Mandatory type of the document requirement. Leave as null to ignore this filter. example: - Required jurisdictions: type: - array - 'null' items: type: string description: List of jurisdictions to be filtered. Leave as null to ignore this filter. example: - Global targetEntities: type: - array - 'null' items: type: string description: List of target entities to be filtered. Leave as null to ignore this filter. example: - Client categories: type: - array - 'null' items: type: string description: Categories the document requirement belongs to. Leave as null to ignore this filter. example: - Basic Details - Personal Information tags: type: - array - 'null' items: type: string description: Field tags. Leave as null to ignore this filter. example: - PII additionalProperties: false description: Represents a data transfer object used for filtering document requirements in a policy. AccessLayerDto_4: type: object properties: geographic: type: - array - 'null' items: type: string businessRelated: type: - array - 'null' items: type: string additionalProperties: false JurisdictionNameViewModelDto: type: object properties: jurisdictionId: type: string description: Unique identifier of jurisdiction format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b name: type: - string - 'null' description: Name of Jurisdiction example: Global additionalProperties: false description: Jurisdiction DTO ReferenceDto_2: type: object properties: type: type: - string - 'null' description: type: - string - 'null' url: type: - string - 'null' additionalProperties: false SearchEntityDocumentRequirementsRequestDto: type: object properties: sortBy: enum: - Name - DataKey - ChangeType - MandatoryType - TargetEntities - Categories - Jurisdictions - Tags type: - string - 'null' description: The column by which the results should be sorted. example: Name sortDirection: enum: - Ascending - Descending type: - string - 'null' description: The direction in which the results should be sorted (e.g., Ascending or Descending). example: Ascending pageSize: maximum: 100 type: integer description: The maximum number of records to be returned in a single page of the query result. format: int32 example: 100 exclusiveMinimum: 0 paginationToken: type: - string - 'null' description: 'A token used to represent the current position in a paginated result set. It is utilized primarily to fetch the next set of results in a query or search operation.' filters: allOf: - $ref: '#/components/schemas/SearchEntityDocumentRequirementsFiltersDto' description: Filters applied to narrow down the search results for document requirements. additionalProperties: false description: Represents a request DTO for searching document requirements DocumentRequirementViewModelDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementViewModelDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data BasicRuleDto_2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata ConditionDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root DocumentRequirementSearchViewModelDtoItemsPageWithTotal: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRequirementSearchViewModelDto' description: The items result set paginationToken: type: - string - 'null' description: The token for retrieving the next page of results totalCount: type: integer format: int64 additionalProperties: false LockDetailsDto: type: object properties: lockedByWorkspaceId: type: string format: uuid lockedByWorkspaceName: type: - string - 'null' lockChangeType: enum: - Updated - Deleted type: - string - 'null' additionalProperties: false DocumentRequirementSearchViewModelDto: type: object properties: entityPolicyId: type: string description: Unique identifier of policy format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b versionNumber: type: integer description: Version number of the policy format: int32 example: 1 documentRequirementId: type: string description: Unique identifier of document requirement format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b documentRequirementVersion: type: integer description: Version number of the document requirement format: int32 example: 2 changeType: enum: - Unchanged - Added - Updated - Deleted - Locked type: - string - 'null' description: Change type of the document requirement example: Unchanged lockDetails: allOf: - $ref: '#/components/schemas/LockDetailsDto' description: Details of the lock. Null if the ChangeType is not Locked. mandatoryType: enum: - Optional - Required - Conditional type: - string - 'null' description: Mandatory type of the document requirement example: Required name: type: - string - 'null' description: Name of the document requirement example: First Name dataKey: type: - string - 'null' description: Data key for the document requirement example: firstName categories: type: - array - 'null' items: type: string description: Categories the document requirement belongs to. Sorted alphabetically. example: - Basic Details - Personal Information targetEntities: type: - array - 'null' items: type: string description: Target entities for the document requirement. Sorted alphabetically. example: - Client jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/JurisdictionNameViewModelDto' description: Jurisdictions the document requirement applies to. Sorted alphabetically by jurisdiction name. tags: type: - array - 'null' items: type: string description: Tags for the document requirement. Sorted alphabetically. example: - Required - Personal additionalProperties: false description: 'Represents an object for searching policy document requirements, containing document requirements metadata, categorization, and associated policy information.' DocumentRequirementSearchViewModelDtoItemsPageWithTotalServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentRequirementSearchViewModelDtoItemsPageWithTotal' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DocumentRequirementViewModelDto: type: object properties: entityPolicyId: type: string format: uuid versionNumber: type: integer format: int32 documentRequirementId: type: string format: uuid documentRequirementVersion: type: integer format: int32 changeType: enum: - Unchanged - Added - Updated - Deleted - Locked type: - string - 'null' lockDetails: allOf: - $ref: '#/components/schemas/LockDetailsDto' name: type: - string - 'null' dataKey: type: - string - 'null' description: type: - string - 'null' tooltipDescription: type: - string - 'null' classification: type: - string - 'null' categories: type: - array - 'null' items: type: string targetEntities: type: - array - 'null' items: type: string accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_4' references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto_2' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' validationRules: allOf: - $ref: '#/components/schemas/DocumentRequirementValidationRulesDto' description: Request DTO representing validation data for document requirements acceptableDocumentTypes: type: - array - 'null' items: type: string tags: type: - array - 'null' items: type: string jurisdictionIds: type: - array - 'null' items: type: string format: uuid dataProtectionJurisdictionId: type: - string - 'null' format: uuid additionalProperties: false ServiceResponseMessage_3: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response 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 - fenergo-policycommand-v2-0-openapi.json - fenergo-policyquery-v4-0-openapi.json