{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Journey Command",
"description": "**Journey Command API**:\n\n
Journey Command API provides both configurational and operational methods related to the client Journeys. Use the Journey Command API to create and manage Journey Schemas and Journey Instances. Use the Command Query API to retrieve Journey Schema and Journey Instance aggregates.\n\n
**Journey Command API provides**:
- The ability to create, update and delete Journey Schemas.
- The ability to manage versions of Journey Schemas - that include creating new versions, archiving existing versions, submiting drafts for approval and signing or rejecting versions.
- The ability to create a new Journey Instance.
- The ability to manage the Journey Instance: complete task/condition/review or cancel the Journey Instance.
",
"version": "1.0"
},
"servers": [
{
"url": "/journeycommand"
}
],
"paths": {
"/api/configuration": {
"put": {
"tags": [
"JourneyConfiguration"
],
"summary": "Update journey configuration",
"description": "\nUpdates the configuration
Required permissions:
Following permissions are required: JourneyConfigurationEdit",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Update configuration request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyConfigurationRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Configuration updated"
},
"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"
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/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/journey-instance": {
"post": {
"tags": [
"JourneyInstance"
],
"summary": "Create journey instance",
"description": "\nCreates a new journey instance. The request must contain journey schema id that is currently published and in\n effect.
Required permissions:
Following permissions are required: JourneyCreate",
"operationId": "CreateJourney",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Create journey instance request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneyInstanceDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instance created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyInstanceCreatedDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/abort": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Cancel journey instance",
"description": "\nCancels a currently in progress journey instance and rejects the associated entity draft.
Required permissions:
Following permissions are required: JourneyCancel",
"operationId": "AbortJourneyInstance",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id to cancel",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Abort journey instance details (Optional)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AbortJourneyDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instance canceled"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/batch/abort": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Batch cancel journey instances",
"description": "\nCancels all currently in progress journey instance and rejects the associated entity draft.
Required permissions:
Following permissions are required: JourneyCancel",
"operationId": "BatchAbortJourneyInstances",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Abort journey instances request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AbortMultipleJourneysDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instances canceled"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/complete": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Complete journey instance task",
"description": "\n - Completes a currently in progress task.
\n - \n If the task is not the last one in given process, the next task will be started, otherwise next process\n will be started.\n
\n - \n If all the processes within stage finished, the next stage will be started. If it's the last stage, the\n Journey Instance will complete.\n
\n
Required permissions:
Following permissions are required: JourneyEdit",
"operationId": "CompleteTask",
"parameters": [
{
"name": "taskId",
"in": "query",
"description": "Task id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey instance task completed"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance/task with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/{taskId}/reviewOutcome": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Save review outcome",
"description": "\nCompletes review outcome task.
Required permissions:
Following permissions are required: JourneyEdit",
"operationId": "SaveReviewOutcome",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "Task 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Save review outcome task request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ReviewOutcomeDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Review outcome task completed"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance/task with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/{taskId}/reassign": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Reassign task",
"description": "\nReassigns task to new team.
Required permissions:
At least one of the following permissions is required: JourneyReassignTask, JourneyReassignTaskOwnerOnly, JourneyReassignOwnerNoTaskAccess, JourneyUnassignOwner",
"operationId": "ReassignTask",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "Task 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Reassign task properties",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignTaskDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Task team reassigned"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance/task with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/bulk-reassign": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Bulk reassign task",
"description": "\nReassigns tasks to new teams.
Required permissions:
At least one of the following permissions is required: JourneyReassignTask, JourneyReassignTaskOwnerOnly, JourneyReassignOwnerNoTaskAccess, JourneyUnassignOwner",
"operationId": "ReassignTaskBulk",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "List of reassign task properties",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignMultipleTasksDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Accepted. At least one task reassigned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskReassignOutcomeDtoListServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/{taskId}/reset": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Reset task",
"description": "\nReset journey task. Warning: If the Task being reset belongs to parallel process (or stage), any changes\n made, may impact already closed tasks in this process (or stage)
Required permissions:
Following permissions are required: JourneyReopenTask",
"operationId": "ResetTask",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "Task 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Reset task properties",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ResetTaskDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Task reopened",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReopenTaskCommandResponseServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance/task with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/{taskId}/pause": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Pause journey instance task",
"description": "\nPause a currently in progress journey instance task.
Required permissions:
Following permissions are required: JourneyPauseTask",
"operationId": "PauseTask",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "Task id to pause",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Pause task details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PauseJourneyInstanceTaskDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instance task paused"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/{taskId}/unpause": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Unpause journey instance task",
"description": "\nUnpause a currently paused journey instance task.
Required permissions:
Following permissions are required: JourneyPauseTask",
"operationId": "UnpauseTask",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "Task id to unpause",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey instance task unpaused"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/stage/{stageId}/pause": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Pause journey instance stage",
"description": "\nPause a currently in-progress journey instance stage and its tasks with SLA configuration
Required permissions:
Following permissions are required: JourneyPauseStage",
"operationId": "PauseStage",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stageId",
"in": "path",
"description": "Stage id to pause",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Pause stage details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PauseJourneyInstanceStageDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instance stage paused"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/stage/{stageId}/unpause": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Unpause journey instance stage",
"description": "\nUnpause a currently paused journey instance stage and its tasks
Required permissions:
Following permissions are required: JourneyPauseStage",
"operationId": "UnpauseStage",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stageId",
"in": "path",
"description": "Stage id to unpause",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey instance stage unpaused"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/pause": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Pause journey instance",
"description": "\nPause a currently in-progress journey instance and all stages and tasks with SLA configuration
Required permissions:
Following permissions are required: JourneyPauseInstance",
"operationId": "PauseInstance",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Pause instance details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PauseJourneyInstanceDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instance stage paused"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/unpause": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Unpause journey instance",
"description": "\nUnpause a currently paused journey instance and all stages and tasks with SLA configuration
Required permissions:
Following permissions are required: JourneyPauseInstance",
"operationId": "UnpauseInstance",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey instance unpaused"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{id}/access-layers": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Update journey instance access layers",
"description": "\nUpdates access layers of the journey instance.
Required permissions:
Following permissions are required: JourneyChangeAccessLayers",
"operationId": "UpdateJourneyAccessLayers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Journey instance 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Update journey instance access layers request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyInstanceAccessLayersDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey instance access layers updated"
},
"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. Journey instance with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/task/{taskId}/reassign-read-only-teams": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Reassign task read only teams",
"description": "\nReassign task read only teams.
Required permissions:
Following permissions are required: JourneyReassignReadOnlyTask",
"operationId": "ReassignTaskReadOnlyTeams",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "Task 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Reassign details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignReadOnlyTeamsDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Task read only teams reassigned"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance/task with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/reassign-journey-owner": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Reassign journey owner",
"description": "\nReassign journey owner.
Required permissions:
At least one of the following permissions is required: JourneyOwnerEdit, JourneyOwnerEditOwnerOnly, JourneyUnassignOwner",
"operationId": "ReassignJourneyOwner",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Reassign details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignJourneyOwnerDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey owner reassigned"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/{journeyInstanceId}/custom-status": {
"put": {
"tags": [
"JourneyInstance"
],
"summary": "Update journey instance custom status",
"description": "\nEdit journey instance custom status.
Required permissions:
Following permissions are required: JourneyCustomStatusEdit",
"operationId": "CustomStatusUpdate",
"parameters": [
{
"name": "journeyInstanceId",
"in": "path",
"description": "Journey instance 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Custom status details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CustomStatusUpdateDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Custom Status changed"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey instance given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-instance/launch-journey": {
"post": {
"tags": [
"JourneyInstance"
],
"summary": "Launch journey business process",
"description": "\nInitialize a launch journey business process.
Required permissions:
Following permissions are required: JourneyCreate",
"operationId": "LaunchJourney",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Launch journey request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchJourneyDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Launch journey business process initialized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyLaunchedDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-launch-controls": {
"post": {
"tags": [
"JourneyLaunchControls"
],
"summary": "Create Journey Launch Controls",
"description": "\n - Creates a new journey launch controls definition.
\n
Required permissions:
Following permissions are required: JourneyLaunchControlsEdit",
"operationId": "CreateJourneyLaunchControls",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneyLaunchControlsDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Launch Controls created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateJourneyLaunchControlsResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
},
"put": {
"tags": [
"JourneyLaunchControls"
],
"summary": "Update Journey Launch Controls",
"description": "\n - Updates a new journey launch controls definition.
\n
Required permissions:
Following permissions are required: JourneyLaunchControlsEdit",
"operationId": "UpdateJourneyLaunchControls",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyLaunchControlsDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Launch Controls updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateJourneyLaunchControlsResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values"
},
"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/journey-launch-controls/{journeyLaunchControlsId}": {
"delete": {
"tags": [
"JourneyLaunchControls"
],
"summary": "Delete Journey Launch Controls",
"description": "\n - Deletes the selected version of an existing Journey Launch Controls.
\n
Required permissions:
Following permissions are required: JourneyLaunchControlsDelete",
"operationId": "DeleteJourneyLaunchControls",
"parameters": [
{
"name": "journeyLaunchControlsId",
"in": "path",
"description": "Journey Launch Controls 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey Launch Controls deleted"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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. Journey Launch Controls 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/journey-schedule": {
"post": {
"tags": [
"JourneySchedule"
],
"summary": "Create journey Schedule",
"description": "\n - Creates a new journey Schedule with a first draft version.
\n - \n The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.\n
\n
Required permissions:
Following permissions are required: JourneySchedulerEdit",
"operationId": "CreateJourneySchedule",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyScheduleDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schedule/{journeyScheduleId}": {
"post": {
"tags": [
"JourneySchedule"
],
"summary": "Create journey Schedule version",
"description": "\n - Creates a new version of an existing journey Schedule.
\n - Assigns the next available version number.
\n - \n The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.\n
\n
Required permissions:
Following permissions are required: JourneySchedulerEdit",
"operationId": "CreateJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Create journey Schedule version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyScheduleDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"JourneySchedule"
],
"summary": "Delete journey Schedule and all its versions",
"description": "\nDeletes an existing journey Schedule and all its versions.
Required permissions:
Following permissions are required: JourneySchedulerDelete",
"operationId": "DeleteJourneySchedule",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey schedule deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schedule/{journeyScheduleId}/version/{versionNumber}": {
"put": {
"tags": [
"JourneySchedule"
],
"summary": "Update journey Schedule version",
"description": "\nUpdates an existing journey Schedule version. Only draft and rejected versions are allowed to be updated.
Required permissions:
Following permissions are required: JourneySchedulerEdit",
"operationId": "UpdateJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Update journey Schedule version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyScheduleVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule version updated"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule 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"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"JourneySchedule"
],
"summary": "Delete journey Schedule version",
"description": "\n - Deletes the selected version of an existing journey Schedule.
\n - \n If the version is the last one, then the version number of it will become the next available one for the\n model.\n Otherwise, the version number will be flagged as deleted and become unavailable.\n
\n
Required permissions:
Following permissions are required: JourneySchedulerDelete",
"operationId": "DeleteJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey Schedule version deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schedule/{journeyScheduleId}/version/{versionNumber}/clone": {
"post": {
"tags": [
"JourneySchedule"
],
"summary": "Clone journey Schedule version",
"description": "\n - Clones the selected version of an existing journey Schedule and creates a new model with a single version.
\n - \n The new version contains all the data of the original selected one,\n will have the default status of draft and the author as the only required signee.\n
\n - Returns the id of the cloned data group version.
\n
Required permissions:
Following permissions are required: JourneySchedulerEdit",
"operationId": "CloneJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to clone",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Clone journey Schedule version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneJourneyScheduleVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule version cloned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloneJourneyScheduleVersionResponseServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schedule/{journeyScheduleId}/version/{versionNumber}/submit-for-approval": {
"put": {
"tags": [
"JourneySchedule"
],
"summary": "Submit journey Schedule version for approval",
"description": "\nSubmits the selected version of an existing journey Schedule for approval.
Required permissions:
Following permissions are required: JourneySchedulerApprove",
"operationId": "SubmitJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey Schedule version submitted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schedule/{journeyScheduleId}/version/{versionNumber}/sign": {
"put": {
"tags": [
"JourneySchedule"
],
"summary": "Sign journey Schedule version",
"description": "\nSigns the selected version of an existing journey Schedule and changes the version status accordingly to the\n action (Approve/Reject).
Required permissions:
Following permissions are required: JourneySchedulerApprove",
"operationId": "SignJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Sign journey Schedule version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule version signed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyScheduleVersionSignResponseServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schedule/{journeyScheduleId}/version/{versionNumber}/archive": {
"put": {
"tags": [
"JourneySchedule"
],
"summary": "Archive journey Schedule version",
"description": "\nArchives the selected version of an existing journey Schedule.
Required permissions:
Following permissions are required: JourneySchedulerArchive",
"operationId": "ArchiveJourneyScheduleVersion",
"parameters": [
{
"name": "journeyScheduleId",
"in": "path",
"description": "Journey Schedule 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey Schedule version archived"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule 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/journey-schedule-date": {
"post": {
"tags": [
"JourneyScheduleDate"
],
"summary": "Create journey Schedule Date",
"description": "\n - Creates a new Journey Schedule Date.
\n
Required permissions:
Following permissions are required: JourneySchedulerEdit",
"operationId": "CreateJourneyScheduleDate",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDateDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule Date created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyScheduleDateDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
},
"put": {
"tags": [
"JourneyScheduleDate"
],
"summary": "Update journey Schedule Date",
"description": "\n - Updates and existing Journey Schedule Date Record.
\n
Required permissions:
Following permissions are required: JourneySchedulerEdit",
"operationId": "UpdateJourneyScheduleDate",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDateDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey Schedule Date Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyScheduleDateDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule date 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/journey-schedule-date/{journeyScheduleDateId}": {
"delete": {
"tags": [
"JourneyScheduleDate"
],
"summary": "Delete journey Schedule date record",
"description": "\n - Deletes a Journey Schedule Date Record.
\n
Required permissions:
Following permissions are required: JourneySchedulerDelete",
"operationId": "DeleteJourneyScheduleDate",
"parameters": [
{
"name": "journeyScheduleDateId",
"in": "path",
"description": "Journey Schedule Date 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey Schedule Date deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey Schedule date with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema": {
"post": {
"tags": [
"JourneySchema"
],
"summary": "Create journey schema",
"description": "\n - Creates a new journey schema with a first draft version.
\n - \n The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.\n
\n
Required permissions:
Following permissions are required: JourneyBuilderEdit",
"operationId": "CreateJourneySchema",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySchemaDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey schema created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneySchemaDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}": {
"post": {
"tags": [
"JourneySchema"
],
"summary": "Create journey schema version",
"description": "\n - Creates a new version of an existing journey schema.
\n - Assigns the next available version number.
\n - \n The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.\n
\n
Required permissions:
Following permissions are required: JourneyBuilderEdit",
"operationId": "CreateJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Create journey schema version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySchemaDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey schema version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneySchemaDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"JourneySchema"
],
"summary": "Delete journey schema and all its versions",
"description": "\nDeletes an existing journey schema and all its versions.
Required permissions:
Following permissions are required: JourneyBuilderDelete",
"operationId": "DeleteJourneySchema",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey schema deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}/version/{versionNumber}/draft": {
"post": {
"tags": [
"JourneySchema"
],
"summary": "Create journey schema version from provided version number",
"description": "\n - Creates a new version of an existing journey schema version.
\n
Required permissions:
Following permissions are required: JourneyBuilderEdit",
"operationId": "CreateJourneySchemaDraftFromVersionNumber",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number from which new draft will be created",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey schema version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateJourneySchemaDraftFromVersionResponseServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id and version number does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}/version/{versionNumber}": {
"put": {
"tags": [
"JourneySchema"
],
"summary": "Update journey schema version",
"description": "\nUpdates an existing journey schema version. Only draft and rejected versions are allowed to be updated.
Required permissions:
Following permissions are required: JourneyBuilderEdit",
"operationId": "UpdateJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Update journey schema version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneySchemaVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey schema version updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneySchemaUpdatedDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema 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"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"JourneySchema"
],
"summary": "Delete journey schema version",
"description": "\n - Deletes the selected version of an existing journey schema.
\n - \n If the version is the last one, then the version number of it will become the next available one for the\n model.\n Otherwise, the version number will be flagged as deleted and become unavailable.\n
\n
Required permissions:
Following permissions are required: JourneyBuilderDelete",
"operationId": "DeleteJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey schema version deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}/version/{versionNumber}/clone": {
"post": {
"tags": [
"JourneySchema"
],
"summary": "Clone journey schema version",
"description": "\n - Clones the selected version of an existing journey schema and creates a new model with a single version.
\n - \n The new version contains all the data of the original selected one,\n will have the default status of draft and the author as the only required signee.\n
\n - Returns the id of the cloned data group version.
\n
Required permissions:
Following permissions are required: JourneyBuilderEdit",
"operationId": "CloneJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to clone",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Clone journey schema version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneJourneySchemaVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey schema version cloned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloneJourneySchemaVersionResponseServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}/version/{versionNumber}/submit-for-approval": {
"put": {
"tags": [
"JourneySchema"
],
"summary": "Submit journey schema version for approval",
"description": "\nSubmits the selected version of an existing journey schema for approval.
Required permissions:
Following permissions are required: JourneyBuilderEdit",
"operationId": "SubmitJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey schema version submitted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}/version/{versionNumber}/sign": {
"put": {
"tags": [
"JourneySchema"
],
"summary": "Sign journey schema version",
"description": "\nSigns the selected version of an existing journey schema and changes the version status accordingly to the\n action (Approve/Reject).
Required permissions:
Following permissions are required: JourneyBuilderApprove",
"operationId": "SignJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Sign journey schema version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Journey schema version signed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneySchemaVersionSignResponseServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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/journey-schema/{journeySchemaId}/version/{versionNumber}/archive": {
"put": {
"tags": [
"JourneySchema"
],
"summary": "Archive journey schema version",
"description": "\nArchives the selected version of an existing journey schema.
Required permissions:
Following permissions are required: JourneyBuilderArchive",
"operationId": "ArchiveJourneySchemaVersion",
"parameters": [
{
"name": "journeySchemaId",
"in": "path",
"description": "Journey schema 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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"responses": {
"202": {
"description": "Success. Journey schema version archived"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Journey schema 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/sla-configuration": {
"put": {
"tags": [
"JourneySlaConfiguration"
],
"summary": "Update journey SLA configuration",
"description": "\nUpdates the SLA configuration
Required permissions:
Following permissions are required: WorkingDaysEdit",
"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"
},
{
"name": "X-CORRELATION-ID",
"in": "header",
"description": "The UiD of the correlation id",
"schema": {
"type": "string"
},
"example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d"
}
],
"requestBody": {
"description": "Update SLA configuration request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneySlaConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. SLA Configuration updated"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/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"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AbortJourneyDto": {
"type": "object",
"properties": {
"cancellationReason": {
"maxLength": 256,
"type": "string",
"description": "Reason for journey cancelation",
"nullable": true,
"example": "Reason"
},
"comments": {
"maxLength": 1024,
"type": "string",
"description": "Comments to journey cancelation",
"nullable": true,
"example": "Comment"
}
},
"additionalProperties": false,
"description": "DTO to abort journey"
},
"AbortJourneyDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AbortJourneyDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"AbortMultipleJourneysDto": {
"required": [
"journeysIds"
],
"type": "object",
"properties": {
"journeysIds": {
"maxItems": 20,
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of journeys to abort"
},
"reason": {
"type": "string",
"description": "Reason for journeys cancelation",
"nullable": true,
"example": "Reason"
},
"comments": {
"type": "string",
"description": "Comments to journeys cancelation",
"nullable": true,
"example": "Comment"
}
},
"additionalProperties": false,
"description": "DTO representing aborting journeys in bulk"
},
"AbortMultipleJourneysDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AbortMultipleJourneysDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"AccessLayerDto": {
"type": "object",
"properties": {
"geographic": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of geographic access layers",
"nullable": true
},
"businessRelated": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of business related access layers",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing access layers attached"
},
"ApproveAction": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"created": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"ApproveActionServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Approver": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"ChannelTypeDto": {
"enum": [
"Internal",
"External",
"InternalAndExternal"
],
"type": "string"
},
"CloneJourneyScheduleVersionDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of new journey Schedule",
"nullable": true,
"example": "Client Onboarding"
},
"type": {
"type": "string",
"description": "The type of new journey Schedule",
"nullable": true,
"example": "Client Onboarding"
}
},
"additionalProperties": false,
"description": "Request DTO representing clone journey Schedule data"
},
"CloneJourneyScheduleVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneJourneyScheduleVersionDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CloneJourneyScheduleVersionResponse": {
"type": "object",
"properties": {
"journeyScheduleId": {
"type": "string",
"description": "Id of the cloned journey schedule",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
}
},
"additionalProperties": false,
"description": "Cloned journey schedule response data"
},
"CloneJourneyScheduleVersionResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneJourneyScheduleVersionResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"CloneJourneySchemaVersionDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of new journey schema",
"nullable": true,
"example": "Client Onboarding"
},
"identifier": {
"type": "string",
"description": "Identifier of new journey schema",
"nullable": true,
"example": "COB_COMP_1"
},
"type": {
"type": "string",
"description": "The type of new journey schema",
"nullable": true,
"example": "Client Onboarding"
},
"channelType": {
"allOf": [
{
"$ref": "#/components/schemas/ChannelTypeDto"
}
],
"description": "Channel type of new journey schema"
}
},
"additionalProperties": false,
"description": "Request DTO representing clone journey schema data"
},
"CloneJourneySchemaVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneJourneySchemaVersionDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CloneJourneySchemaVersionResponse": {
"type": "object",
"properties": {
"journeySchemaId": {
"type": "string",
"description": "Id of the cloned journey schema",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
}
},
"additionalProperties": false,
"description": "Cloned journey schema response data"
},
"CloneJourneySchemaVersionResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneJourneySchemaVersionResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ConditionDefinitionDto": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field to evaluate",
"nullable": true,
"example": "EntityType"
},
"value": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of values",
"nullable": true
},
"valueId": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of value ids",
"nullable": true
},
"valueType": {
"type": "string",
"description": "Type of the value",
"nullable": true,
"example": "text"
},
"dataSource": {
"type": "string",
"description": "Data source from which field is retrieved. If empty then Entity Data properties will be used.",
"nullable": true,
"example": "entityDataMetadata"
},
"operation": {
"type": "string",
"description": "Logical operation to be performed to match the values",
"nullable": true,
"example": "equal"
},
"logicalOperation": {
"type": "string",
"description": "Logical operation to be performed on the operands collection",
"nullable": true,
"example": "AND"
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto",
"nullable": true
},
"valueField": {
"allOf": [
{
"$ref": "#/components/schemas/ValueField"
}
],
"description": "Field value used for conditional limit validation",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents condition"
},
"ConditionDto": {
"required": [
"logicalOperation",
"name",
"operands"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the condition",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"minLength": 1,
"type": "string",
"description": "The name of the condition",
"example": "Company-type only"
},
"description": {
"type": "string",
"description": "The description of the condition",
"nullable": true,
"example": "Applicable only when EntityType=Company"
},
"logicalOperation": {
"minLength": 1,
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection",
"example": "AND"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto"
}
},
"additionalProperties": false,
"description": "Represents condition root",
"example": {
"id": "118313c6-91e6-4b05-a537-5a1ab906418f",
"name": "Company-type only",
"description": "Applicable only when EntityType=Company",
"logicalOperation": "AND",
"operands": [
{
"fieldName": "EntityType",
"value": [
"string"
],
"valueType": "text",
"operation": "equal",
"operands": [ ]
}
]
}
},
"ConditionalValueDto": {
"required": [
"logicalOperation",
"operands"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the condition",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "The name of the condition",
"nullable": true,
"example": "Company-type only"
},
"description": {
"type": "string",
"description": "The description of the condition",
"nullable": true,
"example": "Applicable only when EntityType=Company"
},
"logicalOperation": {
"minLength": 1,
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection",
"example": "AND"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto"
},
"value": {
"type": "string",
"description": "Value that should be returned when conditions are met",
"nullable": true,
"example": "Relationship Manager"
},
"priority": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
},
"valueId": {
"type": "string",
"description": "Value Id that should be returned when conditions are met",
"nullable": true,
"example": "RM"
}
},
"additionalProperties": false
},
"CreateJourneyInstanceDto": {
"required": [
"journeySchemaId"
],
"type": "object",
"properties": {
"entityId": {
"type": "string",
"description": "Entity id from FenX entity data service",
"format": "uuid",
"example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6"
},
"journeySchemaId": {
"minLength": 1,
"type": "string",
"description": "Id of existing and published journey schema",
"format": "uuid",
"example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6"
},
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Journey access layers",
"nullable": true
},
"jurisdictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyJurisdictionDto"
},
"description": "Jurisdictions this journey instance operates on. Only Client Offboarding journey type supports per jurisdiction journey instances.",
"nullable": true
},
"journeySchemaVersionNumber": {
"type": "integer",
"description": "(Optional) Version number of journey schema to use; if null latest published version is used",
"format": "int32",
"nullable": true,
"example": 1
}
},
"additionalProperties": false,
"description": "Request DTO representing journey instance to create"
},
"CreateJourneyInstanceDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneyInstanceDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateJourneyLaunchControlsDto": {
"required": [
"conditions",
"journeyType"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the journey launch controls",
"format": "uuid"
},
"journeyType": {
"type": "string",
"description": "Journey Type for the journey launch controls"
},
"description": {
"type": "string",
"description": "The journey description for journey launch controls",
"nullable": true
},
"conditions": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Logic engine conditions for journey launch controls"
}
},
"additionalProperties": false,
"description": "Request DTO representing journey launch controls data"
},
"CreateJourneyLaunchControlsDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneyLaunchControlsDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateJourneyLaunchControlsResponseDto": {
"type": "object",
"properties": {
"createJourneyLaunchControls": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneyLaunchControlsDto"
}
],
"description": "Created Journey Launch Controls",
"nullable": true
}
},
"additionalProperties": false
},
"CreateJourneyLaunchControlsResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneyLaunchControlsResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"CreateJourneySchemaDraftFromVersionResponse": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"format": "int32"
},
"versionId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"CreateJourneySchemaDraftFromVersionResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJourneySchemaDraftFromVersionResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"CustomStatusUpdateDto": {
"type": "object",
"properties": {
"customStatus": {
"maxLength": 255,
"type": "string",
"description": "Journey Instance custom status",
"nullable": true,
"example": "JourneyOnboarding"
}
},
"additionalProperties": false,
"description": "Request DTO representing journey custom status update data"
},
"CustomStatusUpdateDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CustomStatusUpdateDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"EntityResolutionSearchQueryFieldDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ExternalDataConfigurationDto": {
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalDataProviderConfigurationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ExternalDataConfigurationsDto": {
"type": "object",
"properties": {
"default": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalDataConfigurationDto"
}
],
"nullable": true
},
"configurations": {
"type": "object",
"properties": {
"Company": {
"$ref": "#/components/schemas/ExternalDataConfigurationDto"
},
"Individual": {
"$ref": "#/components/schemas/ExternalDataConfigurationDto"
},
"Other": {
"$ref": "#/components/schemas/ExternalDataConfigurationDto"
},
"DataGroup": {
"$ref": "#/components/schemas/ExternalDataConfigurationDto"
}
},
"additionalProperties": false,
"nullable": true
}
},
"additionalProperties": false
},
"ExternalDataProviderConfigurationDto": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"nullable": true
},
"mandatory": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"JourneyInstanceCreatedDto": {
"type": "object",
"properties": {
"journeyInstanceId": {
"type": "string",
"description": "Id of the created journey instance",
"format": "uuid",
"example": "7a15bd4a-20f7-497f-b16a-a75d52c8fe01"
},
"journeySchemaId": {
"type": "string",
"description": "Id of journey schema of the created journey instance",
"format": "uuid",
"example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6"
},
"journeySchemaVersionNumber": {
"type": "integer",
"description": "Version number of the journey schema of created journey instance",
"format": "int32",
"nullable": true,
"example": 1
},
"entityId": {
"type": "string",
"description": "Entity id from FenX entity data service",
"format": "uuid",
"example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6"
}
},
"additionalProperties": false,
"description": "Response DTO representing created journey instance"
},
"JourneyInstanceCreatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyInstanceCreatedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneyJurisdictionDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the jurisdiction",
"nullable": true,
"example": "Irleand"
}
},
"additionalProperties": false,
"description": "Request DTO representing jurisdiction journey should operate on"
},
"JourneyLaunchedDto": {
"type": "object",
"properties": {
"businessProcessId": {
"type": "string",
"description": "The UiD of the launched journey business process",
"format": "uuid",
"example": "24511767-4586-4b69-af43-c405ec6b154a"
}
},
"additionalProperties": false,
"description": "DTO representing launched journey business process"
},
"JourneyLaunchedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyLaunchedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneyMilestoneDto": {
"required": [
"id",
"name",
"stages"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "The UiD of the Journey Milestone",
"format": "uuid",
"example": "24511767-4586-4b69-af43-c405ec6b154a"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Journey Milestone name",
"example": "New Request"
},
"description": {
"maxLength": 255,
"type": "string",
"description": "Journey Milestone description",
"nullable": true,
"example": "New Request Milestone"
},
"order": {
"minimum": 0,
"type": "integer",
"description": "Journey Milestone order",
"format": "int32",
"example": 1
},
"stages": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of Journey Milestone's stages"
}
},
"additionalProperties": false,
"description": "DTO representing Journey Milestone"
},
"JourneyScheduleDateDto": {
"required": [
"comment",
"entityId",
"journeyScheduleId",
"type",
"userCreated"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the Journey Schedule Date",
"format": "uuid",
"example": "daf0f511-9e0f-434e-9093-326e7710d9cc"
},
"entityId": {
"minLength": 1,
"type": "string",
"description": "The UiD of the Entity the Journey is scheduled for",
"format": "uuid",
"example": "c7d47bf5-5226-4152-a09d-188af9a9bd14"
},
"journeyScheduleId": {
"minLength": 1,
"type": "string",
"description": "The UiD of the Journey Schedule this date is being set for",
"format": "uuid",
"example": "b5c3dd6a-49a8-4454-af89-7a7f27aaee4a"
},
"scheduledDate": {
"type": "string",
"description": "The date the journey will be launched for",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"userCreated": {
"type": "boolean",
"description": "To track if schedule record was manually created by a user",
"example": true
},
"comment": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The reason for which the journey is scheduled",
"example": "Created by system scheduled job."
},
"type": {
"minLength": 1,
"type": "string",
"description": "The type of Journey that will be launched",
"example": "Client Onboarding"
}
},
"additionalProperties": false,
"description": "Response DTO representing Journey Schedule date data"
},
"JourneyScheduleDateDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDateDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"JourneyScheduleDateDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDateDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneyScheduleDto": {
"required": [
"conditions",
"name",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of journey Schedule",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Journey Schedule name",
"example": "Client Onboarding"
},
"notes": {
"maxLength": 2000,
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Journey Type",
"example": "Client Onboarding"
},
"versionNumber": {
"type": "integer",
"description": "The version number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"created": {
"type": "string",
"description": "The creation date of the version (Read-only)",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
},
"conditions": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the Schedule can be used"
}
},
"additionalProperties": false,
"description": "DTO representing journey Schedule data"
},
"JourneyScheduleDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"JourneyScheduleDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneyScheduleVersionSignResponse": {
"type": "object",
"properties": {
"journeyScheduleId": {
"type": "string",
"description": "The UiD of the journey Schedule",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"versionNumber": {
"type": "integer",
"description": "The number of the version that has been signed",
"format": "int32",
"example": 2
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The new version status",
"example": "Rejected"
}
},
"additionalProperties": false,
"description": "Sign journey Schedule response contains the new version status"
},
"JourneyScheduleVersionSignResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneyScheduleVersionSignResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneySchemaDto": {
"type": "object",
"properties": {
"journeySchemaId": {
"type": "string",
"description": "The UiD of journey schema",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
},
"name": {
"type": "string",
"description": "Journey schema name",
"nullable": true,
"example": "Client Onboarding"
},
"identifier": {
"type": "string",
"description": "Journey schema identifier",
"nullable": true,
"example": "COB_COMP_1"
},
"type": {
"type": "string",
"description": "Journey schema type",
"nullable": true,
"example": "Client Onboarding"
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageDto"
},
"description": "Journey schema stage collection",
"nullable": true
},
"versionNumber": {
"type": "integer",
"description": "The version number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"created": {
"type": "string",
"description": "The creation date of the version (Read-only)",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the schema can be used",
"nullable": true
},
"externalConditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "External Conditions under which the schema can be used",
"nullable": true
},
"milestones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyMilestoneDto"
},
"description": "List of Journey Schema Milestones",
"nullable": true
},
"channelType": {
"allOf": [
{
"$ref": "#/components/schemas/ChannelTypeDto"
}
],
"description": "Channel type describing whether journeys will be initiated by internal teams (Internal) or external customers through Portal (External)"
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"serviceLevelAgreement": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceLevelAgreementDto"
}
],
"description": "Journey Schema Service Level Agreement",
"nullable": true
},
"areReopenCommentsOptional": {
"type": "boolean",
"description": "If true then comments are non-mandatory. If false then comments are mandatory.",
"example": true
}
},
"additionalProperties": false,
"description": "DTO representing journey schema data"
},
"JourneySchemaDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySchemaDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"JourneySchemaDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySchemaDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneySchemaUpdatedDto": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Journey schema aggregate version after update",
"format": "int32",
"example": 4
}
},
"additionalProperties": false,
"description": "Response DTO representing updated journey schema"
},
"JourneySchemaUpdatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySchemaUpdatedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneySchemaVersionSignResponse": {
"type": "object",
"properties": {
"journeySchemaId": {
"type": "string",
"description": "The UiD of the journey schema",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"versionNumber": {
"type": "integer",
"description": "The number of the version that has been signed",
"format": "int32",
"example": 2
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The new version status",
"example": "Rejected"
}
},
"additionalProperties": false,
"description": "Sign journey schema response contains the new version status"
},
"JourneySchemaVersionSignResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySchemaVersionSignResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"LaunchJourneyDto": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"description": "The UiD of the Entity from FenX entity data service",
"format": "uuid",
"example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6"
},
"journeyType": {
"type": "string",
"description": "Journey type to launch",
"nullable": true
},
"jurisdictions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Jurisdictions this journey instance operates on. Only Client OffBoarding and ReOnboarding journey type supports per jurisdiction journey instances.",
"nullable": true
},
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Journey access layers",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing launch journey instance(s)"
},
"LaunchJourneyDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchJourneyDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"PauseJourneyInstanceDto": {
"required": [
"reason"
],
"type": "object",
"properties": {
"reason": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Reason for instance pause",
"example": "Reason"
},
"comment": {
"maxLength": 1024,
"type": "string",
"description": "Comments to instance pause",
"nullable": true,
"example": "Comment"
}
},
"additionalProperties": false
},
"PauseJourneyInstanceDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/PauseJourneyInstanceDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"PauseJourneyInstanceStageDto": {
"required": [
"reason"
],
"type": "object",
"properties": {
"reason": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Reason for stage pause",
"example": "Reason"
},
"comment": {
"maxLength": 1024,
"type": "string",
"description": "Comments to stage pause",
"nullable": true,
"example": "Comment"
}
},
"additionalProperties": false
},
"PauseJourneyInstanceStageDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/PauseJourneyInstanceStageDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"PauseJourneyInstanceTaskDto": {
"required": [
"reason"
],
"type": "object",
"properties": {
"reason": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Reason for task pause",
"example": "Reason"
},
"comment": {
"maxLength": 1024,
"type": "string",
"description": "Comments to task pause",
"nullable": true,
"example": "Comment"
}
},
"additionalProperties": false
},
"PauseJourneyInstanceTaskDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/PauseJourneyInstanceTaskDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"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": { }
},
"ProcessDto": {
"required": [
"id",
"name",
"tasks"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "The UiD of the process",
"format": "uuid",
"example": "3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Process name",
"example": "New Request"
},
"description": {
"maxLength": 255,
"type": "string",
"description": "Process description",
"nullable": true,
"example": "New Request Process"
},
"order": {
"minimum": 0,
"type": "integer",
"description": "Process order",
"format": "int32",
"example": 1
},
"tasksCompletionOrder": {
"enum": [
"Sequential",
"AnyOrder"
],
"type": "string",
"description": "Determines the order of completing tasks. Defaults to Sequential.\nOne of Sequential, AnyOrder",
"nullable": true,
"example": "Sequential"
},
"tasks": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskDto"
},
"description": "List of process tasks"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "List of conditions required to trigger process",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing journey process"
},
"ReassignJourneyOwnerDto": {
"type": "object",
"properties": {
"teamId": {
"type": "string",
"description": "The UiD of the team",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"ownerId": {
"type": "string",
"description": "The UiD of the journey owner - user of the system who belongs to the reassigned team",
"format": "uuid",
"nullable": true,
"example": "56ea1e7d-6896-4138-be9a-e2e0a636e2bf"
},
"comment": {
"type": "string",
"description": "Optional comment for journey owner reassign action",
"nullable": true,
"example": "Example comment"
}
},
"additionalProperties": false,
"description": "DTO representing reassign journey owner"
},
"ReassignJourneyOwnerDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignJourneyOwnerDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ReassignMultipleTasksDto": {
"required": [
"tasks"
],
"type": "object",
"properties": {
"tasks": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ReassignTaskInBulkDto"
},
"description": "List of tasks to reassign"
}
},
"additionalProperties": false,
"description": "DTO representing reassign tasks in bulk"
},
"ReassignMultipleTasksDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignMultipleTasksDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ReassignReadOnlyTeamsDto": {
"type": "object",
"properties": {
"readOnlyTeams": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of task read only teams UiDs",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing reassign read only teams"
},
"ReassignReadOnlyTeamsDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignReadOnlyTeamsDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ReassignTaskDto": {
"required": [
"teamId"
],
"type": "object",
"properties": {
"teamId": {
"minLength": 1,
"type": "string",
"description": "The UiD of the team",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"ownerId": {
"type": "string",
"description": "The UiD of the task owner - user of the system who belongs to the reassigned team",
"format": "uuid",
"nullable": true,
"example": "56ea1e7d-6896-4138-be9a-e2e0a636e2bf"
},
"comment": {
"type": "string",
"description": "Optional comment for task reassign action",
"nullable": true,
"example": "Example comment"
},
"disableConditionalTeamAssignment": {
"type": "boolean",
"description": "Flag to determine if team should be automatically assigned to tak when team assignment conditions are met",
"example": false
}
},
"additionalProperties": false,
"description": "DTO representing reassign task"
},
"ReassignTaskDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ReassignTaskDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ReassignTaskInBulkDto": {
"required": [
"journeyInstanceId",
"taskId"
],
"type": "object",
"properties": {
"taskId": {
"minLength": 1,
"type": "string",
"description": "The UiD of the task",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"journeyInstanceId": {
"minLength": 1,
"type": "string",
"description": "The UiD of the journey",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"teamId": {
"type": "string",
"description": "The UiD of the team",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"ownerId": {
"type": "string",
"description": "The UiD of the task owner - user of the system who belongs to the reassigned team",
"format": "uuid",
"nullable": true,
"example": "56ea1e7d-6896-4138-be9a-e2e0a636e2bf"
},
"comment": {
"type": "string",
"description": "Optional comment for task reassign action",
"nullable": true,
"example": "Example comment"
},
"disableConditionalTeamAssignment": {
"type": "boolean",
"description": "Flag to determine if team should be automatically assigned to tak when team assignment conditions are met",
"example": false
}
},
"additionalProperties": false,
"description": "DTO representing an request of a task reassignment process"
},
"ReopenTaskCommandResponse": {
"type": "object",
"properties": {
"reopenedTasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReopenedTaskDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReopenTaskCommandResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ReopenTaskCommandResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ReopenedTaskDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"taskType": {
"type": "string",
"nullable": true
},
"serviceName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ResetTaskDto": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Comment for task reopen action",
"nullable": true,
"example": "Example comment"
},
"reopenReason": {
"type": "string",
"description": "Reason for task reopen action, selected from the lookup list",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing reset task"
},
"ResetTaskDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ResetTaskDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ReviewOutcomeDto": {
"required": [
"outcome"
],
"type": "object",
"properties": {
"outcome": {
"minLength": 1,
"type": "string",
"description": "Outcome of the review - must be present on schema branches key parameter",
"example": "Approve"
},
"message": {
"type": "string",
"description": "Review comment",
"nullable": true,
"example": "Review comment message."
}
},
"additionalProperties": false,
"description": "Request DTO representing review outcome task data to save"
},
"ReviewOutcomeDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ReviewOutcomeDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ServiceLevelAgreementDto": {
"type": "object",
"properties": {
"committedHours": {
"type": "integer",
"description": "Committed Hours - sets the amount of time a user has to complete a Journey/Stage/Task",
"format": "int32",
"nullable": true,
"example": 7
},
"approachingDueHours": {
"type": "integer",
"description": "Approaching Due Hours - sets the amount of time when the SLA status change to ‘Approaching Due’",
"format": "int32",
"nullable": true,
"example": 8
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceLevelAgreementLightDtoConditionalValueDto"
},
"description": "List of conditions required to dynamically assign SLA to Journey/Stage/Task",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing Service Level Agreement of a Journey/Stage/Task"
},
"ServiceLevelAgreementLightDto": {
"type": "object",
"properties": {
"committedHours": {
"type": "integer",
"description": "Committed Hours - sets the amount of time a user has to complete a Journey/Stage/Task",
"format": "int32",
"example": 7
},
"approachingDueHours": {
"type": "integer",
"description": "Approaching Due Hours - sets the amount of time when the SLA status change to ‘Approaching Due’",
"format": "int32",
"example": 8
}
},
"additionalProperties": false,
"description": "Request DTO representing Service Level Agreement of a Journey/Stage/Task"
},
"ServiceLevelAgreementLightDtoConditionalValueDto": {
"required": [
"logicalOperation",
"operands"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the condition",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "The name of the condition",
"nullable": true,
"example": "Company-type only"
},
"description": {
"type": "string",
"description": "The description of the condition",
"nullable": true,
"example": "Applicable only when EntityType=Company"
},
"logicalOperation": {
"minLength": 1,
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection",
"example": "AND"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceLevelAgreementLightDto"
}
],
"description": "Value that should be returned when conditions are met",
"nullable": true
},
"priority": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The message",
"nullable": true,
"example": "Success"
},
"type": {
"type": "string",
"description": "Type of the message\nOne of Info, Warning, Error, Forbidden",
"nullable": true,
"example": "Info"
},
"errorCode": {
"type": "string",
"description": "Error Code",
"nullable": true,
"example": "INTERNAL_SERVER_ERROR"
}
},
"additionalProperties": false,
"description": "The message associated to the service response"
},
"Signee": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Defines a version Signee"
},
"StageDto": {
"required": [
"id",
"name",
"processes"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "The UiD of the stage",
"format": "uuid",
"example": "24511767-4586-4b69-af43-c405ec6b154a"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Stage name",
"example": "New Request"
},
"dataKey": {
"maxLength": 255,
"pattern": "(^$)|(^[\\dA-z]+$)",
"type": "string",
"description": "Stage Datakey",
"nullable": true,
"example": "NewRequestStageDataKey"
},
"description": {
"maxLength": 255,
"type": "string",
"description": "Stage description",
"nullable": true,
"example": "New Request Stage"
},
"order": {
"minimum": 0,
"type": "integer",
"description": "Stage order",
"format": "int32",
"example": 1
},
"processesCompletionOrder": {
"enum": [
"Sequential",
"AnyOrder"
],
"type": "string",
"description": "Determines the order of completing processes. Defaults to Sequential.\nOne of Sequential, AnyOrder",
"nullable": true,
"example": "Sequential"
},
"inParallelWithStages": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Optional list of previous stages when this stage should start",
"nullable": true
},
"stageChannel": {
"type": "string",
"description": "Stage channel",
"nullable": true,
"example": "Internal"
},
"assignedPortalRoleIds": {
"type": "array",
"items": {
"maxLength": 20,
"type": "string"
},
"description": "The list of IDs of the assigned portal roles",
"nullable": true
},
"processes": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ProcessDto"
},
"description": "List of stage processes"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "List of conditions required to trigger stage",
"nullable": true
},
"serviceLevelAgreement": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceLevelAgreementDto"
}
],
"description": "Stage Service Level Agreement",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing journey stage"
},
"StringConditionDefinitionDtoIConditionalValue": {
"required": [
"logicalOperation",
"operands"
],
"type": "object",
"properties": {
"logicalOperation": {
"minLength": 1,
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Abstractions.ICondition`1.Operands collection",
"example": "AND"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type "
},
"value": {
"type": "string",
"description": "Value that should be returned when conditions are met",
"nullable": true,
"example": "Relationship Manager"
},
"priority": {
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"StringServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"TaskDto": {
"required": [
"id",
"name",
"taskType"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "The UiD of the task",
"format": "uuid",
"example": "c5207c1d-5242-4c28-b16f-ac028e2bfdfd"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Task name",
"example": "Capture Basic Details"
},
"taskKey": {
"maxLength": 255,
"pattern": "(^$)|(^[\\dA-z]+$)",
"type": "string",
"description": "Task key",
"nullable": true,
"example": "CaptureBasicDetailsTaskKey"
},
"description": {
"maxLength": 2000,
"type": "string",
"description": "Task description",
"nullable": true,
"example": "Capture Basic Details task"
},
"order": {
"minimum": 0,
"type": "integer",
"description": "Task order",
"format": "int32",
"example": 1
},
"taskType": {
"minLength": 1,
"type": "string",
"description": "Task type",
"example": "PolicyTask"
},
"teamId": {
"type": "string",
"description": "Team id that task belongs to",
"nullable": true,
"example": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0"
},
"defaultTeamId": {
"type": "string",
"description": "Default Team of a task",
"nullable": true,
"example": "2d198b05-e805-407d-a289-080d72dc6910"
},
"defaultJourneyOwnerAssigned": {
"type": "boolean",
"description": "Flag to determine if task is assigned to journey owner as default",
"example": true
},
"journeyOwner": {
"type": "boolean",
"description": "Flag to determine if task is assigned to journey owner",
"example": true
},
"readOnlyTeams": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of teams that can access task in read only mode",
"nullable": true
},
"disableConditionalTeamAssignment": {
"type": "boolean",
"description": "Flag to determine if team should be automatically assigned to tak when team assignment conditions are met",
"example": false
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "List of conditions required to trigger task",
"nullable": true
},
"teamAssignmentConditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionalValueDto"
},
"description": "List of conditions required to dynamically assign team to task",
"nullable": true
},
"teamAssignmentConditionsV2": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamAssignmentDtoConditionalValueDto"
},
"description": "List of conditions required to dynamically assign team or journey owner to task",
"nullable": true
},
"completeAfter": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of previous tasks that must be completed before this task",
"nullable": true
},
"checkerTaskList": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of tasks that must be completed by different users than user who completes this task",
"nullable": true
},
"teamNotifications": {
"type": "boolean",
"description": "If true, the team notification should be sent for that task",
"example": false
},
"serviceLevelAgreement": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceLevelAgreementDto"
}
],
"description": "Task Service Level Agreement",
"nullable": true
},
"associationScopingCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Configure association scoping categories for a task",
"nullable": true
},
"autocomplete": {
"type": "boolean",
"description": "Task automation.If true enables the autocomplete capability"
},
"autocompleteConditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Task automation conditions.",
"nullable": true
},
"autocompleteDocValidationStatuses": {
"type": "array",
"items": {
"type": "string"
},
"description": "\"Waived\" and \"Deferred\" Document Requirements",
"nullable": true
},
"agentAutonomy": {
"type": "string",
"description": "Degree of autonomy that the agent has",
"nullable": true
},
"disableAgent": {
"type": "boolean",
"description": "Flag to disable agent functionality for this task",
"nullable": true
},
"smartDoc": {
"type": "boolean",
"description": "Enable SmartDoc",
"nullable": true,
"example": true
},
"bulkCompletionEnabled": {
"type": "boolean",
"description": "Bulk task completion. If true enables the ability to bulk complete tasks",
"nullable": true,
"example": true
},
"dataExtractionEnabled": {
"type": "boolean",
"description": "Enable Data Extraction",
"nullable": true,
"example": true
},
"documentRequirementApproval": {
"type": "boolean",
"description": "Enable the document requirement approval workflow (manual Approve/Reject before completion)",
"nullable": true,
"example": true
},
"policyTarget": {
"type": "string",
"description": "Policy target",
"nullable": true,
"example": "Client"
},
"policyCategory": {
"type": "string",
"description": "Policy category",
"nullable": true,
"example": "Basic Details"
},
"policyRequirementType": {
"type": "string",
"description": "Policy requirement type",
"nullable": true,
"example": "Data"
},
"categoryOrdering": {
"type": "boolean",
"description": "Flag indicating BusinessCategory property order. Alphabetically if false.",
"example": false
},
"dataGroupCategoryOrdering": {
"type": "boolean",
"description": "Flag indicating if data groups will be ordered by category.",
"example": false
},
"businessCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of policy business category e.g. [\"Basic Details\", \"Enrich Details\"]",
"nullable": true
},
"productCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Product categories to be displayed",
"nullable": true,
"example": [
"Account Information",
"Basic Details"
]
},
"businessSubCategory": {
"type": "string",
"description": "Policy subcategory",
"nullable": true,
"example": "Test SubCategory"
},
"documentPersistence": {
"type": "boolean",
"description": "Enable Document Persistence",
"nullable": true,
"example": true
},
"documentAutoLink": {
"type": "boolean",
"description": "Enable Document Auto-Linking. When enabled, all documents will be reviewed and auto-linked when this task opens.",
"nullable": true,
"example": true
},
"relatedPartyCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of related party data and document category e.g. [\"Related Party Basic Details\", \"Relationship Details\"]",
"nullable": true
},
"relatedPartyRelationshipTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of related party relationship types used for filtering recipients.",
"nullable": true
},
"dataGroupSearchScope": {
"type": "array",
"items": {
"maxLength": 255,
"type": "string"
},
"description": "List of data group identifiers used to scope duplicate search for related-party tasks.",
"nullable": true
},
"productRelatedPartyCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of product related party business category e.g. [\"Green Loan\"]",
"nullable": true
},
"captureRelatedPartyDocuments": {
"type": "boolean",
"description": "Enable Capturing Related Party Documents in Outreach Related Party Task",
"nullable": true
},
"enforceOwnershipAndControlInPortal": {
"type": "boolean",
"description": "Enable Enforce Ownership and Control in Related Party Task in Portal",
"nullable": true
},
"enforceMandatoryRPCapture": {
"type": "boolean",
"description": "Enable Enforce Mandatory Related Party Capture in Related Party Task in Portal",
"nullable": true
},
"relatedPartiesSearchEntitiesInGroupEnabled": {
"type": "boolean",
"description": "Related Parties Task - Determines if Related Parties Search should be restricted to Group Entities only"
},
"autoExtractionEnabled": {
"type": "boolean",
"description": "Related Parties Task - Determines if Auto Extraction of related parties is turned on"
},
"disableIDV": {
"type": "boolean",
"description": "Related Parties task - Disable IDV processing in as there might be separate IDV task set within the journeyś",
"nullable": true
},
"searchExcludeClientEntities": {
"type": "boolean",
"description": "Related Parties Task - Determines whether to exclude client entities from the duplicate search"
},
"relatedPartyScopingRuleSet": {
"type": "string",
"description": "PolicyTask (OwnershipAndControl) and HierarchyCaptureTask - Scoping rule to filter which related parties are displayed when this task loads",
"nullable": true
},
"eSignatureAutocomplete": {
"type": "boolean",
"description": "eSignature Autocomplete - When enabled, this task will autocomplete when all eSignature documents have been signed"
},
"eSignatureTypeConfiguration": {
"type": "boolean",
"description": "eSignature Type Configuration - When enabled, this task will auto-select eSignature type based on predefined conditions"
},
"serviceName": {
"type": "string",
"description": "Service name",
"nullable": true,
"example": "cancelJourney"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Service task properties",
"nullable": true
},
"targetEntities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Credit Screening service/ Financial Analysis task - List of target entitiy",
"nullable": true,
"example": [
"Client",
"Related Party"
]
},
"riskLevels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Risk assessment condition task - List of risk levels e.g. [\"High\", \"Restricted\"]",
"nullable": true
},
"riskConditionField": {
"type": "string",
"description": "Risk assessment condition task - the policy field where the risk is stored, used in the condition",
"nullable": true
},
"property": {
"type": "string",
"description": "Entity data and If/Then condition task property",
"nullable": true,
"example": "testProperty"
},
"value": {
"type": "string",
"description": "Entity data condition task value",
"nullable": true,
"example": "testValue"
},
"subTasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskDto"
},
"description": "Group task - list of sub tasks",
"nullable": true
},
"branches": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TaskDto"
},
"description": "Branchable task - list of branches",
"nullable": true
},
"approvalMethod": {
"type": "string",
"description": "Data review task - approval method",
"nullable": true
},
"outcome": {
"type": "string",
"description": "Data review task - outcome",
"nullable": true,
"example": "Approved"
},
"message": {
"type": "string",
"description": "Data review task - message",
"nullable": true,
"example": "test message"
},
"includeReviseOutcome": {
"type": "boolean",
"description": "Data review task - include revise outcome",
"example": true
},
"includeRiskSection": {
"type": "boolean",
"description": "Data review task - include risk section",
"example": false,
"deprecated": true
},
"policyRequirementTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Combined policy task - list of policy requirement types",
"nullable": true
},
"documentTaskVersion": {
"type": "integer",
"description": "Combined policy task - the version number of the document task to be used",
"format": "int32",
"nullable": true
},
"sequentialTaskEvalEnabled": {
"type": "boolean",
"description": "Product task - enable sequential task evaluation",
"nullable": true
},
"relatedPartyEnabled": {
"type": "boolean",
"description": "Product task - enable related parties",
"nullable": true
},
"relatedProductsEnabled": {
"type": "boolean",
"description": "Product task - enable related products grid",
"nullable": true
},
"documentRequirementsEnabled": {
"type": "boolean",
"description": "Product task - enable document requirements",
"nullable": true
},
"displayPortalDocumentRequirements": {
"type": "boolean",
"description": "Product task - enable display of document requirements in portal",
"nullable": true
},
"productActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Product task - List of Product Actions",
"nullable": true
},
"displayCollateralGrid": {
"type": "boolean",
"description": "Product task - display Collateral grid",
"nullable": true
},
"collateralCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Product task - List of Collateral categories to be displayed",
"nullable": true
},
"productScopingRuleSet": {
"type": "string",
"description": "Product task - Product Scoping Rule Set to filter out products in task",
"nullable": true
},
"enforceProductCapture": {
"type": "boolean",
"description": "Product task - When true, users must capture at least one product before completing the task"
},
"detailsCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Credit Assessment task - Configurable details categories",
"nullable": true
},
"creditAssessmentProductsEnabled": {
"type": "boolean",
"description": "Credit Assessment Task - States whether products are accessible during the credit assessment task."
},
"productSummaryGridColumnCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Credit Assessment or Financial Analysis Task - Gives the categories used to configure the columns for the product grid in the task.",
"nullable": true
},
"productSummaryGridTotalRow": {
"type": "boolean",
"description": "Credit Assessment or Financial Analysis Task - Enabled total rows in product summary grid.",
"nullable": true
},
"creditScreeningSummaryEnabled": {
"type": "boolean",
"description": "Manual Credit Screening Task - States whether summaries are accessible during the credit screening task."
},
"legalEntitySecondaryIdentifiersCategory": {
"type": "string",
"description": "Manual Credit Screening Task - The policy category used for legal entity secondary identifiers.",
"nullable": true
},
"externalDataProviderIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "External DataV2 Task - External Data Provider Ids",
"nullable": true
},
"externalDataAutomaticSearchProviderIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "External DataV2 Task - External Data Automatic Search Provider Ids",
"nullable": true
},
"externalDataAutomaticProfileDownloadIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "External DataV2 Task - External Data Automatic Profile Download Ids",
"nullable": true
},
"externalDataAutomaticImportProviderIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "External DataV2 Task - Automatically Import From Specific Provider",
"nullable": true
},
"externalDataAutomaticCompleteTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "External DataV2 Task - Automatically Complete Under Specific Condition e.g. When no results returned or When Single Exact Match returned",
"nullable": true
},
"externalDataRelatedPartiesAutomationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "External DataV2 Task - Automatically Import Related Parties for specific provider",
"nullable": true
},
"externalDataAutomaticUboDiscovery": {
"type": "boolean",
"description": "External DataV2 Task - External Data Automatic Ubo Discovery"
},
"externalDataIgnoreDuplicates": {
"type": "boolean",
"description": "External DataV2 Task - Ignore Duplicates when executing Related Parties Automation"
},
"externalDataAutoImportOptimizationEnabled": {
"type": "boolean",
"description": "External DataV2 Task - Enable optimized auto import SF (skip redundant searches/GETs already done by NR Import)"
},
"documentCollectionProviderIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "External Data Docs Collection Task - Document Collection Provider Ids",
"nullable": true
},
"scenarioCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Financial Analysis Task - Configure scenario categories",
"nullable": true
},
"summaryCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Financial Analysis Task - Configure summary categories",
"nullable": true
},
"allocationsEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - Enable Capacity to Service Allocations"
},
"persistManualDataEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - Persist manually input financial analysis data"
},
"financialAnalysisProductSummary": {
"type": "boolean",
"description": "Financial Analysis Task - Enable product summary for financial analysis"
},
"financialAnalysisCustomTaskProviderEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - Enable custom task provider"
},
"financialAnalysisCustomTaskProviderId": {
"type": "string",
"description": "Financial Analysis Task - provider id if FinancialAnalysisCustomTaskProviderEnabled is true",
"nullable": true
},
"financialAnalysisCustomTaskButtonLabel": {
"type": "string",
"description": "Financial Analysis Task - Button Label if custom task is enabled",
"nullable": true
},
"jointFinancialAnalysisEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - Enable Joint Financial Analysis"
},
"financialAnalysisAutoSaveEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - Enable Financial Analysis Auto Save"
},
"financialAnalysisDataVisualisationEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - Enable Financial Analysis Data Visualisation"
},
"financialAnalysisMultiAdjustmentsEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - The user has the ability to capture multiple adjustments \nagainst a financial item in the Summary Tab"
},
"financialAnalysisDeferAbilityEnabled": {
"type": "boolean",
"description": "Financial Analysis Task - When it's enabled, the user has the ability to defer \nFinancial Analysis by switching the toggle on the task page"
},
"assetsCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Collateral Task - Assets categories",
"nullable": true
},
"collateralRelatedParty": {
"type": "boolean",
"description": "Collateral task - enable related parties for collateral"
},
"collateralRelatedPartyCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collateral task - categories relating to the collateral related party.",
"nullable": true
},
"assetRelatedParty": {
"type": "boolean",
"description": "Collateral task - enable related parties for assets"
},
"assetRelatedPartyCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collateral task - categories relating to the assets related party.",
"nullable": true
},
"collateralAutoSaveEnabled": {
"type": "boolean",
"description": "Collateral task - Enable Collateral Auto Save"
},
"collateralActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collateral task - List of Collateral Actions",
"nullable": true
},
"enableAllCollateralActions": {
"type": "boolean",
"description": "Collateral task - Enable all Collateral Actions",
"nullable": true
},
"assetActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collateral task - List of Asset Actions",
"nullable": true
},
"enableAllAssetActions": {
"type": "boolean",
"description": "Collateral task - Enable all Asset Actions",
"nullable": true
},
"collateralSummaryCategory": {
"type": "string",
"description": "Collateral Summary Category - Category to define second identifiers for collaterals",
"nullable": true,
"example": "Secondary Identifier"
},
"assetSummaryTableCategory": {
"type": "string",
"description": "Collateral task - Asset summary table category",
"nullable": true,
"example": "Asset summary table"
},
"covenantsConditionsCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Covenants & Conditions - CovenantsConditions categories",
"nullable": true
},
"dealRequirementSetId": {
"type": "string",
"description": "Manage Deals Task - Requirement Set Id",
"nullable": true,
"example": "2d198b05-e805-407d-a289-080d72dc6910"
},
"dealTabs": {
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"description": "Manage Deals Task - Tab , Enabled/Disabled",
"nullable": true
},
"productCategoryOrdering": {
"type": "boolean",
"description": "Flag indicating ProductCategory property order. Alphabetically if false.",
"example": false
},
"dealActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Deal Actions",
"nullable": true,
"example": false
},
"enableDealCollaterals": {
"type": "boolean",
"description": "Manage Deals Task - Display Collateral Grid",
"nullable": true
},
"dealCollateralsCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Collateral Categories to be displayed",
"nullable": true
},
"dealCollateralGridFieldConfigCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Deal Collateral Summary Table order categories",
"nullable": true
},
"dealCollateralDetailsCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Collateral Categories which it will display the individual collateral",
"nullable": true
},
"dealCollateralAssetDetailsCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Collateral Asset Categories for assets details tab in collateral modal",
"nullable": true
},
"productDealActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Product Deal Actions",
"nullable": true,
"example": false
},
"dealsPolicyDataEnabled": {
"type": "boolean",
"description": "Flag indicating if deals policy data is enabled.",
"example": false
},
"dealsPolicyDataCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Policy categories to be displayed",
"nullable": true,
"example": [
"Booking Details",
"Basic Details"
]
},
"dealsPolicyDataGroupCategoryOrdering": {
"type": "boolean",
"description": "Flag indicating if deals policy data groups will be ordered by category.",
"example": false
},
"dealsPolicyCategoryOrdering": {
"type": "boolean",
"description": "Flag indicating PolicyDate property order. Alphabetically if false. .",
"example": false
},
"dealsMainEntitySummaryCategory": {
"type": "string",
"description": "Category to be displayed in the Main Entity Details Tab",
"nullable": true,
"example": "Basic Details"
},
"dealsMainEntityCollateralSummaryEnabled": {
"type": "boolean",
"description": "Flag indicating if collateral grid, which is under Main Entity Collateral Tab, should be displayed",
"example": false
},
"dealsMainEntityCollateralSummaryCategory": {
"type": "string",
"description": "Columns to be displayed in the collateral grid under Main Entity Collateral Tab",
"nullable": true,
"example": "Main Entity Collateral Category"
},
"dealsCustomTaskProviderEnabled": {
"type": "boolean",
"description": "Deals - Enable custom task provider"
},
"dealsCustomTaskProviderId": {
"type": "string",
"description": "Deals - provider id if custom task provider is enabled",
"nullable": true,
"example": "2d198b05-e805-407d-a289-080d72dc6910"
},
"dealsCustomTaskButtonLabel": {
"type": "string",
"description": "Deals - Button label if custom task provider is enabled",
"nullable": true,
"example": "Generate"
},
"dealsRelatedPartiesCreateEntityEnabled": {
"type": "boolean",
"description": "Deals - Determines if creation of entity on related parties should be enabled"
},
"dealsRelatedPartiesSearchEntitiesInGroupEnabled": {
"type": "boolean",
"description": "Deals - Determines if Related Parties Search should be restricted to Group Entities only"
},
"dealsRelatedProductsEnabled": {
"type": "boolean",
"description": "Deals - Determines if Related Products should be enabled in Deals Products"
},
"dealsCollateralActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Deal Collateral Actions",
"nullable": true,
"example": [
"Edit",
"Delete",
"Link"
]
},
"dealsDisplayCollateralLinkInProductsTab": {
"type": "boolean",
"description": "Deals - Display related collateral table in Products Tab"
},
"dealsCovenantsConditionsActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of Covenant & Conditions Actions",
"nullable": true,
"example": [
"Add",
"Delete",
"Edit"
]
},
"dealsEntitiesTableCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of categories for entities table",
"nullable": true,
"example": [
"Category1"
]
},
"dealsRelatedPartiesActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of action controls for related parties",
"nullable": true,
"example": [
"Add",
"Delete",
"Edit"
]
},
"dealsRelatedProductsActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Manage Deals Task - List of action controls for related products",
"nullable": true,
"example": [
"Add",
"Delete",
"Edit"
]
},
"reviewAndApprovalSelectedGroup": {
"type": "string",
"description": "Selected group for Review and Approval task",
"nullable": true,
"example": "Primary Entity Data"
},
"reviewAndApprovalSelectedEntityTask": {
"type": "string",
"description": "Selected entity task for Review and Approval task",
"nullable": true,
"example": "Primary Entity Data"
},
"reviewAndApprovalSelectedDocumentTask": {
"type": "string",
"description": "Selected document task for Review and Approval task",
"nullable": true,
"example": "Primary Entity Data"
},
"reviewAndApprovalSelectedAssociationsTask": {
"type": "string",
"description": "Selected associations task for Review and Approval task",
"nullable": true,
"example": "Primary Entity Data"
},
"reviewAndApprovalSelectedRiskTask": {
"type": "string",
"description": "Selected risk task for Review and Approval task",
"nullable": true,
"example": "Primary Entity Data"
},
"preRelease": {
"type": "boolean",
"description": "Flag indicating if pre-release is enabled",
"example": true
},
"randomSamplingRate": {
"type": "integer",
"description": "Percentage of the task that is picked for random sampling",
"format": "int32",
"nullable": true,
"example": 15
},
"changeDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Proposed changes task - list of tabs to show",
"nullable": true,
"example": [
"Primary Entity Data",
"Related Parties"
]
},
"changeDomainsConflictResolution": {
"type": "array",
"items": {
"type": "string"
},
"description": "Conflict resolution task - list of tabs to show",
"nullable": true,
"example": [
"Primary Entity Data",
"Product"
]
},
"hideUnchangedCategories": {
"type": "boolean",
"description": "Conflict resolution task - when true, categories with no field changes are hidden"
},
"showCalculatedFieldMessage": {
"type": "boolean",
"description": "Conflict resolution task - when true, fields with a calculated value will be read only and tagged as calculated"
},
"publishedTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Publish to Entity task - list of types to publish",
"nullable": true,
"example": [
"Primary Entity Data",
"Product"
]
},
"portalEnrichDocumentMetadataEnabled": {
"type": "boolean",
"description": "DocumentsV2Task - Enable Portal Enrich Document Metadata",
"nullable": true,
"example": true
},
"portalEnhancedDocsLayoutEnabled": {
"type": "boolean",
"description": "DocumentsV2Task - Enable Updated Docs View",
"nullable": true,
"example": true
},
"defaultToExistingValue": {
"type": "boolean",
"description": "DocumentDataExtractionTask - Default to Existing Value in review panel",
"example": false
},
"relatedPartyExtractionEnabled": {
"type": "boolean",
"description": "DocumentDataExtractionV2Task - Enable related party extraction",
"example": false
},
"currentJourneyOnly": {
"type": "boolean",
"description": "DocumentDataExtractionV2Task - Extract only from documents uploaded in this journey",
"example": false
},
"fundSearchCategory": {
"type": "string",
"description": "Investment Account Task - Fund Search Category. A value indicating which business category should be used for searching a fund",
"nullable": true,
"example": "Fund Basic Search"
},
"initialCreationCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Investment Account Task - Initial Creation Categories. A value indicating which business categories will be used at initial investment account creation",
"nullable": true
},
"validateMissingRequirements": {
"type": "boolean",
"description": "Investment Account Task - Validate Missing Requirements. A value indicating if the task should validate missing requirements for inaccessible requirements"
},
"enableLinkProduct": {
"type": "boolean",
"description": "Investment Account Task - Enable Link Product. If true a user will be able to link a Product of a Fund to an Investment Account"
},
"enableLinkBankAccount": {
"type": "boolean",
"description": "Investment Account Task - Enable Link Bank Account. If true a user will be able to link a Bank Account to an Investment Account"
},
"enableOffboarding": {
"type": "boolean",
"description": "Investment Account Task - Enable Offboarding. If true a user will be able to mark Investment Accounts for offboarding and offboard on task verification"
},
"enableDefaultInvestmentAccountName": {
"type": "boolean",
"description": "Investment Account Task - Enable Default Investment Account Name. \nIf true the name of investment account will be automatically set to 'Entity Name'_Account OR 'Entity Name'_'Name of Fund'_Account"
},
"displayAccessLayersOnInvestmentAccount": {
"type": "boolean",
"description": "Investment Account Task - Determines if Access Layers should be displayed on the Investment Account Task"
},
"enableBankAccountPurpose": {
"type": "boolean",
"description": "Investment Account Task - Bank Account Purpose.Enables Bank account purpose capture when linking a Bank Account to an Investment Account. This toggle is disabled until the Bank account purpose category is configured in Policy."
},
"updateInvestmentAccountNamesOnVerification": {
"type": "boolean",
"description": "Investment Account Task - Determines if Investment Accounts names should be updated on the Verification Task",
"example": true
},
"displayPortalDocumentRequirementsOnInvestmentAccount": {
"type": "boolean",
"description": "Investment Account Task - Determines if Document Requirements should be displayed to the Portal user per Investment Account."
},
"documentPersistenceOnInvestmentAccount": {
"type": "boolean",
"description": "Investment Account Task - When enabled, documents previously supplied for an Investment Account are re-linked to the equivalent requirement when that account appears in a later journey.",
"example": true
},
"enforceInvestmentAccountCreation": {
"type": "boolean",
"description": "Investment Account Task - When enabled, at least one Investment Account must be created before the task can be completed",
"example": true
},
"enableStatusFilteringOnInvestmentAccount": {
"type": "boolean",
"description": "Investment Account Task - When enabled, Portal surfaces Investment Accounts across multiple lifecycle statuses (not only Onboarding-In-Progress) and exposes a status filter on the IA list."
},
"brandFilterEnabledOnInvestmentAccount": {
"type": "boolean",
"description": "Investment Account Task - When enabled, the Portal IA list is filtered to accounts whose linked funds carry the current Portal Tenant's brand on the configured Fenergo.Nebula.Journey.Command.Application.Dto.TaskDto.BrandDataKeyOnInvestmentAccount property."
},
"brandDataKeyOnInvestmentAccount": {
"type": "string",
"description": "Investment Account Task - Name of the fund entity property whose value (pipe-delimited brand tokens) is matched against the current Portal Tenant's name when Fenergo.Nebula.Journey.Command.Application.Dto.TaskDto.BrandFilterEnabledOnInvestmentAccount is on.",
"nullable": true,
"example": "brandName"
},
"managedRelationshipCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Agency Request Detail Task - Managed Relationship Category. A value indicating which business category should be used for filtering fields on the task",
"nullable": true
},
"documentCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Managed Relationship Detail Task - Document Category. A value indicating which category should be used for filtering fields on the task",
"nullable": true
},
"integrationPipelineId": {
"type": "string",
"description": "Integrations Data Publish Task - Integration Pipeline Id or Flow Key. Identifier of pipeline that will be used for Data Publish purposes.",
"nullable": true,
"example": "a222cedb-9a43-4191-832c-ed56f345f602"
},
"integrationSkipOnRerun": {
"type": "boolean",
"description": "Integrations Data Publish Task - Integration skip on rerun. Boolean value that determines if Data Publish should be rerunned when task is reopened."
},
"isdaActiveProtocols": {
"type": "array",
"items": {
"type": "string"
},
"description": "Isda Amend Search Task - Isda Provider Ids",
"nullable": true
},
"significanceEngineRules": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Significance Engine Rules Ids.",
"nullable": true
},
"isComplianceTask": {
"type": "boolean",
"description": "Enable Alert Assessment Compliance task"
},
"regulaConfigurationId": {
"type": "string",
"description": "Individual Id Verification Liveness Task.",
"format": "uuid"
},
"bulkEntityManagement": {
"type": "boolean",
"description": "Enable Bulk Entity Management - EntityGroupManagement Task",
"nullable": true
},
"idvScopingRuleSet": {
"type": "string",
"description": "Related Party Data And Documents task - IDV Scoping Rule Set to filter out related parties in task",
"nullable": true
},
"unwrappingPolicyCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "Hierarchy Capture task - Unwrapping Policy Categories determine policy categories for Ownership and Control requirements in task",
"nullable": true
},
"externalDataConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalDataConfigurationsDto"
}
],
"description": "Hierarchy Capture task - External Data Configuration for data providers",
"nullable": true
},
"agencyEtlDataTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Agency ETL Task - Data Types to be used in the creation of the ETL migration",
"nullable": true
},
"agencyEtlPolicyId": {
"type": "string",
"description": "Agency ETL Task - Policy to be used in the creation of the ETL migration",
"nullable": true,
"example": "a222cedb-9a43-4191-832c-ed56f345f602"
},
"agencyEtlProductPolicyId": {
"type": "string",
"description": "Agency ETL Task - Product Policy to be used in the creation of the ETL migration",
"nullable": true,
"example": "a222cedb-9a43-4191-832c-ed56f345f602"
},
"agencyEtlEntityResolutionSearchQueryFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResolutionSearchQueryFieldDto"
},
"description": "Agency ETL Task - Entity Resolution Fields to be used in ETL agency entity resolution process\nand their corresponding weights for elasticsearch matching",
"nullable": true,
"example": [
"legalEntityName",
"countryOfIncorporation"
]
},
"agencyEtlEntityResolutionMatchScoreThreshold": {
"type": "number",
"description": "Sets the match score threshold for entity resolution in Agency ETL Task",
"format": "double",
"example": 0.9
},
"taskIdToReopen": {
"type": "string",
"description": "Parent Data Sync Task - Guid of the task to be reopened",
"format": "uuid",
"nullable": true,
"example": "a222cedb-9a43-4191-832c-ed56f345f602"
},
"completeAutomatically": {
"type": "boolean",
"description": "Parent Data Sync Task - boolean indicating that the task is auto-completed. It will not reopen any previously completed tasks",
"example": false
},
"displayAccessLayersOnBankAccount": {
"type": "boolean",
"description": "Bank Account Task - Determines if Access Layers should be displayed on the Bank Account Task"
},
"enforceBankAccountCreation": {
"type": "boolean",
"description": "Bank Account Task - When enabled, at least one Bank Account must be created before the task can be completed",
"example": true
},
"autoManagedRelationshipName": {
"type": "boolean",
"description": "Set automatic naming of the managed relationship entity created from the task",
"example": true
},
"taskCompletionWithUnresolvedItemsEnabled": {
"type": "boolean",
"description": "Task completion with unresolved items",
"example": true
},
"sanctionsProceedDecisionEnabled": {
"type": "boolean",
"description": "Sanctions proceed decision",
"example": true
},
"escalationEnabled": {
"type": "boolean",
"description": "Escalation",
"example": true
},
"documentUploadAgainstEachAlertEnabled": {
"type": "boolean",
"description": "Hit document required",
"example": true
},
"hitDocumentType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Hit document required document type",
"nullable": true
},
"documentReqForEachScreenedEntityEnabled": {
"type": "boolean",
"description": "Entity document required",
"example": true
},
"entityDocumentType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Entity document required document type",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing journey task"
},
"TaskReassignOutcomeDto": {
"type": "object",
"properties": {
"journeyInstanceId": {
"type": "string",
"description": "The UiD of the journey",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"taskId": {
"type": "string",
"description": "The UiD of the task",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"success": {
"type": "boolean",
"description": "Information if task has been reassigned successfully",
"example": true
},
"errorMessage": {
"type": "string",
"description": "Information about the reason why the task could not be reassigned.",
"nullable": true,
"example": "Reason"
}
},
"additionalProperties": false,
"description": "DTO representing an outcome of a task reassignment process"
},
"TaskReassignOutcomeDtoListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskReassignOutcomeDto"
},
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"TeamAssignmentDto": {
"type": "object",
"properties": {
"teamId": {
"type": "string",
"description": "The UiD of the team",
"format": "uuid",
"nullable": true,
"example": "c5207c1d-5242-4c28-b16f-ac028e2bfdfd"
},
"journeyOwnerAssigned": {
"type": "boolean",
"description": "Flag to determine if task is assigned to journey owner",
"example": true
}
},
"additionalProperties": false,
"description": "DTO representing task's team assignment metadata"
},
"TeamAssignmentDtoConditionDefinitionDtoIConditionalValue": {
"required": [
"logicalOperation",
"operands"
],
"type": "object",
"properties": {
"logicalOperation": {
"minLength": 1,
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Abstractions.ICondition`1.Operands collection",
"example": "AND"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type "
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/TeamAssignmentDto"
}
],
"description": "Value that should be returned when conditions are met",
"nullable": true
},
"priority": {
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"TeamAssignmentDtoConditionalValueDto": {
"required": [
"logicalOperation",
"operands"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the condition",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "The name of the condition",
"nullable": true,
"example": "Company-type only"
},
"description": {
"type": "string",
"description": "The description of the condition",
"nullable": true,
"example": "Applicable only when EntityType=Company"
},
"logicalOperation": {
"minLength": 1,
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection",
"example": "AND"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/TeamAssignmentDto"
}
],
"description": "Value that should be returned when conditions are met",
"nullable": true
},
"priority": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"UpdateJourneyConfigurationRequestDto": {
"type": "object",
"properties": {
"isCancellationCommentMandatory": {
"type": "boolean",
"description": "Flag indicating if journey cancellation comment should be enabled or disabled"
},
"enableSlaEventNotifications": {
"type": "boolean",
"description": "Flag indicating if SLA event notifications should be enabled or disabled"
},
"restrictTaskReopenToAssignedTeam": {
"type": "boolean",
"description": "Flag indicating if task reopen should be restricted to the assigned team only"
},
"isCancellationReasonMandatory": {
"type": "boolean",
"description": "Flag indicating if journey cancellation reason should be mandatory"
},
"isReassignCommentMandatory": {
"type": "boolean",
"description": "Flag indicating if reassign-task comment should be mandatory"
},
"isReopenReasonEnabled": {
"type": "boolean",
"description": "Flag indicating if the reopen-reason dropdown is enabled.\nNullable to avoid silent resets from older callers that don't send this field.",
"nullable": true
},
"isReopenReasonMandatory": {
"type": "boolean",
"description": "Flag indicating if the reopen-reason dropdown selection is mandatory.\nNullable to avoid silent resets from older callers that don't send this field.",
"nullable": true
},
"validateExistingReferenceDataValues": {
"type": "boolean",
"description": "Flag indicating if existing reference data values should be validated on load.\nNullable to avoid silent resets from older callers that don't send this field.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing configuration data to update"
},
"UpdateJourneyConfigurationRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyConfigurationRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateJourneyInstanceAccessLayersDto": {
"required": [
"accessLayers"
],
"type": "object",
"properties": {
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Journey access layers determining the access to the journey instance"
},
"version": {
"type": "integer",
"description": "Current version of the Journey instance where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1
}
},
"additionalProperties": false,
"description": "Request DTO representing the journey instance access layers data"
},
"UpdateJourneyInstanceAccessLayersDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyInstanceAccessLayersDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateJourneyLaunchControlsDto": {
"required": [
"conditions"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the journey launch controls",
"format": "uuid"
},
"description": {
"type": "string",
"description": "The journey description for journey launch controls",
"nullable": true
},
"conditions": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Logic engine conditions for journey launch controls"
}
},
"additionalProperties": false,
"description": "Request DTO representing journey launch controls data"
},
"UpdateJourneyLaunchControlsDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyLaunchControlsDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateJourneyLaunchControlsResponseDto": {
"type": "object",
"properties": {
"journeyLaunchControls": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyLaunchControlsDto"
}
],
"description": "Updated Journey Launch Controls",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateJourneyLaunchControlsResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyLaunchControlsResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"UpdateJourneyScheduleVersionDto": {
"type": "object",
"properties": {
"journeyScheduleId": {
"type": "string",
"description": "The UiD of the journey Schedule",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
},
"name": {
"type": "string",
"description": "Journey schedule name",
"nullable": true,
"example": "Client Onboarding"
},
"type": {
"type": "string",
"description": "Journey Type",
"nullable": true,
"example": "Client Onboarding"
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"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-01-01T14:48:00.000Z"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the Schedule can be used",
"nullable": true
},
"version": {
"type": "integer",
"description": "Current version of journey instance aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1,
"example": 5
}
},
"additionalProperties": false,
"description": "Request DTO representing set of properties which define a new version of journey Schedule"
},
"UpdateJourneyScheduleVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneyScheduleVersionDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateJourneySchemaVersionDto": {
"type": "object",
"properties": {
"journeySchemaId": {
"type": "string",
"description": "The UiD of the journey schema",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
},
"name": {
"type": "string",
"description": "Journey schema name",
"nullable": true,
"example": "Client Onboarding"
},
"type": {
"type": "string",
"description": "Journey schema type",
"nullable": true,
"example": "Client Onboarding"
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageDto"
},
"description": "Journey schema stage collection",
"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-01-01T14:48:00.000Z"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the schema can be used",
"nullable": true
},
"externalConditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "External Conditions under which the schema can be used",
"nullable": true
},
"milestones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyMilestoneDto"
},
"description": "List of Journey Schema Milestones",
"nullable": true
},
"channelType": {
"allOf": [
{
"$ref": "#/components/schemas/ChannelTypeDto"
}
],
"description": "Channel type describing whether journeys will be initiated by internal teams (Internal) or external customers through Portal (External)"
},
"version": {
"type": "integer",
"description": "Current version of journey schema version aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1,
"example": 5
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"serviceLevelAgreement": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceLevelAgreementDto"
}
],
"description": "Journey Schema Service Level Agreement",
"nullable": true
},
"areReopenCommentsOptional": {
"type": "boolean",
"description": "If true then comments are non-mandatory. If false then comments are mandatory.",
"example": true
}
},
"additionalProperties": false,
"description": "Request DTO representing set of properties which define a new version of journey schema"
},
"UpdateJourneySchemaVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneySchemaVersionDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateJourneySlaConfigurationDto": {
"required": [
"referenceTimezone",
"workingDays"
],
"type": "object",
"properties": {
"workingDays": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of working days of the week (e.g. Monday–Friday)"
},
"referenceTimezone": {
"minLength": 1,
"type": "string",
"description": "Reference timezone used for SLA calculations (e.g. \"UTC\", \"Europe/Dublin\")"
}
},
"additionalProperties": false,
"description": "Request DTO representing Journey SLA configuration to update"
},
"UpdateJourneySlaConfigurationDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateJourneySlaConfigurationDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ValidationErrorModel": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"description": "Name of the property",
"nullable": true,
"example": "data"
},
"errorMessage": {
"type": "string",
"description": "User friendly error message",
"nullable": true,
"example": "Data is required"
},
"attemptedValue": {
"description": "Invalid value",
"nullable": true
},
"errorCode": {
"type": "string",
"description": "Internal error code",
"nullable": true,
"example": "NotNullValidator"
}
},
"additionalProperties": false,
"description": "Represents the details of validation error"
},
"ValidationErrorModelListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorModel"
},
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data",
"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",
"description": "Value of DataSource used to filter field values",
"nullable": true
},
"field": {
"type": "string",
"description": "Field value used to validate conditional value",
"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": [ ]
}
]
}