{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Change Management Command", "description": "**Change Management Command API**:


Change Management Command API provides endpoints in order to manage and configure -.


**Change Management Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/changemanagementcommand" } ], "paths": { "/api/change-management": { "post": { "tags": [ "Conflicts" ], "summary": "Creates a conflict", "description": "\nThis method creates a conflicts model.\r\n\nThe method returns an object containing some basic information as the result to the user, \r\n and type. The returned Id can be used in the query api to get the conflicts.", "operationId": "CreateConflicts", "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": "The create conflicts request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "An instance of the Fenergo.Nebula.ChangeManagement.Common.DTO.ConflictsDto class with some metadata that represent the product created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConflictsDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConflictsDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConflictsDtoServiceResponse" } } } }, "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" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "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/change-management/conflict/{id}": { "put": { "tags": [ "Conflicts" ], "summary": "Update conflict", "description": "\nUpdates an existing conflict.", "operationId": "UpdateConflicts", "parameters": [ { "name": "id", "in": "path", "description": "Conflict id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update conflict request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Conflict updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConflictsDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConflictsDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConflictsDtoServiceResponse" } } } }, "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" } } } }, "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" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Conflict 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/review-approval-configuration": { "post": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Creates a configuration", "description": "\nThis method creates a configuration model.\r\n\nThe method returns id of newly created model.

Required permissions:
Following permissions are required: ReviewApprovalConfigurationCreate", "operationId": "CreateConfiguration", "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": "The create ConfigurationDto request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ] } } } }, "responses": { "202": { "description": "An instance of the System.Guid with newly created id", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } } } }, "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" } } } }, "401": { "description": "Unauthorised" }, "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/review-approval-configuration/{id}": { "delete": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Remove configuration", "description": "\nRemove configuration .

Required permissions:
Following permissions are required: ReviewApprovalConfigurationDelete", "operationId": "DeleteConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Configuration id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Configuration removed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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" } } } }, "401": { "description": "Unauthorised" }, "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": [ "ReviewAndApprovalConfiguration" ], "summary": "Update configuration", "description": "\nUpdates an existing configuration .

Required permissions:
Following permissions are required: ReviewApprovalConfigurationEdit", "operationId": "UpdateConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Configuration id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update configuration request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationDto" } ] } } } }, "responses": { "202": { "description": "Success. configuration updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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. Configuration with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "Unauthorised" }, "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/review-approval-configuration/{id}/draft": { "post": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Create a draft from the published configuration version", "description": "\nCreates a new draft version of a review approval configuration profile by cloning the current published version.

Required permissions:
Following permissions are required: ReviewApprovalConfigurationEdit", "operationId": "CreateDraftConfigurationVersion", "parameters": [ { "name": "id", "in": "path", "description": "Profile id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Draft version created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } } } }, "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. Profile with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "Unauthorised" }, "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/review-approval-configuration/{id}/publish": { "post": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Publish a configuration version", "description": "\nPublishes the current draft version of a review approval configuration profile.

Required permissions:
Following permissions are required: ReviewApprovalConfigurationApprove", "operationId": "PublishConfigurationVersion", "parameters": [ { "name": "id", "in": "path", "description": "Profile id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Publish request containing optional version note", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishConfigurationVersionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishConfigurationVersionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishConfigurationVersionRequest" } ] } } } }, "responses": { "202": { "description": "Success. Version published", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } } } }, "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. Profile with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "Unauthorised" }, "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/review-approval-configuration/{id}/versions/{versionNumber}/archive": { "post": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Archive a configuration version", "description": "\nArchives a specific published version of a review approval configuration profile.

Required permissions:
Following permissions are required: ReviewApprovalConfigurationArchive", "operationId": "ArchiveConfigurationVersion", "parameters": [ { "name": "id", "in": "path", "description": "Profile id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number 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": "Success. Version archived", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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. Profile with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "Unauthorised" }, "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/review-approval-configuration/{id}/versions/{versionNumber}/submit-for-approval": { "post": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Submit a configuration version for approval", "description": "

Required permissions:
Following permissions are required: ReviewApprovalConfigurationEdit", "operationId": "SubmitConfigurationVersion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSummaryDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/review-approval-configuration/{id}/versions/{versionNumber}/reject": { "post": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Reject a configuration version", "description": "

