{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Doc Gen Query", "description": "**Doc Gen Query API**:\n\n
Doc Gen Query API retrieves Document Generation configurations.\n\n
**Doc Gen Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/docgenquery" } ], "paths": { "/api/datasource": { "get": { "tags": [ "Datasource" ], "summary": "Get all data source configurations for tenant", "description": "\nThis method returns all data source configurations for a given tenant.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetDatasources", "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 data sources is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DatasourceDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatasourceDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DatasourceDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/docgencomponent": { "get": { "tags": [ "DocGenComponent" ], "summary": "Get all global doc gen component librarys for the client tenant", "description": "\nThis method returns all doc gen component library with lite versions for a given tenant.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetDocGenComponentLibrary", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of doc gen component librarys is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentLibraryDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentLibraryDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentLibraryDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}": { "get": { "tags": [ "DocGenComponent" ], "summary": "Get an existing global doc gen component library with lite versions by Set Id", "description": "\nThis method returns existing global doc gen component library for given set id.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetDocGenComponentLibraryById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Global doc gen component library is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentLibraryDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentLibraryDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentLibraryDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. A set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}": { "get": { "tags": [ "DocGenComponent" ], "summary": "Get an existing doc gen component version by Set Id and version number", "description": "\nThis method returns an existing doc gen component version for a given set id and version number.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetDocGenComponentVersionBySetIdAndVersionNumber", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Doc Gen Component version is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/docgencomponent/versions/latest": { "get": { "tags": [ "DocGenComponent" ], "summary": "Get the latest active version of doc gen component for the client tenant", "description": "\nThis method returns the latest active version of doc gen component for a given tenant

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetLatestDocGenComponentVersion", "parameters": [ { "name": "templateSetId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "templateVersionNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Doc Gen Component version is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. An active version for a given tenant does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}/components/{componentId}": { "get": { "tags": [ "DocGenComponent" ], "summary": "Get component by id", "description": "\nReturns component by given component library id, component library version number and component id.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetComponentById", "parameters": [ { "name": "id", "in": "path", "description": "Component library id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Component libraryversion number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentId", "in": "path", "description": "Component id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Component is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Component library/component with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/document/{id}": { "get": { "tags": [ "Document" ], "summary": "Get document by Id", "description": "\nThis method returns document for a given id.", "operationId": "GetDocumentById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Document is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. A document with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/document/{journeyId}/{taskId}": { "get": { "tags": [ "Document" ], "summary": "Get documents by journey Id and task Id", "description": "\nThis method returns documents for a given journey id and task id.", "operationId": "GetDocumentsByJourneyIdTaskId", "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "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. Documents are returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. A document with given journey Id and task Id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/lookup/languageCode": { "get": { "tags": [ "Lookup" ], "summary": "Get standard language code list", "description": "\nThis method returns BCP47 standard langage codes list.", "operationId": "GetLanguageCodes", "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 language codes is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. 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" } ] } } } } } } }, "/api/lookup/languageSelect": { "get": { "tags": [ "Lookup" ], "summary": "Get language select list with description", "description": "\nThis method returns BCP47 standard langage codes list.", "operationId": "GetLanguageSelect", "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 language codes is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LanguageSelectDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LanguageSelectDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LanguageSelectDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/namingconvention": { "get": { "tags": [ "NamingConvention" ], "summary": "Get all global naming convention sets for the client tenant", "description": "\nThis method returns all global naming conventions sets with lite versions for a given tenant.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetGlobalNamingConventionSets", "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 naming convention sets is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalNamingConventionSetDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalNamingConventionSetDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalNamingConventionSetDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/namingconvention/{setId}": { "get": { "tags": [ "NamingConvention" ], "summary": "Get an existing global naming convention set with lite versions by Set Id", "description": "\nThis method returns existing global naming convention set for given set id.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetGlobalNamingConventionSetById", "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. Global naming convention set is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlobalNamingConventionSetDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlobalNamingConventionSetDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalNamingConventionSetDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/namingconvention/{setId}/versions/{versionNumber}": { "get": { "tags": [ "NamingConvention" ], "summary": "Get an existing naming convention version by Set Id and version number", "description": "\nThis method returns an existing global naming convention version for a given set id and version number.

Required permissions:
Following permissions are required: DocGenConfigurationAccess", "operationId": "GetNamingConventionVersionBySetIdAndVersionNumber", "parameters": [ { "name": "setId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Naming convention version is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NamingConventionVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NamingConventionVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamingConventionVersionDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/template": { "get": { "tags": [ "Template" ], "summary": "Get all custom template sets for the client tenant", "description": "\nThis 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" } ] } } } } } } }, "/api/template/{setId}": { "get": { "tags": [ "Template" ], "summary": "Get an existing custom template set with lite versions by Set Id", "description": "\nThis 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" } ] } } } } } } }, "/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" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}": { "get": { "tags": [ "Template" ], "summary": "Get an custom template version by Set Id and version number", "description": "\nThis 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" } ] } } } } } } }, "/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\r\nas a JSON string for an editor-side preview. Any failure yields an HTML error page with a\r\n200 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" } ] } } } } } } }, "/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 version", "description": "\nThis 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" } ] } } } } } } }, "/api/template/pdfTemplate/boilerplate": { "get": { "tags": [ "Template" ], "summary": "Get boilerplate content for html template", "description": "\nThis 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" } ] } } } } } } }, "/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": "\nThis 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" } ] } } } } } } } }, "components": { "schemas": { "AdditionalInformationDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdditionalInformationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalInformationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Condition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true } }, "additionalProperties": false }, "ConditionDefinition": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true }, "isCondition": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "ContextDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the context", "nullable": true }, "description": { "type": "string", "description": "Description of the Context", "nullable": true }, "displayName": { "type": "string", "description": "Display name for context file that updated with file upload", "nullable": true }, "lastUpdatedTime": { "type": "string", "description": "Last update time of context", "format": "date-time" } }, "additionalProperties": false }, "CustomTemplateLayoutDto": { "type": "object", "properties": { "scale": { "type": "number", "description": "Scale of the custom layout", "format": "double" }, "format": { "type": "string", "description": "Format of the custom layout", "nullable": true, "example": "A4" }, "layout": { "type": "string", "description": "Layout of the template", "nullable": true, "example": "Portrait" }, "showPageBorder": { "type": "boolean", "description": "Whether to render a border around each page", "nullable": true } }, "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", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "category": { "type": "string", "description": "The category that the version applies for", "nullable": true }, "customTemplateLayout": { "allOf": [ { "$ref": "#/components/schemas/CustomTemplateLayoutDto" } ], "description": "The custom layout configuration for the template version", "nullable": true } }, "additionalProperties": false, "description": "The lite model of Custom Template Version" }, "CustomTemplateLoopComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component, Loop", "nullable": true, "readOnly": true }, "templateContext": { "allOf": [ { "$ref": "#/components/schemas/ContextDto" } ], "description": "Context for template of this component", "nullable": true }, "templateContextFileUrl": { "type": "string", "description": "Pre-signed URL to download the template context file of this component.\r\nOnly populated when the caller asks for URLs and the file is present in storage,\r\nso that a consumer copying the component to another tenant can read the source file.", "nullable": true }, "enableTemplateDesigner": { "type": "boolean", "description": "Flags to determine to use Template Designer to modify the content of template context file" }, "textComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTextComponent" }, "nullable": true }, "tableComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTableComponent" }, "nullable": true }, "sourceComponentId": { "type": "string", "description": "Id of the original library component this template component was cloned from.", "nullable": true } }, "additionalProperties": false }, "CustomTemplateSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Custom Template Set Id", "format": "uuid" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateLiteVersionDto" }, "description": "List of custom template versions of the set", "nullable": true } }, "additionalProperties": false }, "CustomTemplateSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CustomTemplateSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CustomTemplateSetDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CustomTemplateTableColumn": { "type": "object", "properties": { "order": { "type": "integer", "description": "Order of this column", "format": "int32" }, "columnDataKey": { "type": "string", "description": "Datakey of this column.", "nullable": true, "example": "streetNumber/streetAddress" }, "columnLabel": { "type": "string", "description": "Label of this column.", "nullable": true, "example": "Street Number/Street Address" }, "valueType": { "type": "string", "description": "Value type for the column item Fenergo.Nebula.DocGen.Common.Const.ValueTypes for possible values.", "nullable": true } }, "additionalProperties": false }, "CustomTemplateTableColumnDto": { "type": "object", "properties": { "order": { "type": "integer", "description": "Order of this column", "format": "int32" }, "columnDataKey": { "type": "string", "description": "Datakey of this column.", "nullable": true, "example": "streetNumber/streetAddress" }, "columnLabel": { "type": "string", "description": "Label of this column.", "nullable": true, "example": "Street Number/Street Address" }, "valueType": { "type": "string", "description": "Value type for the column item Fenergo.Nebula.DocGen.Common.Const.ValueTypes for possible values.", "nullable": true, "example": "Text" } }, "additionalProperties": false }, "CustomTemplateTableComponent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "versionId": { "type": "string", "description": "Version id that the component belongs to", "format": "uuid" }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "type": { "type": "string", "description": "Component type", "nullable": true, "example": "Text" }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameter" } ], "description": "Data source query parameter includes filter conditions", "nullable": true }, "sourceComponentId": { "type": "string", "description": "Id of the original library component this template component was cloned from.\r\nUsed to match template components back to their source in the component library.", "format": "uuid", "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTableColumn" }, "description": "Columns in this table", "nullable": true } }, "additionalProperties": false }, "CustomTemplateTableComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component, Table or LoopTable", "nullable": true, "example": "Table" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTableColumnDto" }, "description": "Columns in this table", "nullable": true }, "sourceComponentId": { "type": "string", "description": "Id of the original library component this template component was cloned from.", "nullable": true } }, "additionalProperties": false }, "CustomTemplateTextComponent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "versionId": { "type": "string", "description": "Version id that the component belongs to", "format": "uuid" }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "type": { "type": "string", "description": "Component type", "nullable": true, "example": "Text" }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameter" } ], "description": "Data source query parameter includes filter conditions", "nullable": true }, "sourceComponentId": { "type": "string", "description": "Id of the original library component this template component was cloned from.\r\nUsed to match template components back to their source in the component library.", "format": "uuid", "nullable": true }, "valueType": { "type": "string", "description": "Value type of the text component Fenergo.Nebula.DocGen.Common.Const.ValueTypes for possible values.", "nullable": true } }, "additionalProperties": false }, "CustomTemplateTextComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component, Text or LoopText", "nullable": true, "example": "Text" }, "valueType": { "type": "string", "description": "Text/Number/Date", "nullable": true }, "sourceComponentId": { "type": "string", "description": "Id of the original library component this template component was cloned from.", "nullable": true } }, "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", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "fileName": { "type": "string", "description": "The name of the document created in the task", "nullable": true }, "documentType": { "type": "string", "description": "The type of the document created in the task", "nullable": true }, "geographicAccessLayer": { "type": "array", "items": { "type": "string" }, "description": "Referenced Geographic access layers for the document created in the task", "nullable": true }, "businessRelatedAccessLayer": { "type": "array", "items": { "type": "string" }, "description": "Referenced Business related access layers for the document created in the task", "nullable": true }, "defaultTemplateVersion": { "type": "integer", "description": "The version of the default HTML template to use", "format": "int32", "nullable": true }, "enableDefaultTemplate": { "type": "boolean", "description": "Flags to determine to use default HTML template or custom HTML template that user creates" }, "languageCode": { "type": "string", "description": "Language code for localization", "nullable": true }, "category": { "type": "string", "description": "The category that the version applies for", "nullable": true }, "additionalInformation": { "type": "array", "items": { "type": "string" }, "description": "Additional information on pdf", "nullable": true }, "htmlOverrideContext": { "allOf": [ { "$ref": "#/components/schemas/ContextDto" } ], "description": "Context for Custom Html Override", "nullable": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "textComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTextComponentDto" }, "description": "The list of text components, it doesn't contain LoopText components that are the children of Loop Component", "nullable": true }, "tableComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTableComponentDto" }, "description": "The list of table components, it doesn't contain LoopTable components that are the children of Loop Component", "nullable": true }, "loopComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateLoopComponentDto" }, "description": "The list of loop components", "nullable": true }, "customLayout": { "allOf": [ { "$ref": "#/components/schemas/CustomTemplateLayoutDto" } ], "description": "Custom layout of the template", "nullable": true }, "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 —\r\nrender a placeholder (\"-\"). When false (default), they render blank." }, "internalTemplateVersionNumber": { "type": "integer", "description": "The internal version number for template version", "format": "int32", "nullable": true }, "contextFileUrl": { "type": "string", "description": "The signed url for the html context file", "nullable": true } }, "additionalProperties": false }, "CustomTemplateVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CustomTemplateVersionDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DataSourceQueryParameter": { "type": "object", "properties": { "datasource": { "type": "string", "description": "Datasource name", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "nestedDataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameter" } ], "description": "Nested data source query parameter", "nullable": true } }, "additionalProperties": false }, "DataSourceQueryParameterDto": { "type": "object", "properties": { "datasource": { "type": "string", "description": "Datasource name", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "nestedDataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true } }, "additionalProperties": false }, "DatasourceDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the data source", "nullable": true, "example": "Related Products" }, "value": { "type": "string", "description": "Value of the data source", "nullable": true, "example": "relatedProducts" }, "isAssociationType": { "type": "boolean", "description": "Whether the item is an example of assoication type" }, "supportedDataSource": { "type": "array", "items": { "$ref": "#/components/schemas/DatasourceDto" }, "description": "Data sources that the current item can have relationships with", "nullable": true } }, "additionalProperties": false }, "DatasourceDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DatasourceDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DocGenComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component. Text/ Table/ Loop/ LoopText/ LoopTable", "nullable": true, "example": "Text" }, "valueType": { "type": "string", "description": "Text/Number/Date", "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableColumnDto" }, "description": "Columns in this table", "nullable": true }, "textComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTextComponentDto" }, "description": "List of child text components of this component", "nullable": true }, "tableComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableComponentDto" }, "description": "List of child table components of this component", "nullable": true } }, "additionalProperties": false }, "DocGenComponentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocGenComponentDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocGenComponentLibraryDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Doc Gen Component Library Id", "format": "uuid" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenComponentLiteVersionDto" }, "description": "List of doc gen component versions of the library", "nullable": true } }, "additionalProperties": false }, "DocGenComponentLibraryDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenComponentLibraryDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocGenComponentLibraryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocGenComponentLibraryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocGenComponentLiteVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the set that the version belongs to", "format": "uuid" }, "name": { "type": "string", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" } }, "additionalProperties": false }, "DocGenComponentVersionDto": { "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", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "textComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTextComponentDto" }, "nullable": true }, "tableComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableComponentDto" }, "nullable": true }, "loopComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenLoopComponentDto" }, "nullable": true } }, "additionalProperties": false }, "DocGenComponentVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocGenComponentVersionDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocGenLoopComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component, Loop", "nullable": true, "readOnly": true }, "textComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTextComponentDto" }, "nullable": true }, "tableComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableComponentDto" }, "nullable": true }, "isAddedToTemplate": { "type": "boolean", "description": "True when this library component is already present in the template\r\nsupplied on the request (matched on content, ignoring instance/version\r\nidentifiers). Only populated when the request includes template context;\r\notherwise false." } }, "additionalProperties": false }, "DocGenTableColumnDto": { "type": "object", "properties": { "order": { "type": "integer", "description": "Order of this column", "format": "int32" }, "columnDataKey": { "type": "string", "description": "Datakey of this column.", "nullable": true, "example": "streetNumber/streetAddress" }, "columnLabel": { "type": "string", "description": "Label of this column.", "nullable": true, "example": "Street Number/Street Address" }, "valueType": { "type": "string", "description": "Value type for the column item Fenergo.Nebula.DocGen.Common.Const.ValueTypes for possible values.", "nullable": true, "example": "Text" } }, "additionalProperties": false }, "DocGenTableComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component, Table or LoopTable", "nullable": true, "readOnly": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableColumnDto" }, "description": "Columns in this table", "nullable": true }, "isAddedToTemplate": { "type": "boolean", "description": "True when this library component is already present in the template\r\nsupplied on the request (matched on content, ignoring instance/version\r\nidentifiers). Only populated when the request includes template context;\r\notherwise false." } }, "additionalProperties": false }, "DocGenTextComponentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of component", "nullable": true }, "parentId": { "type": "string", "description": "Id of the parent object that the component belongs to, e.g. Id of a LoopComponent\r\nThis field is relevant only when the component has a parent object", "format": "uuid", "nullable": true }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true }, "datasourceDataKey": { "type": "string", "description": "address", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Filter Conditions for data source or datakey (datagroup)", "nullable": true }, "dataSourceQueryParameter": { "allOf": [ { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } ], "description": "Nested data source query parameter", "nullable": true }, "type": { "type": "string", "description": "Type of component, Text or LoopText", "nullable": true }, "valueType": { "type": "string", "description": "Text/Number/Date", "nullable": true }, "isAddedToTemplate": { "type": "boolean", "description": "True when this library component is already present in the template\r\nsupplied on the request (matched on content, ignoring instance/version\r\nidentifiers). Only populated when the request includes template context;\r\notherwise false." } }, "additionalProperties": false }, "DocumentModelDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "documentManagementId": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "nullable": true }, "templateSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "warnings": { "type": "array", "items": { "type": "string" }, "nullable": true }, "templateVersionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DocumentModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GlobalNamingConventionSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Global Naming Convention Set Id", "format": "uuid" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/NamingConventionLiteVersionDto" }, "description": "List of naming convention versions of the set", "nullable": true } }, "additionalProperties": false }, "GlobalNamingConventionSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalNamingConventionSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GlobalNamingConventionSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GlobalNamingConventionSetDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "LanguageSelectDto": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageSelectDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSelectDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "NamingConventionGroupDto": { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/NamingConventionLineItemDto" }, "description": "List of the naming convention item elements", "nullable": true } }, "additionalProperties": false, "description": "Naming Convention Group Model. The group model is created per data source, e.g. EntityData, CreditScreening, etc." }, "NamingConventionLineItemDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "data key value", "nullable": true, "example": "firstName" }, "value": { "type": "string", "description": "display value for the datakey", "nullable": true, "example": "First Name" }, "type": { "type": "string", "description": "type of the data key", "nullable": true, "example": "text/date/number" } }, "additionalProperties": false, "description": "Naming Convention Line Item model" }, "NamingConventionLiteVersionDto": { "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", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" } }, "additionalProperties": false, "description": "The lite model of Naming Convention Version" }, "NamingConventionVersionDto": { "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", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "entityDataNamingConventionGroup": { "allOf": [ { "$ref": "#/components/schemas/NamingConventionGroupDto" } ], "description": "Naming Convention Group model for Entity Data", "nullable": true }, "productsNamingConventionGroup": { "allOf": [ { "$ref": "#/components/schemas/NamingConventionGroupDto" } ], "description": "Naming Convention Group model for Products", "nullable": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true } }, "additionalProperties": false, "description": "The version model of Naming Convention" }, "NamingConventionVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/NamingConventionVersionDto" } ], "description": "The version model of Naming Convention", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StringIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }