openapi: 3.2.0 info: title: Fenergo Nebula Document Management Query Product Document… description: Query API to get the documents information to show in the UI. version: '1.0' servers: - url: /documentmanagementquery security: - Bearer: [] tags: - name: ProductDocumentModel paths: /api/product/documentmanagement/product/{productId}: get: tags: - ProductDocumentModel summary: Get all documents by entity id description: 'This method will get the document data for the entity id and a tenant ID. Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetAllProductDocumentsByProductId parameters: - name: productId in: path description: product id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \n productId, if found; otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/paged: post: tags: - ProductDocumentModel summary: Retrieves paginated document models based on a specific product ID and tenant ID description: 'This method fetches document models in a paginated manner for a given product ID and tenant ID. Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocumentsByProductId parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata content: text/plain: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' '400': description: Bad request. The request contains invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/paged/lite: post: tags: - ProductDocumentModel summary: Retrieves paginated lite document models based on a specific product ID and… description: 'This method fetches lightened document models in a paginated manner for a given product ID and tenant ID Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocumentsLiteByProductId parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsLiteResponseDto object representing the paginated list of lightened document metadata content: text/plain: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' '400': description: Bad request. The request contains invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/paged/status: post: tags: - ProductDocumentModel summary: Retrieves paginated document models based on a specific product ID, tenant ID… description: 'This method fetches document models in a paginated manner for a given product ID, tenant ID and status Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocumentsByProductIdAndStatus 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: Paged entity documents request content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata content: text/plain: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' '400': description: Bad request. The request contains invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/paged/status/lite: post: tags: - ProductDocumentModel summary: Retrieves paginated lightened document models based on a specific product ID… description: 'This method fetches lightened document models in a paginated manner for a given product ID, tenant ID and status Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocumentsLiteByEntityIdAndStatusQuery 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: Paged entity documents request content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata content: text/plain: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' '400': description: Bad request. The request contains invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/paged/excludeStatus: post: tags: - ProductDocumentModel summary: Retrieves paginated document models based on a specific product ID and tenant… description: 'This method fetches document models in a paginated manner for a given product ID and tenant ID, excluding documents with the specified status Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocumentsByProductIdExcludingStatus 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: Paged entity documents request content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata content: text/plain: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' '400': description: Bad request. The request contains invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/paged/excludeStatus/lite: post: tags: - ProductDocumentModel summary: Retrieves paginated lightened document models based on a specific product ID… description: 'This method fetches lightened document models in a paginated manner for a given product ID and tenant ID, excluding documents with the specified status Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetPagedDocumentsByProductIdExcludingStatusLite 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: Paged entity documents request content: application/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDtoServiceRequest' responses: '200': description: A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.PagedEntityDocumentsResponseDto object representing the paginated list of document metadata content: text/plain: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/PagedEntityDocumentsResponseDtoServiceResponse' '400': description: Bad request. The request contains invalid values. content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/product/{productId}/journey/{journeyId}: get: tags: - ProductDocumentModel summary: Gets all Document Models for an Entity Id and Journey Id description: 'Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetAllModelsByProductIdAndJourneyId parameters: - name: productId 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.DocumentModelDto class representing the document models if found; \n otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/{id}: get: tags: - ProductDocumentModel summary: Get a document by id and tenant description: 'This method will get the document data for the document id and a tenant ID. Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetProductDocumentModelById parameters: - name: id in: path description: Id of an existing document required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: "An instance of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \n id, if found; otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentModelDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentModelDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentModelDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. Document model 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 /api/product/documentmanagement/journey/{journeyId}: get: tags: - ProductDocumentModel summary: Get all documents by journey id description: 'This method will get the document data for the journey id and a tenant ID. Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetAllProductDocumentsByJourneyId parameters: - name: journeyId in: path description: Journey id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentModelDto class representing the document metadata with the specified \n journeyId, if found; otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocumentModelDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product/documentmanagement/signedurl/{id}: get: tags: - ProductDocumentModel summary: Method to get a signed URL from S3 description: 'This method will generate a URL that will allow the user to open the document in the browser. The URL is signed by the AWS S3 service and the token will expire in a short time. Required permissions: Following permissions are required: DocumentManagementAccess' operationId: GetSignedUrlForProductDocument parameters: - name: id in: path description: Id of document required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: "An url to access the file uploaded for the document with the specified \n id, if found; otherwise, `null`." content: text/plain: schema: $ref: '#/components/schemas/StringServiceResponse' application/json: schema: $ref: '#/components/schemas/StringServiceResponse' text/json: schema: $ref: '#/components/schemas/StringServiceResponse' '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. If no signed url is found 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 /api/product/documentmanagement/mimeTypesAllowed: get: tags: - ProductDocumentModel summary: Get all supported mime types when uploading a file in the document requirements description: 'This method will return a list of supported mime types when uploading a file in the document requirements. Required permissions: Following permissions are required: DocumentManagementCreate' operationId: GetMimeTypesAllowedForProduct parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: A list of string of mime types content: text/plain: schema: $ref: '#/components/schemas/StringIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/StringIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/StringIEnumerableServiceResponse' '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 components: schemas: DocumentModelDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentModelDto' description: Document metadata messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedEntityDocumentsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false 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 DocumentEntityType: type: object properties: name: type: - string - 'null' readOnly: true id: type: integer format: int32 readOnly: true additionalProperties: false PagedEntityDocumentsStatusRequestDto: type: object properties: entityId: type: string description: Gets or sets the entity ID that the documents are associated with format: uuid example: 8e7c1e5d-3875-2c81-a2ae-5506f9a98b75 startIndex: type: integer description: Gets or sets the starting index for pagination or sublist operations format: int32 example: 0 pageSize: type: integer description: Gets or sets the size of the page (result set) format: int32 example: 1000 deduplicationEnabled: type: boolean description: Gets or sets a flag indicating whether deduplication of document models is to be applied example: false status: type: - string - 'null' description: Gets or sets a document status to be either excluded or included based on the query type example: Processing | Completed | Auto Classifying additionalProperties: false description: Represents options for setting up the results page PagedEntityDocumentsStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsStatusRequestDto' description: Represents options for setting up the results page additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false Property: type: object properties: value: type: - string - 'null' type: type: - string - 'null' customTypeId: type: string format: uuid properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/Property' example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AccessLayerDto: 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 StringIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: type: string messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedEntityDocumentsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PagedEntityDocumentsRequestDto' description: Represents options for setting up the results page additionalProperties: false DocumentModelDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DocumentModelDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PagedEntityDocumentsResponseDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/DocumentModelDto' description: The items result set itemsCount: type: integer description: The count of the items result set format: int32 totalPagedItemsReturned: type: integer description: The number of items returned collectively format: int32 hasMoreItems: type: boolean description: Indicates if there is any more items to retrieve additionalProperties: false DocumentModelDto: type: object properties: id: type: string description: The unique identifier of the document format: uuid example: baee4b61-7ebb-48b2-a44b-18ce814b703b fileName: type: - string - 'null' description: File name documentRequirementIds: uniqueItems: true type: - array - 'null' items: type: string description: List of Document Requirement Ids that the document is linked to documentDataKey: type: - string - 'null' description: The unique identifier of the document requirement that the document is linked to example: identificationDocuments documentType: type: - string - 'null' description: Document type example: Driver license documentKey: type: - string - 'null' description: The Reference key for the physical File example: 18036e2d-9cd9-4f00-bce0-094fa5611e6d/11b4c7f6-32b9-4025-a57f-f003a9d93262_testFile.png status: type: - string - 'null' description: The status of the uploaded document example: Complete errorCode: type: - string - 'null' description: 'The Error Code associated with an Error Status Fenergo.Nebula.DocumentManagement.Domain.Enum.DocumentErrorCodeINVALID_MIME_TYPE' errorMessage: type: - string - 'null' description: An Error message to be associated with an Error Status journeyId: type: - string - 'null' description: The Id of the journey the Document is uploaded against example: 69f0009b-d80d-4469-997f-708147190e1d entityId: type: - string - 'null' description: The Id of the entity the Document is uploaded against example: 69f0009b-d80d-4469-997f-708147190e1d properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/Property' description: Custom document properties. example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Document access layers. Can be only additive in relation to the PolicyEnforcedAccessLayers policyEnforcedAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Access layers enforced by policy. The minimal set of access layers. The property is immutable hasRequiredAccessLayers: type: boolean description: 'Flag indicating if current user has required access layers to access document model If false, the sensitive properties with be masked by replacing with null or empty values' documentEntityType: allOf: - $ref: '#/components/schemas/DocumentEntityType' description: The type of the Entity. uploadedBy: type: - string - 'null' description: Identifier of user who uploaded the document example: 9dee5f0c-08a3-4cb2-83bf-514c75d324ef uploadedByUserName: type: - string - 'null' description: UserName of user who uploaded the document example: user@fenergo.com uploadedOn: type: - string - 'null' description: Date and time the document was uploaded on format: date-time example: '2023-04-03T14:30:00.000Z' lastUpdatedOn: type: - string - 'null' description: Date and time the document was last updated on format: date-time example: '2023-04-03T14:30:00.000Z' lastUpdatedBy: type: - string - 'null' description: Identifier of user who last updated the document example: 9dee5f0c-08a3-4cb2-83bf-514c75d324ef metadata: type: - object - 'null' additionalProperties: type: - string - 'null' description: Additional Metadata in key-value form explanation: type: - string - 'null' description: Explains why given category has been assigned to document documentURL: type: - string - 'null' description: URL of the virtual file isVirtual: type: boolean description: Flag indicating whether the document is virtual readOnly: true archivalReason: type: - string - 'null' description: The reason of the archival preArchivalStatus: type: - string - 'null' description: The status before the archival deletionRequestedBy: type: - string - 'null' description: Identifier of user who requested deletion deletionRequestedReason: type: - string - 'null' description: Reason provided when deletion was requested deletionRequestedOn: type: - string - 'null' description: Date and time when deletion was requested format: date-time isCloned: type: boolean description: Indicates whether the document was brought forward (cloned) from a prior journey clonedFromDocumentModelId: type: - string - 'null' description: The Id of the document model this was cloned from, if applicable format: uuid additionalProperties: false description: Document metadata PagedEntityDocumentsRequestDto: type: object properties: entityId: type: string description: Gets or sets the entity ID that the documents are associated with format: uuid example: 8e7c1e5d-3875-2c81-a2ae-5506f9a98b75 startIndex: type: integer description: Gets or sets the starting index for pagination or sublist operations format: int32 example: 0 pageSize: type: integer description: Gets or sets the size of the page (result set) format: int32 example: 1000 deduplicationEnabled: type: boolean description: Gets or sets a flag indicating whether deduplication of document models is to be applied example: false additionalProperties: false description: Represents options for setting up the results page 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 securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header