Required permissions:
Following permissions are required: ReviewApprovalConfigurationApprove", "operationId": "RejectConfigurationVersion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/review-approval-configuration/{id}/versions/{versionNumber}": { "delete": { "tags": [ "ReviewAndApprovalConfiguration" ], "summary": "Delete a specific configuration version", "description": "

Required permissions:
Following permissions are required: ReviewApprovalConfigurationDelete", "operationId": "DeleteConfigurationVersion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/review-approval-task/journey/{journeyId}/task/{taskId}/comment": { "post": { "tags": [ "ReviewAndApprovalTask" ], "summary": "Creates a comment for a review and approval task entity.", "description": "

Required permissions:
Following permissions are required: ReviewApprovalComment", "operationId": "CreateComment", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskDataKey", "in": "query", "description": "approval1", "required": true, "schema": { "type": "string" } }, { "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": "Request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/review-approval-task/journey/{journeyId}/task/{taskId}/comment/{commentId}": { "delete": { "tags": [ "ReviewAndApprovalTask" ], "summary": "Deletes a comment for a review and approval task entity.", "description": "

Required permissions:
Following permissions are required: ReviewApprovalComment", "operationId": "DeleteComment", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "description": "Comment ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } }, "put": { "tags": [ "ReviewAndApprovalTask" ], "summary": "Updates a comment for a review and approval task entity.", "description": "

Required permissions:
Following permissions are required: ReviewApprovalComment", "operationId": "UpdateComment", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "description": "Comment ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/review-approval-task/journey/{journeyId}/task/{taskId}/comment/{commentId}/resolve": { "post": { "tags": [ "ReviewAndApprovalTask" ], "summary": "Resolves a comment in a review and approval task entity.", "description": "

Required permissions:
Following permissions are required: ReviewApprovalResolveComments", "operationId": "ResolveComment", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "commentId", "in": "path", "description": "Comment ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BooleanServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BooleanServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BooleanServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GuidServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/review-approval-task/journey/{journeyId}/task/{taskId}/item/{itemKey}/comments/resolveAll": { "post": { "tags": [ "ReviewAndApprovalTask" ], "summary": "Resolves all comments for item in a review and approval task entity.", "description": "

Required permissions:
Following permissions are required: ReviewApprovalResolveComments", "operationId": "ResolveAllCommentsForItem", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "itemKey", "in": "path", "description": "Item key.", "required": true, "schema": { "type": "string" } }, { "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", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } }, "/api/review-approval-task/journey/{journeyId}/task/{taskId}/approval": { "post": { "tags": [ "ReviewAndApprovalTask" ], "summary": "Creates an approval for a review and approval task entity.", "description": "

Required permissions:
Following permissions are required: ReviewApprovalDecision", "operationId": "CreateApproval", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task ID.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskDataKey", "in": "query", "description": "approval1", "required": true, "schema": { "type": "string" } }, { "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": "Request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDtoServiceResponse" } } } }, "400": { "description": "One or more validation errors occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred", "detail": "Name is required", "status": 400, "errorCode": "VALIDATION_ERROR", "validationErrors": [ { "propertyName": "Name", "errorMessage": "Name is required", "attemptedValue": "", "validatorType": "NotEmptyValidator" } ] } } } }, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3", "title": "Access to resource is forbidden.", "detail": "Access denied. Following permissions are required: Permission1, Permission2", "status": 403 } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1", "title": "Internal server exception. Please, contact your provider.", "detail": null, "status": 500, "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/ProblemDetails" }, "example": { "type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9", "title": "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.", "detail": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "status": 410, "errorCode": "OBSOLETE_ENDPOINT" } } } } } } } }, "components": { "schemas": { "ApprovalConfigurationDto": { "type": "object", "properties": { "approvalOptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "approvalOptionsConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalOptionConfigurationDto" }, "nullable": true }, "requireResolutionofAllComments": { "type": "boolean" }, "topicsLookup": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApprovalOptionConfigurationDto": { "type": "object", "properties": { "option": { "type": "string", "nullable": true }, "reasonType": { "type": "string", "nullable": true }, "lookup": { "type": "string", "nullable": true }, "linkLookup": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BankAccountsDetailsDto": { "type": "object", "properties": { "dataAndDocumentPolicyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BooleanServiceRequest": { "type": "object", "properties": { "data": { "type": "boolean" } }, "additionalProperties": false }, "ChangeDomain": { "enum": [ "Related Parties", "Managed Relationship", "Accounts", "Primary Entity Data" ], "type": "string" }, "CollectionDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "showChangesFor": { "type": "array", "items": { "type": "string" }, "nullable": true }, "approvalConfiguration": { "allOf": [ { "$ref": "#/components/schemas/ApprovalConfigurationDto" } ], "nullable": true }, "entityDataDetails": { "allOf": [ { "$ref": "#/components/schemas/EntityDataDetailsDto" } ], "nullable": true }, "documentsDetails": { "allOf": [ { "$ref": "#/components/schemas/DocumentsDetailsDto" } ], "nullable": true }, "relatedPartiesDetails": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDetailsDto" } ], "nullable": true }, "productsDetails": { "allOf": [ { "$ref": "#/components/schemas/ProductsDetailsDto" } ], "nullable": true }, "riskDetails": { "allOf": [ { "$ref": "#/components/schemas/RiskDetailsDto" } ], "nullable": true }, "investmentAccountsDetails": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountsDetailsDto" } ], "nullable": true }, "bankAccountsDetails": { "allOf": [ { "$ref": "#/components/schemas/BankAccountsDetailsDto" } ], "nullable": true } }, "additionalProperties": false }, "ConfigurationVersionSummaryDto": { "type": "object", "properties": { "versionNumber": { "type": "integer", "format": "int32" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ] }, "name": { "type": "string", "nullable": true }, "versionNote": { "type": "string", "nullable": true }, "changedFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "publishedBy": { "type": "string", "nullable": true }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "archivedBy": { "type": "string", "nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "submittedBy": { "type": "string", "nullable": true }, "submittedAt": { "type": "string", "format": "date-time", "nullable": true }, "rejectedBy": { "type": "string", "nullable": true }, "rejectedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ConfigurationVersionSummaryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationVersionSummaryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConflictsDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "entityConflicts": { "type": "array", "items": { "$ref": "#/components/schemas/EntityConflictDto" }, "nullable": true }, "managedRelationshipConflicts": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedRelationshipConflictDto" }, "nullable": true }, "conflictingDomains": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeDomain" }, "nullable": true } }, "additionalProperties": false }, "ConflictsDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDto" } ], "nullable": true } }, "additionalProperties": false }, "ConflictsDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConflictsDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false } ] }, "DataColumnDto": { "type": "object", "properties": { "dataKey": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentsDetailsDto": { "type": "object", "properties": { "requirementCategories": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EntityConflictDto": { "type": "object", "properties": { "existingValue": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "nullable": true }, "newValue": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "nullable": true }, "chosenValue": { "type": "string", "nullable": true }, "dataKey": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "isMaterialData": { "type": "boolean" }, "dataColumns": { "type": "array", "items": { "$ref": "#/components/schemas/DataColumnDto" }, "nullable": true } }, "additionalProperties": false }, "EntityDataDetailsDto": { "type": "object", "properties": { "requirementCategories": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GuidServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "format": "uuid" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "InvestmentAccountsDetailsDto": { "type": "object", "properties": { "dataAndDocumentPolicyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ManagedRelationshipConflictDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "agentName": { "type": "string", "nullable": true }, "dataConflicts": { "type": "array", "items": { "$ref": "#/components/schemas/EntityConflictDto" }, "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": { } }, "ProductsDetailsDto": { "type": "object", "properties": { "productCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productScopingRule": { "type": "string", "nullable": true }, "enableAllProductCategories": { "type": "boolean" } }, "additionalProperties": false }, "PropertyDto": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true } }, "additionalProperties": false }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "PublishConfigurationVersionRequest": { "type": "object", "properties": { "versionNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelatedPartiesDetailsDto": { "type": "object", "properties": { "dataAndDocumentPolicyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relatedPartyScopingRule": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalTaskApprovalDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "reasonType": { "type": "string", "nullable": true }, "parentReason": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "reopenTaskId": { "type": "string", "nullable": true }, "reopenTaskName": { "type": "string", "nullable": true }, "reopenComment": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReviewAndApprovalTaskApprovalDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDto" } ], "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalTaskApprovalDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskApprovalDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalTaskCommentDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "itemKey": { "type": "string", "nullable": true }, "authorId": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "updatedOn": { "type": "string", "format": "date-time", "nullable": true }, "isResolved": { "type": "boolean" } }, "additionalProperties": false }, "ReviewAndApprovalTaskCommentDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDto" } ], "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalTaskCommentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalTaskCommentDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskDetailsDto": { "type": "object", "properties": { "riskSubTabs": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "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 }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "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 }, "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": [ ] } ] }