{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Doc Gen Command", "description": "**DocGen Command API**:\n\n
DocGen Command API provides configurational methods related to Document Generation. Use the Doc Gen Command API to create and update new and existing configuration. Use the Query API to retrieve configurations.\n\n
**DocGen Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/docgencommand" } ], "paths": { "/api/docgencomponent": { "post": { "tags": [ "DocGenComponent" ], "summary": "Create a new doc gen component library", "description": "\nCreate a new doc gen component library and store it in the database.

Required permissions:
Following permissions are required: DocGenConfigurationCreate", "operationId": "CreateDocGenComponentLibrary", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Create doc gen component library request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Doc gen component library created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}": { "delete": { "tags": [ "DocGenComponent" ], "summary": "Delete an existing doc gen component library and all its versions", "description": "\nDeletes an existing doc gen component library and all its versions.

Required permissions:
Following permissions are required: DocGenConfigurationDelete", "operationId": "DeleteDocGenComponentLibrary", "parameters": [ { "name": "id", "in": "path", "description": "Id for Doc Gen Component Library to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}/draft": { "post": { "tags": [ "DocGenComponent" ], "summary": "Create a new version for a doc gen component version", "description": "\nThis method creates a doc gen component version.\r\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate", "operationId": "CreateDocGenComponentVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version that the new version is based on", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Doc Gen Component Library with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/emptydraft": { "post": { "tags": [ "DocGenComponent" ], "summary": "Create a new version for a doc gen component version without data", "description": "\nThis method creates a doc gen component version but with no components or data from any previous version.\r\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate", "operationId": "CreateDocGenComponentEmptyVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocGenComponentVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Doc Gen Component Library with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}": { "put": { "tags": [ "DocGenComponent" ], "summary": "Update an existing doc gen component version", "description": "\nThis method updates an existing doc gen component version.\r\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateDocGenComponentVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing component library", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update doc gen component request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentVersionRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentVersionRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentVersionRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Doc gen component library with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "DocGenComponent" ], "summary": "Delete a doc gen component version", "description": "

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

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "SubmitDocGenComponentVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing component library", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Doc Gen Component library with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}/sign": { "put": { "tags": [ "DocGenComponent" ], "summary": "Sign an existing doc gen component version", "description": "\nThis method signs the selected doc gen component version of an existing set.\r\n The Status of the version changes according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: DocGenConfigurationApprove", "operationId": "SignDocGenComponentVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Doc Gen Component library with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}/archive": { "put": { "tags": [ "DocGenComponent" ], "summary": "Archive an existing doc gen component version", "description": "\nThis method archives the selected doc gen component version of an existing library.

Required permissions:
Following permissions are required: DocGenConfigurationArchive", "operationId": "ArchiveDocGenComponentVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Doc Gen Component Library with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}/components": { "post": { "tags": [ "DocGenComponent" ], "summary": "Add a component", "description": "

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "AddDocGenComponent", "parameters": [ { "name": "id", "in": "path", "description": "Library id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Component library version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Add component request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNewComponentDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNewComponentDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateNewComponentDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Component added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocGenComponentResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Component library with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "put": { "tags": [ "DocGenComponent" ], "summary": "Update component", "description": "\nUpdates an existing component in specific component version.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateDocGenComponent", "parameters": [ { "name": "id", "in": "path", "description": "Component library id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Component library version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update component request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Component updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocGenComponentResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Component library with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docgencomponent/{id}/versions/{versionNumber}/components/multiple": { "post": { "tags": [ "DocGenComponent" ], "summary": "Add mulitple components", "description": "

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

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "DeleteDocGenComponent", "parameters": [ { "name": "id", "in": "path", "description": "Component library id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Compomnent library version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentId", "in": "path", "description": "Component id to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Component deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Component library/component with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/namingconvention": { "post": { "tags": [ "NamingConvention" ], "summary": "Create a new global naming convension set", "description": "\nCreate a new naming convention set model and store it in the database.

Required permissions:
Following permissions are required: DocGenConfigurationCreate", "operationId": "CreateGlobalNamingConventionSet", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Create a naming convension set request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Naming convention set created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/namingconvention/{setId}": { "delete": { "tags": [ "NamingConvention" ], "summary": "Delete an existing global naming convension set and all its versions", "description": "\nDeletes an existing global naming convension set and all its versions.

Required permissions:
Following permissions are required: DocGenConfigurationDelete", "operationId": "DeleteGlobalNamingConventionSet", "parameters": [ { "name": "setId", "in": "path", "description": "Id for Global Naming Convention Set to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/namingconvention/{setId}/version/{versionNumber}/draft": { "post": { "tags": [ "NamingConvention" ], "summary": "Create a new version for an existing global naming convention set", "description": "\nThis method creates a new naming convention version.\r\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate", "operationId": "CreateNamingConventionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version that the new version is based on", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NamingConventionVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NamingConventionVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamingConventionVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Naming Convention Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/namingconvention/{setId}/version/{versionNumber}": { "put": { "tags": [ "NamingConvention" ], "summary": "Update an existing naming convention version", "description": "\nThis method updates an existing naming convention version.\r\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateNamingConventionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update naming convention version request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNamingConventionVersionRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNamingConventionVersionRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateNamingConventionVersionRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Naming Convention Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "NamingConvention" ], "summary": "Delete a naming convention version", "description": "

Required permissions:
Following permissions are required: DocGenConfigurationDelete", "operationId": "DeleteNamingConventionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Global Naming Convention set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. The specified version deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Global naming convention 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}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "NamingConvention" ], "summary": "Submit an existing naming convention version for Approval", "description": "\nThis method submits the selected naming convention version of an existing set for Approval.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "SubmitNamingConventionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Naming Convention Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/namingconvention/{setId}/version/{versionNumber}/sign": { "put": { "tags": [ "NamingConvention" ], "summary": "Sign an existing naming convention version", "description": "\nThis method signs the selected naming convention version of an existing set.\r\n The Status of the version changes according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: DocGenConfigurationApprove", "operationId": "SignNamingConventionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Naming Convention Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/namingconvention/{setId}/version/{versionNumber}/archive": { "put": { "tags": [ "NamingConvention" ], "summary": "Archive an existing naming convention version", "description": "\nThis method archives the selected naming convention version of an existing set.

Required permissions:
Following permissions are required: DocGenConfigurationArchive", "operationId": "ArchiveNamingConventionVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Naming Convention Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template": { "post": { "tags": [ "Template" ], "summary": "Create a new custom template set", "description": "\nCreate a new custom template set model and store it in the database.

Required permissions:
Following permissions are required: DocGenConfigurationCreate", "operationId": "CreateCustomTemplateSet", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Create a custom template set request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateSetRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateSetRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateSetRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Custom template set created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateSetResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}": { "delete": { "tags": [ "Template" ], "summary": "Delete an existing custom template set and all its versions", "description": "\nDeletes an existing custom template set and all its versions.

Required permissions:
Following permissions are required: DocGenConfigurationDelete", "operationId": "DeleteCustomTemplateSet", "parameters": [ { "name": "setId", "in": "path", "description": "Id for Custom Template Set to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/draft": { "post": { "tags": [ "Template" ], "summary": "Create a new version for an existing custom template set", "description": "\nThis method creates a new custom template version.\r\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate", "operationId": "CreateCustomTemplateVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version that the new version is based on", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/emptydraft": { "post": { "tags": [ "Template" ], "summary": "Create a new version for an existing custom template set without data", "description": "\nThis method creates a new custom template version but with no components or data from any previous version>\r\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
At least one of the following permissions is required: DocGenConfigurationEdit, DocGenConfigurationCreate", "operationId": "CreateCustomTemplateEmptyVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}": { "put": { "tags": [ "Template" ], "summary": "Update an existing custom template version", "description": "\nThis method updates an existing custom template version.\r\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateCustomTemplateVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update custom template version request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateVersionRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateVersionRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateVersionRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "Template" ], "summary": "Delete a custom template version", "description": "

Required permissions:
Following permissions are required: DocGenConfigurationDelete", "operationId": "DeleteCustomTemplateVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Custom Template set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. The specified version deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Custom template set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "Template" ], "summary": "Submit an existing custom template version for Approval", "description": "\nThis method submits the selected custom template version of an existing set for Approval.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "SubmitCustomTemplateVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/sign": { "put": { "tags": [ "Template" ], "summary": "Sign an existing custom template version", "description": "\nThis method signs the selected custom template version of an existing set.\r\n The Status of the version changes according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: DocGenConfigurationApprove", "operationId": "SignCustomTemplateVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VersionSignResponseServiceResponse" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/archive": { "put": { "tags": [ "Template" ], "summary": "Archive an existing custom template version", "description": "\nThis method archives the selected custom template version of an existing template set.

Required permissions:
Following permissions are required: DocGenConfigurationArchive", "operationId": "ArchiveCustomTemplateVersion", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/context/htmloverride": { "post": { "tags": [ "Template" ], "summary": "Save the Html Override Context metadata and get a resigned Url to upload the context file", "description": "\nThis method updates the HtmlOverrideContext property in Custom Template Version model.\r\n\nThis method also gets the presigned Url to allow the user to upload the file in the AWS S3 bucket.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateHtmlOverrideContext", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The upload file request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.UpdateHtmlOverrideContextFileResponseDto class with some metadata that represent the file uploaded", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextFileResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextFileResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextFileResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/context/htmloverride/file": { "delete": { "tags": [ "Template" ], "summary": "Delete Html Override Context file", "description": "\nDelete the Context file of the custom html overriding the default template.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "DeleteHtmlOverrideContextFile", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/context/htmloverride/metadata": { "put": { "tags": [ "Template" ], "summary": "Update Html Override Context metadata", "description": "\nUpdate the Context metadata.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateHtmlOverrideContextMetadata", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update context metadata request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/components": { "post": { "tags": [ "Template" ], "summary": "Add a component to a template version", "description": "\nThis method add component in Custom Template Version model.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "AddCustomTemplateComponent", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The add component request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNewTemplateComponentDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNewTemplateComponentDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateNewTemplateComponentDtoServiceRequest" } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.CreateCustomTemplateComponentResponseDto class with some metadata of the component to add", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/components/docgencomponent": { "post": { "tags": [ "Template" ], "summary": "Add a doc gen component to a template version", "description": "\nThis method copys a doc gen component and add it with a new component Id to Custom Template Version model.\r\n\nIf a doc gen component has child components, the childrens are also added to the custom template version

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "AddDocGenComponentToCustomTemplate", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number of the existing template version", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The add component request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.AddDocGenComponentToTemplateRequestDto class with some metadata that the doc gen component to add", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/components/multiple": { "post": { "tags": [ "Template" ], "summary": "Add mulitple components", "description": "\nThis method add multiple component in Custom Template Version model.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "AddCustomTemplateComponents", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Add components request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Components added", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/components/{componentId}": { "delete": { "tags": [ "Template" ], "summary": "Delete a component", "description": "\nThis method delete component in Custom Template Version model.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "DeleteCustomTemplateComponent", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the existing template set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentId", "in": "path", "description": "Component id to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Component deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Template set/component with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/template/{setId}/version/{versionNumber}/components/{componentId}/context/template": { "post": { "tags": [ "Template" ], "summary": "Save the Template Context metadata and get a resigned Url to upload the context file", "description": "\nThis method updates the TemplateContext property in CustomTemplateLoopComponent model.\r\n\nThis method also gets the presigned Url to allow the user to upload the file in the AWS S3 bucket.\r\n\nBy updating the file by using the presigned Url, you will replace the existing file.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "UpdateCustomTemplateComponentTemplateContext", "parameters": [ { "name": "setId", "in": "path", "description": "Custom Template Set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Custom Template Version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentId", "in": "path", "description": "Component id to upload a template", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The upload file request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.DocGen.Command.Application.Dto.CustomTemplate.UpdateCustomTemplateComponentTemplateContextReponseDto class with some metadata that represent the file uploaded", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "Template" ], "summary": "Delete Template Context file", "description": "\nDelete the Template Context file file of a given loop component.

Required permissions:
Following permissions are required: DocGenConfigurationEdit", "operationId": "DeleteCustomTemplateComponentTemplateContext", "parameters": [ { "name": "setId", "in": "path", "description": "Custom Template Set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Custom Template Version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentId", "in": "path", "description": "Component id to delete its template", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Custom Template Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AddDocGenComponentToTemplateRequestDto": { "type": "object", "properties": { "docGenComponentVersionId": { "type": "string", "description": "The UiD of the doc gen component version that the component belongs to", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "docGenComponentId": { "type": "string", "description": "The UiD of the doc gen component", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" } }, "additionalProperties": false }, "AddDocGenComponentToTemplateRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateRequestDto" } }, "additionalProperties": false }, "AddDocGenComponentToTemplateResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the created component", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "childComponentIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UiD of the created child components", "nullable": true } }, "additionalProperties": false }, "AddDocGenComponentToTemplateResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddDocGenComponentToTemplateResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "$ref": "#/components/schemas/Decision" }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ApproveActionServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproveAction" } }, "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": { "$ref": "#/components/schemas/ValueField" } }, "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 updae time of context metadata", "format": "date-time" } }, "additionalProperties": false }, "CreateCustomTemplateComponentResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the created component", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" } }, "additionalProperties": false }, "CreateCustomTemplateComponentResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCustomTemplateComponentResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateCustomTemplateComponentsRequestDto": { "type": "object", "properties": { "components": { "type": "array", "items": { "$ref": "#/components/schemas/CreateNewTemplateComponentDto" }, "description": "The list of template components", "nullable": true } }, "additionalProperties": false }, "CreateCustomTemplateComponentsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsRequestDto" } }, "additionalProperties": false }, "CreateCustomTemplateComponentsResponseDto": { "type": "object", "properties": { "componentIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list of copmonent id that created", "nullable": true } }, "additionalProperties": false }, "CreateCustomTemplateComponentsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCustomTemplateComponentsResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateCustomTemplateSetRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the custom template", "nullable": true }, "description": { "type": "string", "description": "Description for the custom template", "nullable": true } }, "additionalProperties": false, "description": "Create a new Custom Template Set request model" }, "CreateCustomTemplateSetRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCustomTemplateSetRequestDto" } }, "additionalProperties": false }, "CreateCustomTemplateSetResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the custom template set created", "format": "uuid" }, "version": { "$ref": "#/components/schemas/CustomTemplateVersionDtoBase" } }, "additionalProperties": false, "description": "Create a new Custom Template Set response model" }, "CreateCustomTemplateSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCustomTemplateSetResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateCustomTemplateVersionResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version to update", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the custom template set that the version belongs to", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The version number of the version to update", "format": "int32" }, "name": { "type": "string", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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 displayed in the pdf", "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." }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" }, "status": { "$ref": "#/components/schemas/VersionStatus" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "htmlOverrideContext": { "$ref": "#/components/schemas/ContextDto" }, "customLayout": { "$ref": "#/components/schemas/CustomTemplateLayoutDto" }, "internalTemplateVersionNumber": { "type": "integer", "description": "The internal version number for template version", "format": "int32", "nullable": true, "example": 2 } }, "additionalProperties": false }, "CreateCustomTemplateVersionResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCustomTemplateVersionResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDocGenComponentLibraryRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the component library", "nullable": true }, "description": { "type": "string", "description": "Description for the component library", "nullable": true } }, "additionalProperties": false }, "CreateDocGenComponentLibraryRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryRequestDto" } }, "additionalProperties": false }, "CreateDocGenComponentLibraryResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the component library created", "format": "uuid" }, "version": { "$ref": "#/components/schemas/DocGenComponentVersionDto" } }, "additionalProperties": false }, "CreateDocGenComponentLibraryResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDocGenComponentLibraryResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDocGenComponentResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the created component", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" } }, "additionalProperties": false, "description": "Response DTO representing created component Instance" }, "CreateDocGenComponentResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDocGenComponentResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateDocGenComponentsRequestDto": { "type": "object", "properties": { "components": { "type": "array", "items": { "$ref": "#/components/schemas/CreateNewComponentDto" }, "description": "List of the components to be created", "nullable": true } }, "additionalProperties": false }, "CreateDocGenComponentsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDocGenComponentsRequestDto" } }, "additionalProperties": false }, "CreateDocGenComponentsResponseDto": { "type": "object", "properties": { "componentIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateDocGenComponentsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDocGenComponentsResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateGlobalNamingConventionSetRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the naming convention", "nullable": true }, "description": { "type": "string", "description": "Description for the naming convention", "nullable": true } }, "additionalProperties": false, "description": "Create a new Global Naming Convention Set request model" }, "CreateGlobalNamingConventionSetRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetRequestDto" } }, "additionalProperties": false }, "CreateGlobalNamingConventionSetResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the global naming convention set created", "format": "uuid" }, "version": { "$ref": "#/components/schemas/NamingConventionVersionDto" } }, "additionalProperties": false, "description": "Create a new Global Naming Convention Set response model" }, "CreateGlobalNamingConventionSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateGlobalNamingConventionSetResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateNewComponentDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of component. Text/ Table/ Loop/ LoopText/ LoopTable", "nullable": true, "example": "Text" }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true, "deprecated": 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, "deprecated": true }, "valueType": { "type": "string", "description": "Text/Number/Date", "nullable": true }, "dataSourceQueryParameter": { "$ref": "#/components/schemas/DataSourceQueryParameterDto" }, "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 }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableColumnDto" }, "description": "Columns in this table", "nullable": true }, "id": { "type": "string", "description": "The UiD of the component", "format": "uuid", "example": "84ec28e2-d786-417b-850f-96321dd849dd" } }, "additionalProperties": false }, "CreateNewComponentDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateNewComponentDto" } }, "additionalProperties": false }, "CreateNewTemplateComponentDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of component. Text/ Table/ Loop/ LoopText/ LoopTable", "nullable": true, "example": "Text" }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true, "deprecated": 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, "deprecated": true }, "valueType": { "type": "string", "description": "Text/Number/Date", "nullable": true }, "dataSourceQueryParameter": { "$ref": "#/components/schemas/DataSourceQueryParameterDto" }, "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 }, "id": { "type": "string", "description": "The UiD of the component", "format": "uuid", "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/CustomTemplateTableColumnDto" }, "description": "Columns in this table", "nullable": true }, "sourceContextFileUrl": { "type": "string", "description": "URL to read the template context file of a loop component from another tenant, as handed out by\r\nthe query API. Set when a loop component is copied between tenants: the file is fetched server\r\nside and its context is recorded, with a default display name, once that has succeeded.\r\nIgnored for other component types, and only honoured when components are added in bulk - a\r\nsingle add rejects loop components.", "nullable": true } }, "additionalProperties": false }, "CreateNewTemplateComponentDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateNewTemplateComponentDto" } }, "additionalProperties": false }, "CustomTemplateLayoutDto": { "type": "object", "properties": { "scale": { "type": "number", "description": "Scale of the custom layout", "format": "double", "nullable": true }, "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 }, "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": "Text/Number/Date", "nullable": true } }, "additionalProperties": false }, "CustomTemplateVersionDtoBase": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version to update", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the custom template set that the version belongs to", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The version number of the version to update", "format": "int32" }, "name": { "type": "string", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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 displayed in the pdf", "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." }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" } }, "additionalProperties": false }, "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": { "$ref": "#/components/schemas/DataSourceQueryParameterDto" } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DocGenComponentVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the component library that the version belongs to", "format": "uuid" }, "name": { "type": "string", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" }, "status": { "$ref": "#/components/schemas/VersionStatus" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" } }, "additionalProperties": false }, "DocGenComponentVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocGenComponentVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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": "Text/Number/Date", "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" }, "NamingConventionVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the global naming convention 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 }, "entityDataNamingConventionGroup": { "$ref": "#/components/schemas/NamingConventionGroupDto" }, "productsNamingConventionGroup": { "$ref": "#/components/schemas/NamingConventionGroupDto" }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" }, "status": { "$ref": "#/components/schemas/VersionStatus" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" } }, "additionalProperties": false, "description": "The version model of Naming Convention" }, "NamingConventionVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NamingConventionVersionDto" }, "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 }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateCustomTemplateComponentTemplateContextReponseDto": { "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 }, "signedUrlToUpload": { "type": "string", "description": "Url to upload the file into S3 bucket", "nullable": true }, "lastUpdatedTime": { "type": "string", "description": "Last update time of context", "format": "date-time" } }, "additionalProperties": false }, "UpdateCustomTemplateComponentTemplateContextReponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextReponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateCustomTemplateComponentTemplateContextRequestDto": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "description": "Display name for context file", "example": "passport.pdf" }, "description": { "type": "string", "description": "Description of the Context", "nullable": true } }, "additionalProperties": false }, "UpdateCustomTemplateComponentTemplateContextRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateCustomTemplateComponentTemplateContextRequestDto" } }, "additionalProperties": false }, "UpdateCustomTemplateVersionRequestDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version to update", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the custom template set that the version belongs to", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The version number of the version to update", "format": "int32" }, "name": { "type": "string", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "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 displayed in the pdf", "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." }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" }, "customLayout": { "$ref": "#/components/schemas/CustomTemplateLayoutDto" }, "sourceContextFileUrl": { "type": "string", "description": "Signed url for an http context file from another version/tenant. If provided will override the current context file and metadata.", "nullable": true } }, "additionalProperties": false }, "UpdateCustomTemplateVersionRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateCustomTemplateVersionRequestDto" } }, "additionalProperties": false }, "UpdateDocGenComponentDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of component. Text/ Table/ Loop/ LoopText/ LoopTable", "nullable": true, "example": "Text" }, "componentKey": { "type": "string", "description": "key name for this component. this must be unique", "nullable": true }, "datasource": { "type": "string", "description": "Related Product/MainEntity", "nullable": true, "deprecated": 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, "deprecated": true }, "valueType": { "type": "string", "description": "Text/Number/Date", "nullable": true }, "dataSourceQueryParameter": { "$ref": "#/components/schemas/DataSourceQueryParameterDto" }, "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 }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenTableColumnDto" }, "description": "Columns in this table", "nullable": true }, "id": { "type": "string", "description": "The UiD of the component", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the component library", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "version": { "type": "integer", "description": "The version of the component in the library", "format": "int32", "example": 1 } }, "additionalProperties": false }, "UpdateDocGenComponentDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateDocGenComponentDto" } }, "additionalProperties": false }, "UpdateDocGenComponentResponseDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of the component after the update", "format": "int32", "example": 4 } }, "additionalProperties": false, "description": "Response DTO representing updated component" }, "UpdateDocGenComponentResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateDocGenComponentResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateDocGenComponentVersionRequestDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version to update", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the doc gen component library that the version belongs to", "format": "uuid" }, "name": { "type": "string", "description": "Name of the version", "nullable": true }, "description": { "type": "string", "description": "Description for the version", "nullable": true }, "versionNumber": { "type": "integer", "description": "The version number of the version to update", "format": "int32" }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" } }, "additionalProperties": false }, "UpdateDocGenComponentVersionRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateDocGenComponentVersionRequestDto" } }, "additionalProperties": false }, "UpdateHtmlOverrideContextFileResponseDto": { "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 }, "signedUrlToUpload": { "type": "string", "description": "Url to upload the file into S3 bucket", "nullable": true }, "lastUpdatedTime": { "type": "string", "description": "Last update time of context", "format": "date-time" } }, "additionalProperties": false }, "UpdateHtmlOverrideContextFileResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextFileResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateHtmlOverrideContextMetadataRequestDto": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the context", "nullable": true } }, "additionalProperties": false, "description": "Defines request for context metadata update" }, "UpdateHtmlOverrideContextMetadataRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextMetadataRequestDto" } }, "additionalProperties": false }, "UpdateHtmlOverrideContextRequestDto": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string", "description": "Display name for context file", "example": "passport.pdf" }, "description": { "type": "string", "description": "Description of the Context", "nullable": true } }, "additionalProperties": false }, "UpdateHtmlOverrideContextRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateHtmlOverrideContextRequestDto" } }, "additionalProperties": false }, "UpdateNamingConventionVersionRequestDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the version to update", "format": "uuid" }, "setId": { "type": "string", "description": "Id of the global naming convention 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 }, "entityDataNamingConventionGroup": { "$ref": "#/components/schemas/NamingConventionGroupDto" }, "productsNamingConventionGroup": { "$ref": "#/components/schemas/NamingConventionGroupDto" }, "versionNumber": { "type": "integer", "description": "The version number of the version to update", "format": "int32" }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T00:00:00.000Z" } }, "additionalProperties": false, "description": "Update Naming Convention Version request model" }, "UpdateNamingConventionVersionRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateNamingConventionVersionRequestDto" } }, "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 }, "VersionSignResponse": { "type": "object", "properties": { "setId": { "type": "string", "description": "The Id of the set model that the version belongs to", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The number of the version that has been signed", "format": "int32" }, "status": { "$ref": "#/components/schemas/VersionStatus" } }, "additionalProperties": false }, "VersionSignResponseServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VersionSignResponse" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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": [ ] } ] }