openapi: 3.2.0 info: title: Fenergo Template API version: '1.0' description: 'Operations tagged Template 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: Template paths: /api/template: post: tags: - Template summary: Create a new custom template set description: 'Create a new custom template set model and store it in the database. Required permissions: Following permissions are required: DocGenConfigurationCreate' operationId: CreateCustomTemplateSet 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 a custom template set request content: application/json: schema: $ref: '#/components/schemas/CreateCustomTemplateSetRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateSetRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateCustomTemplateSetRequestDtoServiceRequest' responses: '202': description: Success. Custom template set created content: text/plain: schema: $ref: '#/components/schemas/CreateCustomTemplateSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateCustomTemplateSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateSetResponseDtoServiceResponse' '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: - Template summary: Get all custom template sets for the client tenant description: 'This method returns all custom template sets with lite versions for a given tenant. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetCustomTemplateSets 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 custom templates is returned content: text/plain: schema: $ref: '#/components/schemas/CustomTemplateSetDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/CustomTemplateSetDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/CustomTemplateSetDtoIEnumerableServiceResponse' '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/template/{setId}: delete: tags: - Template summary: Delete an existing custom template set and all its versions description: 'Deletes an existing custom template set and all its versions. Required permissions: Following permissions are required: DocGenConfigurationDelete' operationId: DeleteCustomTemplateSet parameters: - name: setId in: path description: Id for Custom Template Set 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: - Template summary: Get an existing custom template set with lite versions by Set Id description: 'This method returns existing custom template set for given set id. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetCustomTemplateSetById parameters: - name: setId 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. Custom template set is returned content: text/plain: schema: $ref: '#/components/schemas/CustomTemplateSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CustomTemplateSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CustomTemplateSetDtoServiceResponse' '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/template/{setId}/version/{versionNumber}/draft: post: tags: - Template summary: Create a new version for an existing custom template set description: 'This method creates a new custom template 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: CreateCustomTemplateVersion parameters: - name: setId 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/CreateCustomTemplateVersionResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse' '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: Custom Template Set 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/template/{setId}/emptydraft: post: tags: - Template summary: Create a new version for an existing custom template set without data description: 'This method creates a new custom template 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: CreateCustomTemplateEmptyVersion parameters: - name: setId 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/CreateCustomTemplateVersionResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse' '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: Custom Template Set 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/template/{setId}/version/{versionNumber}: put: tags: - Template summary: Update an existing custom template version description: 'This method updates an existing custom template version. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: UpdateCustomTemplateVersion parameters: - name: setId in: path description: The Id of the existing set 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 custom template version request content: application/json: schema: $ref: '#/components/schemas/UpdateCustomTemplateVersionRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateCustomTemplateVersionRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateCustomTemplateVersionRequestDtoServiceRequest' 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: Custom template Set 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: - Template summary: Delete a custom template version description: 'Deletes the selected version of an existing custom template set. 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: DeleteCustomTemplateVersion parameters: - name: setId in: path description: Custom Template set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. 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. Custom template 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 get: tags: - Template summary: Get an custom template version by Set Id and version number description: 'This method returns an existing custom template version for a given set id and version number. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetCustomTemplateVersionBySetIdAndVersionNumber parameters: - name: setId in: path description: The Id of the existing template 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: urlRequired in: query description: Whether or not the context file signed url is to be returned in the Custom Template Version DTO schema: type: boolean - 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. Custom template version is returned content: text/plain: schema: $ref: '#/components/schemas/CustomTemplateVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CustomTemplateVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CustomTemplateVersionDtoServiceResponse' '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/template/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - Template summary: Submit an existing custom template version for Approval description: 'This method submits the selected custom template version of an existing set for Approval. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: SubmitCustomTemplateVersion parameters: - name: setId 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 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: Custom Template Set 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/template/{setId}/version/{versionNumber}/sign: put: tags: - Template summary: Sign an existing custom template version description: 'This method signs the selected custom template 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: SignCustomTemplateVersion parameters: - name: setId 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: Custom Template Set 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/template/{setId}/version/{versionNumber}/archive: put: tags: - Template summary: Archive an existing custom template version description: 'This method archives the selected custom template version of an existing template set. Required permissions: Following permissions are required: DocGenConfigurationArchive' operationId: ArchiveCustomTemplateVersion parameters: - name: setId in: path description: The Id of the existing template 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: Custom Template Set 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/template/{setId}/version/{versionNumber}/context/htmloverride: post: tags: - Template summary: Save the Html Override Context metadata and get a resigned Url to upload the… description: 'This method updates the HtmlOverrideContext property in Custom Template Version model. This method also gets the presigned Url to allow the user to upload the file in the AWS S3 bucket. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: UpdateHtmlOverrideContext parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: 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: The upload file request content: application/json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextRequestDtoServiceRequest' responses: '202': description: An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.UpdateHtmlOverrideContextFileResponseDto class with some metadata that represent the file uploaded content: text/plain: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextFileResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextFileResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextFileResponseDtoServiceResponse' '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: Custom Template Set 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/template/{setId}/version/{versionNumber}/context/htmloverride/file: delete: tags: - Template summary: Delete Html Override Context file description: 'Delete the Context file of the custom html overriding the default template. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: DeleteHtmlOverrideContextFile parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: 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 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: Custom Template Set 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/template/{setId}/version/{versionNumber}/context/htmloverride/metadata: put: tags: - Template summary: Update Html Override Context metadata description: 'Update the Context metadata. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: UpdateHtmlOverrideContextMetadata parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: 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 context metadata request content: application/json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest' 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: Custom Template Set 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/template/{setId}/version/{versionNumber}/components: post: tags: - Template summary: Add a component to a template version description: 'This method add component in Custom Template Version model. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: AddCustomTemplateComponent parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: 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: The add component request content: application/json: schema: $ref: '#/components/schemas/CreateNewTemplateComponentDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateNewTemplateComponentDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateNewTemplateComponentDtoServiceRequest' responses: '202': description: An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.CreateCustomTemplateComponentResponseDto class with some metadata of the component to add content: text/plain: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentResponseDtoServiceResponse' '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: Custom Template Set 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/template/{setId}/version/{versionNumber}/components/docgencomponent: post: tags: - Template summary: Add a doc gen component to a template version description: 'This method copys a doc gen component and add it with a new component Id to Custom Template Version model. If a doc gen component has child components, the childrens are also added to the custom template version Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: AddDocGenComponentToCustomTemplate parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: Version Number of the existing template version 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: The add component request content: application/json: schema: $ref: '#/components/schemas/AddDocGenComponentToTemplateRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/AddDocGenComponentToTemplateRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/AddDocGenComponentToTemplateRequestDtoServiceRequest' responses: '202': description: An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.AddDocGenComponentToTemplateRequestDto class with some metadata that the doc gen component to add content: text/plain: schema: $ref: '#/components/schemas/AddDocGenComponentToTemplateResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/AddDocGenComponentToTemplateResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/AddDocGenComponentToTemplateResponseDtoServiceResponse' '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: Custom Template Set 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/template/{setId}/version/{versionNumber}/components/multiple: post: tags: - Template summary: Add mulitple components description: 'This method add multiple component in Custom Template Version model. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: AddCustomTemplateComponents parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: 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/CreateCustomTemplateComponentsRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentsRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentsRequestDtoServiceRequest' responses: '202': description: Success. Components added content: text/plain: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateCustomTemplateComponentsResponseDtoServiceResponse' '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: Custom Template Set 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/template/{setId}/version/{versionNumber}/components/{componentId}: delete: tags: - Template summary: Delete a component description: 'This method delete component in Custom Template Version model. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: DeleteCustomTemplateComponent parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: 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. Template set/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 servers: - url: /docgencommand /api/template/{setId}/version/{versionNumber}/components/{componentId}/context/template: post: tags: - Template summary: Save the Template Context metadata and get a resigned Url to upload the context… description: 'This method updates the TemplateContext property in CustomTemplateLoopComponent model. This method also gets the presigned Url to allow the user to upload the file in the AWS S3 bucket. By updating the file by using the presigned Url, you will replace the existing file. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: UpdateCustomTemplateComponentTemplateContext parameters: - name: setId in: path description: Custom Template Set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Custom Template Version number required: true schema: type: integer format: int32 - name: componentId in: path description: Component id to upload a template required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The upload file request content: application/json: schema: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest' responses: '202': description: An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.UpdateCustomTemplateComponentTemplateContextReponseDto class with some metadata that represent the file uploaded content: text/plain: schema: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse' '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: Custom Template Set 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: - Template summary: Delete Template Context file description: 'Delete the Template Context file file of a given loop component. Required permissions: Following permissions are required: DocGenConfigurationEdit' operationId: DeleteCustomTemplateComponentTemplateContext parameters: - name: setId in: path description: Custom Template Set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Custom Template Version number required: true schema: type: integer format: int32 - name: componentId in: path description: Component id to delete its template 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' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Custom Template Set 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/template/additionalinfomation: get: tags: - Template description: 'Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetAdditionalInformation 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: OK content: text/plain: schema: $ref: '#/components/schemas/AdditionalInformationDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/AdditionalInformationDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/AdditionalInformationDtoIEnumerableServiceResponse' '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 summary: Get additional information x-summary-source: derived servers: - url: /docgenquery /api/template/{setId}/version/{versionNumber}/preview: get: tags: - Template summary: Render a preview of a custom template version using mock data description: 'Renders the template version to HTML using mock data (5 rows for loops/tables), returned as a JSON string for an editor-side preview. Any failure yields an HTML error page with a 200 status, so the caller can always display the response. No PDF or document is produced. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: PreviewCustomTemplate parameters: - name: setId in: path description: The Id of the custom template set required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number to preview 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: The rendered preview HTML (or an HTML error page if rendering failed) content: application/json: schema: type: string '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 /api/template/{setId}/version/{versionNumber}/context/htmloverride/signedUrl: get: tags: - Template summary: Get download Url of HTML override context file of the specific custom template… description: 'This method returns the presigned Url of HTML override context file from S3 for the specific custom template version. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetHtmlOverrideContextSignedUrlByVersion parameters: - name: setId in: path description: The Id of the existing template set required: true schema: type: string format: uuid - name: versionNumber in: path description: The 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 responses: '200': description: Success. A presigned Url is returned 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. 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: /docgenquery /api/template/pdfTemplate/boilerplate: get: tags: - Template summary: Get boilerplate content for html template description: 'This method returns the boilerplate content for html template used for Template Designer. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetBoilderplateHtmlContent 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 content is returned 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 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 /api/template/{setId}/version/{versionNumber}/components/{componentId}/context/template/signedUrl: get: tags: - Template summary: Get download Url of template context file of the specific loop component description: 'This method returns the presigned Url of template context file from S3 for the specific loop component. Required permissions: Following permissions are required: DocGenConfigurationAccess' operationId: GetCustomTemplateComponentTemplateContextSignedUrl parameters: - name: setId in: path description: Custom Template Set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Custom Template Version number required: true schema: type: integer format: int32 - name: componentId in: path description: Component id to get the presigned Url of its template 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. A presigned Url is returned 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. 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: /docgenquery components: schemas: CreateCustomTemplateSetResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateCustomTemplateSetResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateCustomTemplateSetRequestDto: type: object properties: name: type: - string - 'null' description: Name of the custom template description: type: - string - 'null' description: Description for the custom template additionalProperties: false description: Create a new Custom Template Set request model UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDto' 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 UpdateHtmlOverrideContextFileResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/UpdateHtmlOverrideContextFileResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDto' 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 AddDocGenComponentToTemplateResponseDto: type: object properties: id: type: string description: The UiD of the created component format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f childComponentIds: type: - array - 'null' items: type: string format: uuid description: The UiD of the created child components additionalProperties: false UpdateCustomTemplateVersionRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateCustomTemplateVersionRequestDto' additionalProperties: false CustomTemplateVersionDtoBase: type: object properties: id: type: string description: Id of the version to update format: uuid setId: type: string description: Id of the custom template set that the version belongs to format: uuid versionNumber: type: integer description: The version number of the version to update format: int32 name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version fileName: type: - string - 'null' description: The name of the document created in the task documentType: type: - string - 'null' description: The type of the document created in the task geographicAccessLayer: type: - array - 'null' items: type: string description: Referenced Geographic access layers for the document created in the task businessRelatedAccessLayer: type: - array - 'null' items: type: string description: Referenced Business related access layers for the document created in the task defaultTemplateVersion: type: - integer - 'null' description: The version of the default HTML template to use format: int32 enableDefaultTemplate: type: boolean description: Flags to determine to use default HTML template or custom HTML template that user creates languageCode: type: - string - 'null' description: Language code for localization category: type: - string - 'null' description: The category that the version applies for. additionalInformation: type: - array - 'null' items: type: string description: Additional Information displayed in the pdf enableTemplateDesigner: type: boolean description: Flags to determine to use Template Designer to modify the content of context file renderPlaceholderForEmptyValues: type: boolean description: 'When true, values that resolve to no data — text components, table cells and loop children — render a placeholder ("-"). When false (default), they render blank.' 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 CreateCustomTemplateVersionResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateCustomTemplateVersionResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AddDocGenComponentToTemplateRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/AddDocGenComponentToTemplateRequestDto' additionalProperties: false UpdateCustomTemplateVersionRequestDto: type: object properties: id: type: string description: Id of the version to update format: uuid setId: type: string description: Id of the custom template set that the version belongs to format: uuid versionNumber: type: integer description: The version number of the version to update format: int32 name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version fileName: type: - string - 'null' description: The name of the document created in the task documentType: type: - string - 'null' description: The type of the document created in the task geographicAccessLayer: type: - array - 'null' items: type: string description: Referenced Geographic access layers for the document created in the task businessRelatedAccessLayer: type: - array - 'null' items: type: string description: Referenced Business related access layers for the document created in the task defaultTemplateVersion: type: - integer - 'null' description: The version of the default HTML template to use format: int32 enableDefaultTemplate: type: boolean description: Flags to determine to use default HTML template or custom HTML template that user creates languageCode: type: - string - 'null' description: Language code for localization category: type: - string - 'null' description: The category that the version applies for. additionalInformation: type: - array - 'null' items: type: string description: Additional Information displayed in the pdf enableTemplateDesigner: type: boolean description: Flags to determine to use Template Designer to modify the content of context file renderPlaceholderForEmptyValues: type: boolean description: 'When true, values that resolve to no data — text components, table cells and loop children — render a placeholder ("-"). When false (default), they render blank.' effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T00:00:00.000Z' customLayout: $ref: '#/components/schemas/CustomTemplateLayoutDto' sourceContextFileUrl: type: - string - 'null' description: Signed url for an http context file from another version/tenant. If provided will override the current context file and metadata. additionalProperties: false CreateCustomTemplateComponentsResponseDto: type: object properties: componentIds: type: - array - 'null' items: type: string format: uuid description: The list of copmonent id that created additionalProperties: false CreateCustomTemplateComponentResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateCustomTemplateComponentResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateCustomTemplateComponentsRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateCustomTemplateComponentsRequestDto' additionalProperties: false AddDocGenComponentToTemplateRequestDto: type: object properties: docGenComponentVersionId: type: - string - 'null' description: The UiD of the doc gen component version that the component belongs to example: 84ec28e2-d786-417b-850f-96321dd849dd docGenComponentId: type: - string - 'null' description: The UiD of the doc gen component example: 84ec28e2-d786-417b-850f-96321dd849dd additionalProperties: false VersionSignResponseServiceResponse: type: object properties: data: $ref: '#/components/schemas/VersionSignResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateHtmlOverrideContextRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateHtmlOverrideContextRequestDto' 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 CustomTemplateLayoutDto: type: object properties: scale: type: - number - 'null' description: Scale of the custom layout format: double format: type: - string - 'null' description: Format of the custom layout example: A4 layout: type: - string - 'null' description: Layout of the template example: Portrait showPageBorder: type: - boolean - 'null' description: Whether to render a border around each page additionalProperties: false ContextDto: type: object properties: name: type: - string - 'null' description: Name of the context description: type: - string - 'null' description: Description of the Context displayName: type: - string - 'null' description: Display name for context file that updated with file upload lastUpdatedTime: type: string description: Last updae time of context metadata format: date-time additionalProperties: false UpdateCustomTemplateComponentTemplateContextRequestDto: required: - displayName type: object properties: displayName: minLength: 1 type: string description: Display name for context file example: passport.pdf description: type: - string - 'null' description: Description of the Context additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateCustomTemplateComponentsRequestDto: type: object properties: components: type: - array - 'null' items: $ref: '#/components/schemas/CreateNewTemplateComponentDto' description: The list of template components additionalProperties: false UpdateHtmlOverrideContextFileResponseDto: type: object properties: name: type: - string - 'null' description: Name of the context description: type: - string - 'null' description: Description of the Context displayName: type: - string - 'null' description: Display name for context file that updated with file upload signedUrlToUpload: type: - string - 'null' description: Url to upload the file into S3 bucket lastUpdatedTime: type: string description: Last update time of context format: date-time additionalProperties: false ValueField: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false CreateCustomTemplateComponentResponseDto: type: object properties: id: type: string description: The UiD of the created component format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f additionalProperties: false CreateCustomTemplateComponentsResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateCustomTemplateComponentsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Decision: enum: - Approve - Reject type: string UpdateCustomTemplateComponentTemplateContextReponseDto: type: object properties: name: type: - string - 'null' description: Name of the context description: type: - string - 'null' description: Description of the Context displayName: type: - string - 'null' description: Display name for context file that updated with file upload signedUrlToUpload: type: - string - 'null' description: Url to upload the file into S3 bucket lastUpdatedTime: type: string description: Last update time of context format: date-time additionalProperties: false ApproveActionServiceRequest: type: object properties: data: $ref: '#/components/schemas/ApproveAction' additionalProperties: false UpdateHtmlOverrideContextMetadataRequestDto: type: object properties: description: type: - string - 'null' description: Description of the context additionalProperties: false description: Defines request for context metadata update 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 ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CustomTemplateTableColumnDto: 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 CreateNewTemplateComponentDto: 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 id: type: string description: The UiD of the component format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd columns: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateTableColumnDto' description: Columns in this table sourceContextFileUrl: type: - string - 'null' description: 'URL to read the template context file of a loop component from another tenant, as handed out by the query API. Set when a loop component is copied between tenants: the file is fetched server side and its context is recorded, with a default display name, once that has succeeded. Ignored for other component types, and only honoured when components are added in bulk - a single add rejects loop components.' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateCustomTemplateSetRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateCustomTemplateSetRequestDto' additionalProperties: false UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 UpdateHtmlOverrideContextRequestDto: required: - displayName type: object properties: displayName: minLength: 1 type: string description: Display name for context file example: passport.pdf description: type: - string - 'null' description: Description of the Context additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string CreateCustomTemplateVersionResponseDto: type: object properties: id: type: string description: Id of the version to update format: uuid setId: type: string description: Id of the custom template set that the version belongs to format: uuid versionNumber: type: integer description: The version number of the version to update format: int32 name: type: - string - 'null' description: Name of the version description: type: - string - 'null' description: Description for the version fileName: type: - string - 'null' description: The name of the document created in the task documentType: type: - string - 'null' description: The type of the document created in the task geographicAccessLayer: type: - array - 'null' items: type: string description: Referenced Geographic access layers for the document created in the task businessRelatedAccessLayer: type: - array - 'null' items: type: string description: Referenced Business related access layers for the document created in the task defaultTemplateVersion: type: - integer - 'null' description: The version of the default HTML template to use format: int32 enableDefaultTemplate: type: boolean description: Flags to determine to use default HTML template or custom HTML template that user creates languageCode: type: - string - 'null' description: Language code for localization category: type: - string - 'null' description: The category that the version applies for. additionalInformation: type: - array - 'null' items: type: string description: Additional Information displayed in the pdf enableTemplateDesigner: type: boolean description: Flags to determine to use Template Designer to modify the content of context file renderPlaceholderForEmptyValues: type: boolean description: 'When true, values that resolve to no data — text components, table cells and loop children — render a placeholder ("-"). When false (default), they render blank.' 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' htmlOverrideContext: $ref: '#/components/schemas/ContextDto' customLayout: $ref: '#/components/schemas/CustomTemplateLayoutDto' internalTemplateVersionNumber: type: - integer - 'null' description: The internal version number for template version format: int32 example: 2 additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AddDocGenComponentToTemplateResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/AddDocGenComponentToTemplateResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateCustomTemplateSetResponseDto: type: object properties: id: type: string description: Id of the custom template set created format: uuid version: $ref: '#/components/schemas/CustomTemplateVersionDtoBase' additionalProperties: false description: Create a new Custom Template Set response model CreateNewTemplateComponentDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateNewTemplateComponentDto' additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false CustomTemplateSetDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CustomTemplateSetDto' 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 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 CustomTemplateSetDto: type: object properties: id: type: string description: Custom Template Set Id format: uuid versions: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateLiteVersionDto' description: List of custom template versions of the set additionalProperties: false Condition: 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/ConditionDefinition' additionalProperties: false CustomTemplateVersionDto: 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' fileName: type: - string - 'null' description: The name of the document created in the task documentType: type: - string - 'null' description: The type of the document created in the task geographicAccessLayer: type: - array - 'null' items: type: string description: Referenced Geographic access layers for the document created in the task businessRelatedAccessLayer: type: - array - 'null' items: type: string description: Referenced Business related access layers for the document created in the task defaultTemplateVersion: type: - integer - 'null' description: The version of the default HTML template to use format: int32 enableDefaultTemplate: type: boolean description: Flags to determine to use default HTML template or custom HTML template that user creates languageCode: type: - string - 'null' description: Language code for localization category: type: - string - 'null' description: The category that the version applies for additionalInformation: type: - array - 'null' items: type: string description: Additional information on pdf htmlOverrideContext: allOf: - $ref: '#/components/schemas/ContextDto_2' description: Context for Custom Html Override 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/CustomTemplateTextComponentDto' description: The list of text components, it doesn't contain LoopText components that are the children of Loop Component tableComponents: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateTableComponentDto' description: The list of table components, it doesn't contain LoopTable components that are the children of Loop Component loopComponents: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateLoopComponentDto' description: The list of loop components customLayout: allOf: - $ref: '#/components/schemas/CustomTemplateLayoutDto_2' description: Custom layout of the template enableTemplateDesigner: type: boolean description: Flags to determine to use Template Designer to modify the content of context file renderPlaceholderForEmptyValues: type: boolean description: 'When true, values that resolve to no data — text components, table cells and loop children — render a placeholder ("-"). When false (default), they render blank.' internalTemplateVersionNumber: type: - integer - 'null' description: The internal version number for template version format: int32 contextFileUrl: type: - string - 'null' description: The signed url for the html context file additionalProperties: false CustomTemplateLiteVersionDto: 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' category: type: - string - 'null' description: The category that the version applies for customTemplateLayout: allOf: - $ref: '#/components/schemas/CustomTemplateLayoutDto_2' description: The custom layout configuration for the template version additionalProperties: false description: The lite model of Custom Template Version CustomTemplateLoopComponentDto: 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 templateContext: allOf: - $ref: '#/components/schemas/ContextDto_2' description: Context for template of this component templateContextFileUrl: type: - string - 'null' description: 'Pre-signed URL to download the template context file of this component. Only populated when the caller asks for URLs and the file is present in storage, so that a consumer copying the component to another tenant can read the source file.' enableTemplateDesigner: type: boolean description: Flags to determine to use Template Designer to modify the content of template context file textComponents: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateTextComponent' tableComponents: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateTableComponent' sourceComponentId: type: - string - 'null' description: Id of the original library component this template component was cloned from. additionalProperties: false CustomTemplateTextComponent: type: object properties: id: type: string format: uuid tenant: type: - string - 'null' version: type: integer format: int32 isLocked: type: boolean versionId: type: string description: Version id that the component belongs to format: uuid 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 type: type: - string - 'null' description: Component type example: Text datasource: type: - string - 'null' description: Related Product/MainEntity datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/Condition' description: Filter Conditions for data source or datakey (datagroup) dataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameter' description: Data source query parameter includes filter conditions sourceComponentId: type: - string - 'null' description: 'Id of the original library component this template component was cloned from. Used to match template components back to their source in the component library.' format: uuid valueType: type: - string - 'null' description: Value type of the text component Fenergo.Nebula.DocGen.Common.Const.ValueTypes for possible values. additionalProperties: false CustomTemplateVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CustomTemplateVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CustomTemplateSetDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateSetDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CustomTemplateLayoutDto_2: type: object properties: scale: type: number description: Scale of the custom layout format: double format: type: - string - 'null' description: Format of the custom layout example: A4 layout: type: - string - 'null' description: Layout of the template example: Portrait showPageBorder: type: - boolean - 'null' description: Whether to render a border around each page additionalProperties: false ContextDto_2: type: object properties: name: type: - string - 'null' description: Name of the context description: type: - string - 'null' description: Description of the Context displayName: type: - string - 'null' description: Display name for context file that updated with file upload lastUpdatedTime: type: string description: Last update time of context format: date-time additionalProperties: false DataSourceQueryParameter: type: object properties: datasource: type: - string - 'null' description: Datasource name conditions: type: - array - 'null' items: $ref: '#/components/schemas/Condition' description: Filter Conditions for data source or datakey (datagroup) nestedDataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameter' description: Nested data source query parameter additionalProperties: false AdditionalInformationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInformationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AdditionalInformationDto: type: object properties: name: type: - string - 'null' value: type: - string - 'null' description: type: - string - 'null' additionalProperties: false CustomTemplateTableComponent: type: object properties: id: type: string format: uuid tenant: type: - string - 'null' version: type: integer format: int32 isLocked: type: boolean versionId: type: string description: Version id that the component belongs to format: uuid 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 type: type: - string - 'null' description: Component type example: Text datasource: type: - string - 'null' description: Related Product/MainEntity datasourceDataKey: type: - string - 'null' description: address conditions: type: - array - 'null' items: $ref: '#/components/schemas/Condition' description: Filter Conditions for data source or datakey (datagroup) dataSourceQueryParameter: allOf: - $ref: '#/components/schemas/DataSourceQueryParameter' description: Data source query parameter includes filter conditions sourceComponentId: type: - string - 'null' description: 'Id of the original library component this template component was cloned from. Used to match template components back to their source in the component library.' format: uuid columns: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateTableColumn' description: Columns in this table 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 CustomTemplateTableColumnDto_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 CustomTemplateTableComponentDto: 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 example: Table columns: type: - array - 'null' items: $ref: '#/components/schemas/CustomTemplateTableColumnDto_2' description: Columns in this table sourceComponentId: type: - string - 'null' description: Id of the original library component this template component was cloned from. 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 CustomTemplateTableColumn: 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. additionalProperties: false CustomTemplateTextComponentDto: 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 example: Text valueType: type: - string - 'null' description: Text/Number/Date sourceComponentId: type: - string - 'null' description: Id of the original library component this template component was cloned from. 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 ConditionDefinition: 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' isCondition: type: boolean readOnly: true 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