openapi: 3.2.0 info: title: Fenergo Doc Gen Component API version: '1.0' description: 'Operations tagged DocGenComponent across 2 of this provider''s published API definitions: fenergo-docgencommand-v1-0-openapi.json, fenergo-docgenquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /docgencommand - url: /docgenquery security: - Bearer: [] tags: - name: DocGenComponent paths: /api/docgencomponent: post: tags: - DocGenComponent summary: Create a new doc gen component library description: 'Create a new doc gen component library and store it in the database. Required permissions: Following permissions are required: DocGenConfigurationCreate' operationId: CreateDocGenComponentLibrary 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: Create doc gen component library request content: application/json: schema: $ref: '#/components/schemas/CreateDocGenComponentLibraryRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateDocGenComponentLibraryRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateDocGenComponentLibraryRequestDtoServiceRequest' responses: '202': description: Success. Doc gen component library created content: text/plain: schema: $ref: '#/components/schemas/CreateDocGenComponentLibraryResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocGenComponentLibraryResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocGenComponentLibraryResponseDtoServiceResponse' '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 get: tags: - DocGenComponent summary: Get all global doc gen component librarys for the client tenant description: 'This method returns all doc gen component library with lite versions for a given tenant. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetDocGenComponentLibrary 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: Success. The list of doc gen component librarys is returned content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentLibraryDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DocGenComponentLibraryDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DocGenComponentLibraryDtoIEnumerableServiceResponse' '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 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: /docgencommand /api/docgencomponent/{id}: delete: tags: - DocGenComponent summary: Delete an existing doc gen component library and all its versions description: 'Deletes an existing doc gen component library and all its versions. Required permissions: Following permissions are required: DocGenConfigurationDelete' operationId: DeleteDocGenComponentLibrary parameters: - name: id in: path description: Id for Doc Gen Component Library to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Invalid 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 get: tags: - DocGenComponent summary: Get an existing global doc gen component library with lite versions by Set Id description: 'This method returns existing global doc gen component library for given set id. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetDocGenComponentLibraryById parameters: - name: id in: path 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: Success. Global doc gen component library is returned content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentLibraryDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocGenComponentLibraryDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocGenComponentLibraryDtoServiceResponse' '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. A set 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/draft: post: tags: - DocGenComponent summary: Create a new version for a doc gen component version description: 'This method creates a doc gen component version. The new version initializes with the DTO data. It is assigned the next available version number, the default status of Draft and the Author as the only required Signee. Required permissions: At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate' operationId: CreateDocGenComponentVersion parameters: - name: id in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version that the new version is based on required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse' '400': description: Invalid request 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: Doc Gen Component Library with given ID does not exists 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: /docgencommand /api/docgencomponent/{id}/emptydraft: post: tags: - DocGenComponent summary: Create a new version for a doc gen component version without data description: 'This method creates a doc gen component version but with no components or data from any previous version. The new version initializes with the DTO data. It is assigned the next available version number, the default status of Draft and the Author as the only required Signee. Required permissions: At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate' operationId: CreateDocGenComponentEmptyVersion parameters: - name: id in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse' '400': description: Invalid request 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: Doc Gen Component Library with given ID does not exists 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}: put: tags: - DocGenComponent summary: Update an existing doc gen component version description: 'This method updates an existing doc gen component version. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: UpdateDocGenComponentVersion parameters: - name: id in: path description: The Id of the existing component library required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update doc gen component request content: application/json: schema: $ref: '#/components/schemas/UpdateDocGenComponentVersionRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateDocGenComponentVersionRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateDocGenComponentVersionRequestDtoServiceRequest' responses: '202': description: Accepted for processing '400': description: Invalid request 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: Doc gen component library with given ID does not exists 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 delete: tags: - DocGenComponent summary: Delete a doc gen component version description: 'Deletes the selected version of an existing doc gen component library. If the deleted version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as deleted and become unavailable. Required permissions: Following permissions are required: DocGenConfigurationDelete' operationId: DeleteDocGenComponentVersion parameters: - name: id in: path description: Doc Gen Component library id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. The specified version deleted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Doc Gen Component library 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 get: tags: - DocGenComponent summary: Get an existing doc gen component version by Set Id and version number description: 'This method returns an existing doc gen component version for a given set id and version number. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetDocGenComponentVersionBySetIdAndVersionNumber parameters: - name: id in: path required: true schema: type: string format: uuid - name: versionNumber in: path required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Doc Gen Component version is returned content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse_2' '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. A version with given set id and version number 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/submit-for-approval: put: tags: - DocGenComponent summary: Submit an existing doc gen component version for Approval description: 'This method submits the selected doc gen component of an existing set for Approval. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: SubmitDocGenComponentVersion parameters: - name: id in: path description: The Id of the existing component library required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Validation error 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: Doc Gen Component library with given ID does not exists 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/sign: put: tags: - DocGenComponent summary: Sign an existing doc gen component version description: 'This method signs the selected doc gen component version of an existing set. The Status of the version changes according to the action sent (Approve/Reject). Required permissions: Following permissions are required: DocGenConfigurationApprove' operationId: SignDocGenComponentVersion parameters: - name: id in: path description: The Id of the existing set required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data content: application/json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' text/json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/VersionSignResponseServiceResponse' application/json: schema: $ref: '#/components/schemas/VersionSignResponseServiceResponse' text/json: schema: $ref: '#/components/schemas/VersionSignResponseServiceResponse' '400': description: Validation error 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: Doc Gen Component library with given ID does not exists 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/archive: put: tags: - DocGenComponent summary: Archive an existing doc gen component version description: 'This method archives the selected doc gen component version of an existing library. Required permissions: Following permissions are required: DocGenConfigurationArchive' operationId: ArchiveDocGenComponentVersion parameters: - name: id in: path description: The Id of the existing set required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Validation error 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: Doc Gen Component Library with given ID does not exists 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/components: post: tags: - DocGenComponent summary: Add a component description: 'Adds a new component to an existing component library. Returns the id of the created component. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: AddDocGenComponent parameters: - name: id in: path description: Library id required: true schema: type: string format: uuid - name: versionNumber in: path description: Component library version number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Add component request content: application/json: schema: $ref: '#/components/schemas/CreateNewComponentDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateNewComponentDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateNewComponentDtoServiceRequest' responses: '202': description: Success. Component added content: text/plain: schema: $ref: '#/components/schemas/CreateDocGenComponentResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocGenComponentResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocGenComponentResponseDtoServiceResponse' '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. Component library 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 put: tags: - DocGenComponent summary: Update component description: 'Updates an existing component in specific component version. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: UpdateDocGenComponent parameters: - name: id in: path description: Component library id required: true schema: type: string format: uuid - name: versionNumber in: path description: Component library version number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update component request content: application/json: schema: $ref: '#/components/schemas/UpdateDocGenComponentDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateDocGenComponentDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateDocGenComponentDtoServiceRequest' responses: '202': description: Success. Component updated content: text/plain: schema: $ref: '#/components/schemas/UpdateDocGenComponentResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/UpdateDocGenComponentResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/UpdateDocGenComponentResponseDtoServiceResponse' '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. Component library with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/components/multiple: post: tags: - DocGenComponent summary: Add mulitple components description: 'Adds multiple components to an existing component version. Returns the ids of the created components. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: AddDocGenComponents parameters: - name: id in: path description: Component library id required: true schema: type: string format: uuid - name: versionNumber in: path description: Component library version number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Add components request content: application/json: schema: $ref: '#/components/schemas/CreateDocGenComponentsRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateDocGenComponentsRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateDocGenComponentsRequestDtoServiceRequest' responses: '202': description: Success. Components added content: text/plain: schema: $ref: '#/components/schemas/CreateDocGenComponentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateDocGenComponentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateDocGenComponentsResponseDtoServiceResponse' '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. Component library 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: /docgencommand /api/docgencomponent/{id}/versions/{versionNumber}/components/{componentId}: delete: tags: - DocGenComponent summary: Delete a component description: 'Deletes an existing component in specific component library. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: DeleteDocGenComponent parameters: - name: id in: path description: Component library id required: true schema: type: string format: uuid - name: versionNumber in: path description: Compomnent library version number required: true schema: type: integer format: int32 - name: componentId in: path description: Component id to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Component deleted '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Component library/component 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 get: tags: - DocGenComponent summary: Get component by id description: 'Returns component by given component library id, component library version number and component id. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetComponentById parameters: - name: id in: path description: Component library id required: true schema: type: string format: uuid - name: versionNumber in: path description: Component libraryversion number required: true schema: type: integer format: int32 - name: componentId in: path description: Component 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: Success. Component is returned content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/DocGenComponentDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/DocGenComponentDtoServiceResponse' '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. Component library/component with given id/version 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: /docgencommand /api/docgencomponent/versions/latest: get: tags: - DocGenComponent summary: Get the latest active version of doc gen component for the client tenant description: 'This method returns the latest active version of doc gen component for a given tenant Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetLatestDocGenComponentVersion parameters: - name: templateSetId in: query schema: type: string format: uuid - name: templateVersionNumber in: query schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Doc Gen Component version is returned content: text/plain: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/DocGenComponentVersionDtoServiceResponse_2' '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. An active version for a given tenant 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: /docgenquery components: schemas: UpdateDocGenComponentVersionRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateDocGenComponentVersionRequestDto' additionalProperties: false CreateDocGenComponentLibraryResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateDocGenComponentLibraryResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DataSourceQueryParameterDto: type: object properties: datasource: type: - string - 'null' description: Datasource name conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) nestedDataSourceQueryParameter: $ref: '#/components/schemas/DataSourceQueryParameterDto' additionalProperties: false VersionSignResponse: type: object properties: setId: type: string description: The Id of the set model that the version belongs to format: uuid versionNumber: type: integer description: The number of the version that has been signed format: int32 status: $ref: '#/components/schemas/VersionStatus' additionalProperties: false CreateDocGenComponentLibraryResponseDto: type: object properties: id: type: string description: Id of the component library created format: uuid version: $ref: '#/components/schemas/DocGenComponentVersionDto' additionalProperties: false DocGenComponentVersionDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/DocGenComponentVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateDocGenComponentsRequestDto: type: object properties: components: type: - array - 'null' items: $ref: '#/components/schemas/CreateNewComponentDto' description: List of the components to be created additionalProperties: false CreateDocGenComponentResponseDto: type: object properties: id: type: string description: The UiD of the created component format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f additionalProperties: false description: Response DTO representing created component Instance CreateNewComponentDto: type: object properties: type: type: - string - 'null' description: Type of component. Text/ Table/ Loop/ LoopText/ LoopTable example: Text componentKey: type: - string - 'null' description: key name for this component. this must be unique datasource: type: - string - 'null' description: Related Product/MainEntity deprecated: true datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) deprecated: true valueType: type: - string - 'null' description: Text/Number/Date dataSourceQueryParameter: $ref: '#/components/schemas/DataSourceQueryParameterDto' parentId: type: - string - 'null' description: 'Id of the parent object that the component belongs to, e.g. Id of a LoopComponent. This field is relevant only when the component has a parent object.' format: uuid columns: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableColumnDto' description: Columns in this table id: type: string description: The UiD of the component format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd additionalProperties: false DocGenComponentVersionDto: type: object properties: id: type: string description: Id of the version format: uuid setId: type: string description: Id of the component library that the version belongs to format: uuid name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T00:00:00.000Z' status: $ref: '#/components/schemas/VersionStatus' created: type: string description: The creation date of the version format: date-time example: '2021-12-12T15:55:00.000Z' additionalProperties: false VersionSignResponseServiceResponse: type: object properties: data: $ref: '#/components/schemas/VersionSignResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateDocGenComponentsRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateDocGenComponentsRequestDto' additionalProperties: false UpdateDocGenComponentVersionRequestDto: type: object properties: id: type: string description: Id of the version to update format: uuid setId: type: string description: Id of the doc gen component library that the version belongs to format: uuid name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version versionNumber: type: integer description: The version number of the version to update format: int32 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T00:00:00.000Z' additionalProperties: false ConditionDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' additionalProperties: false UpdateDocGenComponentDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateDocGenComponentDto' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateDocGenComponentLibraryRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateDocGenComponentLibraryRequestDto' additionalProperties: false ValueField: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false Decision: enum: - Approve - Reject type: string UpdateDocGenComponentResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/UpdateDocGenComponentResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ApproveActionServiceRequest: type: object properties: data: $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateDocGenComponentsResponseDto: type: object properties: componentIds: type: - array - 'null' items: type: string format: uuid 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 CreateDocGenComponentResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateDocGenComponentResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateDocGenComponentLibraryRequestDto: type: object properties: name: type: - string - 'null' description: Name of the component library description: type: - string - 'null' description: Description for the component library additionalProperties: false ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' valueField: $ref: '#/components/schemas/ValueField' additionalProperties: false UpdateDocGenComponentDto: type: object properties: type: type: - string - 'null' description: Type of component. Text/ Table/ Loop/ LoopText/ LoopTable example: Text componentKey: type: - string - 'null' description: key name for this component. this must be unique datasource: type: - string - 'null' description: Related Product/MainEntity deprecated: true datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) deprecated: true valueType: type: - string - 'null' description: Text/Number/Date dataSourceQueryParameter: $ref: '#/components/schemas/DataSourceQueryParameterDto' parentId: type: - string - 'null' description: 'Id of the parent object that the component belongs to, e.g. Id of a LoopComponent. This field is relevant only when the component has a parent object.' format: uuid columns: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableColumnDto' description: Columns in this table id: type: string description: The UiD of the component format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the component library format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f version: type: integer description: The version of the component in the library format: int32 example: 1 additionalProperties: false UpdateDocGenComponentResponseDto: type: object properties: version: type: integer description: Version of the component after the update format: int32 example: 4 additionalProperties: false description: Response DTO representing updated component VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false CreateNewComponentDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateNewComponentDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false CreateDocGenComponentsResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateDocGenComponentsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocGenTableColumnDto: type: object properties: order: type: integer description: order of this column format: int32 columnDataKey: type: - string - 'null' description: datakey of this column. example: streetNumber/streetAddress columnLabel: type: - string - 'null' description: Label of this column. example: Street Number/Street Address valueType: type: - string - 'null' description: Text/Number/Date additionalProperties: false DocGenComponentLibraryDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DocGenComponentLibraryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocGenComponentDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocGenComponentDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DataSourceQueryParameterDto_2: type: object properties: datasource: type: - string - 'null' description: Datasource name conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) nestedDataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameterDto_2' description: Nested data source query parameter additionalProperties: false DocGenComponentLibraryDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DocGenComponentLibraryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocGenComponentLiteVersionDto: type: object properties: id: type: string description: Id of the version format: uuid setId: type: string description: Id of the set that the version belongs to format: uuid name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T00:00:00.000Z' versionNumber: type: integer description: The versions number format: int32 example: 1 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft created: type: string description: The creation date of the version format: date-time example: '2021-12-12T15:55:00.000Z' isActive: type: boolean description: Is Version active publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-12-12T15:55:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-12-12T15:55:00.000Z' additionalProperties: false DocGenTextComponentDto: type: object properties: id: type: - string - 'null' description: Id of component parentId: type: - string - 'null' description: 'Id of the parent object that the component belongs to, e.g. Id of a LoopComponent This field is relevant only when the component has a parent object' format: uuid componentKey: type: - string - 'null' description: key name for this component. this must be unique datasource: type: - string - 'null' description: Related Product/MainEntity datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) dataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameterDto_2' description: Nested data source query parameter type: type: - string - 'null' description: Type of component, Text or LoopText valueType: type: - string - 'null' description: Text/Number/Date isAddedToTemplate: type: boolean description: 'True when this library component is already present in the template supplied on the request (matched on content, ignoring instance/version identifiers). Only populated when the request includes template context; otherwise false.' additionalProperties: false Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false DocGenComponentLibraryDto: type: object properties: id: type: string description: Doc Gen Component Library Id format: uuid versions: type: - array - 'null' items: $ref: '#/components/schemas/DocGenComponentLiteVersionDto' description: List of doc gen component versions of the library additionalProperties: false DocGenComponentVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/DocGenComponentVersionDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DocGenComponentVersionDto_2: type: object properties: id: type: string description: Id of the version format: uuid setId: type: string description: Id of the set that the version belongs to format: uuid name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T00:00:00.000Z' versionNumber: type: integer description: The versions number format: int32 example: 1 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft created: type: string description: The creation date of the version format: date-time example: '2021-12-12T15:55:00.000Z' isActive: type: boolean description: Is Version active publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-12-12T15:55:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-12-12T15:55:00.000Z' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version textComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTextComponentDto' tableComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableComponentDto' loopComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenLoopComponentDto' additionalProperties: false DocGenTableComponentDto: type: object properties: id: type: - string - 'null' description: Id of component parentId: type: - string - 'null' description: 'Id of the parent object that the component belongs to, e.g. Id of a LoopComponent This field is relevant only when the component has a parent object' format: uuid componentKey: type: - string - 'null' description: key name for this component. this must be unique datasource: type: - string - 'null' description: Related Product/MainEntity datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) dataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameterDto_2' description: Nested data source query parameter type: type: - string - 'null' description: Type of component, Table or LoopTable readOnly: true columns: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableColumnDto_2' description: Columns in this table isAddedToTemplate: type: boolean description: 'True when this library component is already present in the template supplied on the request (matched on content, ignoring instance/version identifiers). Only populated when the request includes template context; otherwise false.' additionalProperties: false DocGenLoopComponentDto: type: object properties: id: type: - string - 'null' description: Id of component parentId: type: - string - 'null' description: 'Id of the parent object that the component belongs to, e.g. Id of a LoopComponent This field is relevant only when the component has a parent object' format: uuid componentKey: type: - string - 'null' description: key name for this component. this must be unique datasource: type: - string - 'null' description: Related Product/MainEntity datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) dataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameterDto_2' description: Nested data source query parameter type: type: - string - 'null' description: Type of component, Loop readOnly: true textComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTextComponentDto' tableComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableComponentDto' isAddedToTemplate: type: boolean description: 'True when this library component is already present in the template supplied on the request (matched on content, ignoring instance/version identifiers). Only populated when the request includes template context; otherwise false.' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false DocGenComponentDto: type: object properties: id: type: - string - 'null' description: Id of component parentId: type: - string - 'null' description: 'Id of the parent object that the component belongs to, e.g. Id of a LoopComponent This field is relevant only when the component has a parent object' format: uuid componentKey: type: - string - 'null' description: key name for this component. this must be unique datasource: type: - string - 'null' description: Related Product/MainEntity datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Filter Conditions for data source or datakey (datagroup) dataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameterDto_2' description: Nested data source query parameter type: type: - string - 'null' description: Type of component. Text/ Table/ Loop/ LoopText/ LoopTable example: Text valueType: type: - string - 'null' description: Text/Number/Date columns: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableColumnDto_2' description: Columns in this table textComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTextComponentDto' description: List of child text components of this component tableComponents: type: - array - 'null' items: $ref: '#/components/schemas/DocGenTableComponentDto' description: List of child table components of this component additionalProperties: false ConditionDefinitionDto_2: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' valueField: allOf: - $ref: '#/components/schemas/ValueField' additionalProperties: false ApproveAction_2: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false DocGenTableColumnDto_2: type: object properties: order: type: integer description: Order of this column format: int32 columnDataKey: type: - string - 'null' description: Datakey of this column. example: streetNumber/streetAddress columnLabel: type: - string - 'null' description: Label of this column. example: Street Number/Street Address valueType: type: - string - 'null' description: Value type for the column item Fenergo.Nebula.DocGen.Common.Const.ValueTypes for possible values. example: Text additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-docgencommand-v1-0-openapi.json - fenergo-docgenquery-v1-0-openapi.json