{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Journey Query", "description": "**Journey Query API**:\n\n
Journey Query API provides both configurational and operational methods related to the client Journeys. Use the Journey Command API to create manage and Journey Schemas and Journey Instances. Use the Command Query API to retrieve Journey Schema and Journey Instance aggregates.\n\n
**Journey Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/journeyquery" } ], "paths": { "/api/configuration": { "get": { "tags": [ "JourneyConfiguration" ], "summary": "Get configuration", "description": "\nReturns configuration.", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The configuration options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetJourneyConfigurationResponseDtoServiceResponse" } } } }, "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}": { "get": { "tags": [ "JourneyInstance" ], "summary": "Get journey instance by id", "description": "\nReturns journey instance for a given id.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetJourneyInstanceById", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey instance id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "If-None-Match", "in": "header", "description": "ETag value from previous API response. Should be used to optimize the short polling. Must be wrapped in double quotes.", "schema": { "type": "string" }, "example": "5-1643882726-3404e101e89cdd99e5b185f00789de4f33e585d6" }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Journey instance is returned", "headers": { "ETag": { "description": "Identifies specific version of Journey Instance. Multiple values are not supported.", "schema": { "type": "string", "example": "\"5-1643882726-3404e101e89cdd99e5b185f00789de4f33e585d6\"" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyInstanceDtoServiceResponse" } } } }, "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" } ] } } } }, "304": { "description": "The If-None-Match header value is up to date and no journey instance will be returned", "headers": { "Retry-After": { "description": "Specifies the number of second the client should wait before making subsequent API call.", "schema": { "type": "string", "example": "5" } } } }, "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}": { "get": { "tags": [ "JourneyInstance" ], "summary": "Get journey instance task by id", "description": "\nReturns a journey instance task for a given id.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetTaskById", "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" } ], "responses": { "200": { "description": "Success. journey instance task is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyTaskDtoServiceResponse" } } } }, "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/search": { "get": { "tags": [ "JourneyInstance" ], "summary": "Get journey instances by entity id", "description": "\nReturns a list of journey instances for a given entity id sorted by started date in descending order.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetInstancesByEntityId", "parameters": [ { "name": "entityId", "in": "query", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of journey instances is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJourneyInstanceViewModelDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } }, "deprecated": true }, "post": { "tags": [ "JourneyInstance" ], "summary": "Get a page of journey instances by entity id", "description": "\nReturns one page of journey instances for a given entity id, sorted by started date in\n descending order (not caller-configurable). Journeys the caller lacks access-layer permission\n for are not included in `Items`; their id appears in `RestrictedItems` instead.\n\nCallers MUST use `NextPaginationToken` — not `Items.Count` — to decide whether\n more pages remain. A page's non-restricted count can be smaller than the requested page size\n (or even zero) while `NextPaginationToken` is still non-null, since restricted journeys\n are filtered out of a fetched page after it is sized, not before.\n\nAn omitted or empty-GUID `EntityId` is not treated as an invalid request - it\n returns 200 with an empty page rather than a 400.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetInstancesByEntityIdV2", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Entity id and pagination options", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityJourneyInstanceSearchRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. A page of journey instances is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityJourneyInstanceSearchResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The tenant header or request body is missing/invalid", "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}/linked-journeys": { "get": { "tags": [ "JourneyInstance" ], "summary": "Get linked journeys by main journey id", "description": "\nReturns a linked journeys for a given id.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetLinkedJourneysById", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Parent Journey instance id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "onlyActive", "in": "query", "description": "If set to `true` return only linked journeys with Active status otherwise it will return everything including Rejected.", "required": true, "schema": { "type": "boolean" } }, { "name": "applicationType", "in": "query", "description": "Name of the initial triggered service", "schema": { "allOf": [ { "$ref": "#/components/schemas/ApplicationTypeDto" } ] } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Linked journey instances are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyInstanceLightDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } } }, "post": { "tags": [ "JourneyInstance" ], "summary": "Get linked journeys by main journey id", "description": "\nReturns a linked journeys for a given id.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetLinkedJourneysByIdV2", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Parent 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" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LinkedJourneysRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Linked journey instances are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedJourneysResponseDtoServiceResponse" } } } }, "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/lifecycle-status/entity/{entityId}": { "get": { "tags": [ "JourneyInstance" ], "summary": "Get lifecycle status of all journey instances by entity id", "description": "\nCalculates and returns the life cycle status for a given entity id and the factors grouped by journey type.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetLifecycleStatusByEntityId", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Journeys lifecycle status is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleStatusSummaryServiceResponse" } } } }, "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/{businessProcessId}": { "get": { "tags": [ "JourneyInstance" ], "summary": "Get launch journey business process", "description": "\nReturns journey launch business process details.

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetLaunchJourneyBusinessProcess", "parameters": [ { "name": "businessProcessId", "in": "path", "description": "Business process id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Journey launch business process details returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaunchJourneyBusinessProcessDtoServiceResponse" } } } }, "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-launch-controls/{id}": { "get": { "tags": [ "JourneyLaunchControls" ], "summary": "Get Journey Launch Controls by Id", "description": "

Required permissions:
Following permissions are required: JourneyLaunchControlsAccess", "operationId": "GetJourneyLaunchControlsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Journey Launch Controls returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyLaunchControlsDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/journey-launch-controls": { "get": { "tags": [ "JourneyLaunchControls" ], "summary": "Get All Journey Launch Controls", "description": "

Required permissions:
Following permissions are required: JourneyLaunchControlsAccess", "operationId": "GetJourneyLaunchControls", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of Journey Launch Controls returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyLaunchControlsListDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/journey-schedule": { "get": { "tags": [ "JourneySchedule" ], "summary": "Get journey Schedules", "description": "\nReturns the list of all journey Schedules.

Required permissions:
Following permissions are required: JourneySchedulerAccess", "operationId": "GetAllJourneySchedules", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of journey Schedules is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyScheduleDtoIEnumerableServiceResponse" } } } }, "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}": { "get": { "tags": [ "JourneySchedule" ], "summary": "Get journey Schedule by id", "description": "\nReturns the active, currently in effect, published version of journey Schedule for a given Schedule id.

Required permissions:
Following permissions are required: JourneySchedulerAccess", "operationId": "GetJourneyScheduleById", "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" } ], "responses": { "200": { "description": "Success. An instance of journey Schedule is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyScheduleVersionDtoServiceResponse" } } } }, "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}": { "get": { "tags": [ "JourneySchedule" ], "summary": "Get journey Schedule by id and version", "description": "\nReturns journey Schedule for a given id and version number.

Required permissions:
Following permissions are required: JourneySchedulerAccess", "operationId": "GetJourneyScheduleVersionById", "parameters": [ { "name": "journeyScheduleId", "in": "path", "description": "Journey Schedule id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Journey Schedule version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Journey Schedule is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyScheduleVersionDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Journey Schedule with given id/version 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-date/search": { "get": { "tags": [ "JourneyScheduleDate" ], "summary": "Search Journey Schedule Date records by the Schedule Date", "description": "\nReturns journey schedule date records for a given date.

Required permissions:
Following permissions are required: JourneySchedulerAccess", "operationId": "GetScheduleDatesByScheduleDate", "parameters": [ { "name": "scheduleDate", "in": "query", "description": "The date the journeys are scheduled for launch e.g. 2019-01-31", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "200": { "description": "Success. The list of journey schedule Dates is returned" }, "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}": { "get": { "tags": [ "JourneyScheduleDate" ], "summary": "Get journey Schedule Date by id", "description": "\nReturns Journey Schedule Date Record for the specified Id

Required permissions:
Following permissions are required: JourneySchedulerAccess", "operationId": "GetJourneyScheduleDateById", "parameters": [ { "name": "journeyScheduleDateId", "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" } ], "responses": { "200": { "description": "Success. An instance of journey Schedule Date is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyScheduleDateDtoServiceResponse" } } } }, "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/lite": { "get": { "tags": [ "JourneySchema" ], "summary": "Get journey schemas (lite)", "description": "\nReturns the list of all journey schemas.\n This is lite endpoint and will not return the definitions of the stages, processes and tasks.

Required permissions:
Following permissions are required: JourneyBuilderAccess", "operationId": "GetAllJourneySchemasLite", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of lite journey schemas is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneySchemaLiteDtoIEnumerableServiceResponse" } } } }, "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}": { "get": { "tags": [ "JourneySchema" ], "summary": "Get journey schema by id", "description": "\nReturns the active, currently in effect, published version of journey schema for a given schema id.

Required permissions:
Following permissions are required: JourneyBuilderAccess", "operationId": "GetJourneySchemaById", "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" } ], "responses": { "200": { "description": "Success. An instance of journey schema is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneySchemaVersionDtoServiceResponse" } } } }, "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}": { "get": { "tags": [ "JourneySchema" ], "summary": "Get journey schema by id and version", "description": "\nReturns journey schema for a given id and version number.

Required permissions:
Following permissions are required: JourneyBuilderAccess", "operationId": "GetJourneySchemaVersionById", "parameters": [ { "name": "journeySchemaId", "in": "path", "description": "Journey schema id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Journey schema version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Journey schema is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneySchemaVersionDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Journey schema with given id/version 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}/export": { "get": { "tags": [ "JourneySchema" ], "summary": "Export journey schema by id and version to a PDF", "description": "\nReturns a PDF export for a journey schema for a given id and version number.

Required permissions:
Following permissions are required: JourneyBuilderAccess", "operationId": "ExportJourneySchemaVersionById", "parameters": [ { "name": "journeySchemaId", "in": "path", "description": "Journey schema id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Journey schema version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Signed S3 URL to Journey schema export is returned. The URL expires after 5m", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneySchemaExportDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Journey schema with given id/version 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/sla-configuration": { "get": { "tags": [ "JourneySlaConfiguration" ], "summary": "Get configuration", "description": "\nReturns configuration.", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The SLA configuration options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetJourneySlaConfigurationResponseDtoServiceResponse" } } } }, "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": { "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers", "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing associated access layers" }, "AddMrAgencyOffboardingTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "AddPartiesToRequestTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "autoManagedRelationshipName": { "type": "boolean" } }, "additionalProperties": false } ] }, "AgencyEtlTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "agencyEtlDataTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "agencyEtlPolicyId": { "type": "string", "nullable": true }, "agencyEtlProductPolicyId": { "type": "string", "nullable": true }, "agencyEtlEntityResolutionSearchQueryFields": { "type": "array", "items": { "$ref": "#/components/schemas/EntityResolutionSearchQueryFieldDto" }, "nullable": true }, "agencyEtlEntityResolutionMatchScoreThreshold": { "type": "number", "format": "double" }, "autoManagedRelationshipName": { "type": "boolean" } }, "additionalProperties": false } ] }, "AgencyRequestDetailsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "managedRelationshipCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataGroupCategoryOrdering": { "type": "boolean" } }, "additionalProperties": false } ] }, "AgentRequestJourneyCheckpointTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "AlertAssessmentTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "isComplianceTask": { "type": "boolean" } }, "additionalProperties": false } ] }, "ApplicationTypeDto": { "enum": [ "JourneyLaunchpad", "RelatedPartyLaunchpad", "OngoingScreeningJourney", "OgsRelatedClientJourneyLaunchpad", "CompleteClientOffboarding", "CompleteClientReOnboarding", "CompleteAgencyOffboarding", "EntityGroupUpdatesLaunchpad", "AgencyUpJourneyLaunchpad", "AgencyAgentJourneyLaunchpad", "ProductJourneyLaunchpad", "ProductRelatedPartyLaunchpad" ], "type": "string", "description": "The types of application" }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AutomatedCreditAssessmentTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "BankAccountsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryOrdering": { "type": "boolean" }, "policyRequirementType": { "type": "string", "nullable": true }, "displayAccessLayers": { "type": "boolean" }, "enforceBankAccountCreation": { "type": "boolean" } }, "additionalProperties": false } ] }, "BlockingTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "BranchableTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "branches": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JourneyTaskDto" }, "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "DataReviewTask": "#/components/schemas/DataReviewTaskDto", "EntityDataConditionTask": "#/components/schemas/EntityDataConditionTaskDto", "IfThenConditionTask": "#/components/schemas/IfThenConditionTaskDto", "RiskAssessConditionPolicy": "#/components/schemas/RiskAssessmentConditionPolicyTaskDto", "RiskAssessmentConditionTask": "#/components/schemas/RiskAssessmentConditionTaskDto", "ScreeningMaterialityAssessmentConditionTask": "#/components/schemas/ScreeningMaterialityAssessmentConditionTaskDto", "ScreeningMaterialityAssessmentConditionTaskOgs": "#/components/schemas/ScreeningMaterialityAssessmentConditionTaskOgsDto", "ConditionTask": "#/components/schemas/TaskConditionalGatewayDto" } } } ] }, "BusinessProcessMessageDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Business process message", "nullable": true, "example": "Error occurred" }, "messageType": { "type": "string", "description": "Type of business process message", "nullable": true, "example": "Error" } }, "additionalProperties": false, "description": "Response DTO representing business process message" }, "CancelInflightJourneysTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ChannelTypeDto": { "enum": [ "Internal", "External", "InternalAndExternal" ], "type": "string" }, "CombinedPolicyTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "policyRequirementTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryOrdering": { "type": "boolean" }, "dataGroupCategoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentPersistence": { "type": "boolean", "nullable": true }, "documentAutoLink": { "type": "boolean", "nullable": true }, "documentTaskVersion": { "type": "integer", "format": "int32", "nullable": true }, "autocompleteDocValidationStatuses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "smartDoc": { "type": "boolean", "nullable": true }, "dataExtractionEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "Condition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true } }, "additionalProperties": false }, "ConditionDefinition": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true }, "isCondition": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "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": { "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": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.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 } }, "additionalProperties": false, "description": "Represents condition root" }, "ConditionalValueDto": { "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": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.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 }, "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 }, "valueId": { "type": "string", "description": "Value Id that should be returned when conditions are met", "nullable": true, "example": "RM" } }, "additionalProperties": false }, "ConflictResolutionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changeDomainsConflictResolution": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hideUnchangedCategories": { "type": "boolean" }, "showCalculatedFieldMessage": { "type": "boolean" }, "productCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "CreateOrLinkCaseTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "CreditAssessmentTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "detailsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "creditAssessmentProductsEnabled": { "type": "boolean" }, "productSummaryGridColumnCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productSummaryGridTotalRow": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "CreditScreeningTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "DataDeletionInformationTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "DataReviewTaskDto": { "allOf": [ { "$ref": "#/components/schemas/BranchableTaskDto" }, { "type": "object", "properties": { "approvalMethod": { "type": "string", "nullable": true }, "outcome": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "policyTarget": { "type": "string", "nullable": true }, "policyCategory": { "type": "string", "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "dataGroupCategoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessSubCategory": { "type": "string", "nullable": true }, "includeReviseOutcome": { "type": "boolean" }, "includeRiskSection": { "type": "boolean" } }, "additionalProperties": false } ] }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DeferredDocRequirementsReviewTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "DocumentAssignmentTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "DocumentDataExtractionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "defaultToExistingValue": { "type": "boolean" } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "DocumentDataExtractionTask": "#/components/schemas/DocumentDataExtractionTaskDto", "DocumentDataExtractionV2Task": "#/components/schemas/DocumentDataExtractionV2TaskDto" } } } ] }, "DocumentDataExtractionV2TaskDto": { "allOf": [ { "$ref": "#/components/schemas/DocumentDataExtractionTaskDto" }, { "type": "object", "properties": { "relatedPartyExtractionEnabled": { "type": "boolean" }, "dataExtractionEnabled": { "type": "boolean" }, "currentJourneyOnly": { "type": "boolean" } }, "additionalProperties": false } ] }, "DocumentTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "policyTarget": { "type": "string", "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentPersistence": { "type": "boolean", "nullable": true }, "documentAutoLink": { "type": "boolean", "nullable": true }, "smartDoc": { "type": "boolean", "nullable": true }, "dataExtractionEnabled": { "type": "boolean", "nullable": true }, "documentRequirementApproval": { "type": "boolean", "nullable": true }, "autocompleteDocValidationStatuses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "DocumentsV2Task": "#/components/schemas/DocumentsV2TaskDto" } } } ] }, "DocumentsV2TaskDto": { "allOf": [ { "$ref": "#/components/schemas/DocumentTaskDto" }, { "type": "object", "properties": { "portalEnrichDocumentMetadataEnabled": { "type": "boolean", "nullable": true }, "portalEnhancedDocsLayoutEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "EntityDataConditionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/TaskConditionalGatewayDto" }, { "type": "object", "properties": { "property": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "EntityGroupManagementTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "bulkEntityManagement": { "type": "boolean", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "EntityJourneyInstanceSearchRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "options": { "allOf": [ { "$ref": "#/components/schemas/PageOptions" } ], "description": "Options for setting up the results page", "nullable": true } }, "additionalProperties": false }, "EntityJourneyInstanceSearchRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityJourneyInstanceSearchRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntityJourneyInstanceSearchResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJourneyInstanceViewModelDto" }, "nullable": true }, "restrictedItems": { "type": "array", "items": { "$ref": "#/components/schemas/RestrictedJourneyInstanceDto" }, "nullable": true }, "nextPaginationToken": { "type": "string", "description": "Token to fetch the next page, or null when there are no more pages. This is the only valid\nsignal that pagination is complete - Items and RestrictedItems can both be empty on a page that\nstill has more pages after it (e.g. a page consisting entirely of access-layer-restricted\njourneys), since filtering happens after a page is fetched from the data store, not before it\nis sized.", "nullable": true } }, "additionalProperties": false }, "EntityJourneyInstanceSearchResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityJourneyInstanceSearchResponseDto" } ], "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" }, "EntityJourneyInstanceViewModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey instance", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "identifier": { "type": "string", "description": "Journey schema short identifier", "nullable": true, "example": "IND_ONB_1" }, "type": { "type": "string", "description": "Journey schema type", "nullable": true, "example": "Client Onboarding" }, "status": { "enum": [ "Not Started", "In Progress", "Done", "Cancelled", "Deleted", "Paused" ], "type": "string", "description": "Journey instance status", "nullable": true, "example": "In Progress" }, "name": { "type": "string", "description": "Journey instance name", "nullable": true, "example": "Individual Client Onboarding" }, "entityDraftId": { "type": "string", "description": "The UiD of the entity draft", "format": "uuid", "example": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0" }, "entityId": { "type": "string", "description": "The UiD of the entity that journey instance belongs to", "format": "uuid", "example": "c698bcee-ca53-481d-a4cd-0bfde137555b" }, "journeySchemaId": { "type": "string", "description": "The UiD of the journey schema", "format": "uuid", "example": "cda1d366-8a7b-4317-af92-10a3aa7c1207" }, "journeySchemaVersionNumber": { "type": "integer", "description": "The VersionNumber of the journey schema", "format": "int32", "nullable": true, "example": 1 }, "applicationId": { "type": "string", "description": "The UiD of the grouped journeys", "format": "uuid", "nullable": true, "example": "45D738A5-0F06-4111-BDBF-B7E924FC5D9A" }, "applicationType": { "allOf": [ { "$ref": "#/components/schemas/ApplicationTypeDto" } ], "description": "Type of the service that triggered the application", "nullable": true, "example": "JourneyLaunchpad" }, "applicationStatus": { "enum": [ "Active", "Rejected" ], "type": "string", "description": "Status of the journey from specific application", "nullable": true, "example": "Active" }, "started": { "type": "string", "description": "Journey instance start date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "cancelled": { "type": "string", "description": "Journey instance cancelled date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "lastUpdatedBy": { "type": "string", "description": "Journey instance last updated by", "nullable": true, "example": "Test User" }, "cancelledBy": { "type": "string", "description": "Journey instance cancelled by", "nullable": true, "example": "Test User" }, "completed": { "type": "string", "description": "Journey instance completed date", "format": "date-time", "nullable": true, "example": "2021-03-05T14:48:00.000Z" }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Collection of jurisdictions this journey operates on", "nullable": true }, "cancellationReason": { "type": "string", "description": "Reason of journey cancelation", "nullable": true, "example": "Reason" }, "cancelationComment": { "type": "string", "description": "Comments to journey cancelation", "nullable": true, "example": "Reason" }, "journeyOwner": { "allOf": [ { "$ref": "#/components/schemas/JourneyOwnerDto" } ], "description": "Journey Owner", "nullable": true }, "customStatus": { "type": "string", "description": "Journey Instance custom status", "nullable": true, "example": "JourneyOnboarding" }, "stats": { "allOf": [ { "$ref": "#/components/schemas/JourneyStatsDto" } ], "description": "Journey instance task completion statistics", "nullable": true }, "serviceLevelAgreement": { "allOf": [ { "$ref": "#/components/schemas/JourneyInstanceServiceLevelAgreementDto" } ], "description": "Journey instance Service Level Agreement", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Journey instance access layers determining the access to the entity", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access this journey instance" } }, "additionalProperties": false, "description": "Response DTO representing journey instance data for a specific entity, without Stages object" }, "EntityJourneyInstanceViewModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityJourneyInstanceViewModelDto" }, "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" }, "EntityResolutionSearchQueryFieldDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EvaluateReviewDatesTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ExpectedActivityTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ExternalDataAggregationTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "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 }, "ExternalDataDocsCollectionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "documentCollectionProviderIds": { "type": "array", "items": { "type": "string" }, "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 }, "ExternalDataTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ExternalDataV2TaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "externalDataProviderIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalDataAutomaticSearchProviderIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalDataAutomaticProfileDownloadIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalDataAutomaticImportProviderIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalDataAutomaticCompleteTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalDataRelatedPartiesAutomationIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalDataAutomaticUboDiscovery": { "type": "boolean" }, "externalDataIgnoreDuplicates": { "type": "boolean" }, "externalDataAutoImportOptimizationEnabled": { "type": "boolean" } }, "additionalProperties": false } ] }, "FinalIsdaAmendSearchTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "FinancialAnalysisImportTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "FinancialAnalysisTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scenarioCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "summaryCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allocationsEnabled": { "type": "boolean" }, "persistManualDataEnabled": { "type": "boolean" }, "targetEntities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "associationScopingCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "financialAnalysisProductSummary": { "type": "boolean" }, "financialAnalysisCustomTaskProviderEnabled": { "type": "boolean" }, "financialAnalysisCustomTaskProviderId": { "type": "string", "nullable": true }, "financialAnalysisCustomTaskButtonLabel": { "type": "string", "nullable": true }, "jointFinancialAnalysisEnabled": { "type": "boolean" }, "financialAnalysisAutoSaveEnabled": { "type": "boolean" }, "financialAnalysisDataVisualisationEnabled": { "type": "boolean" }, "financialAnalysisMultiAdjustmentsEnabled": { "type": "boolean" }, "productSummaryGridColumnCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productSummaryGridTotalRow": { "type": "boolean", "nullable": true }, "financialAnalysisDeferAbilityEnabled": { "type": "boolean" } }, "additionalProperties": false } ] }, "FinancialCrimeReportTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryOrdering": { "type": "boolean" }, "policyRequirementType": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "GetJourneyConfigurationResponseDto": { "type": "object", "properties": { "isCancellationCommentMandatory": { "type": "boolean", "description": "Flag indicating if inheritance is enabled or disabled" }, "enableSlaEventNotifications": { "type": "boolean", "description": "Flag indicating if SLA event notifications are enabled or disabled" }, "restrictTaskReopenToAssignedTeam": { "type": "boolean", "description": "Flag indicating if task reopening is restricted to users in the task's assigned team" }, "isCancellationReasonMandatory": { "type": "boolean", "description": "Flag indicating if journey cancellation reason is mandatory" }, "isReassignCommentMandatory": { "type": "boolean", "description": "Flag indicating if reassign-task comment is mandatory" }, "isReopenReasonEnabled": { "type": "boolean", "description": "Flag indicating if the reopen-reason dropdown is enabled" }, "isReopenReasonMandatory": { "type": "boolean", "description": "Flag indicating if the reopen-reason dropdown selection is mandatory" }, "validateExistingReferenceDataValues": { "type": "boolean", "description": "Flag indicating if existing reference data values should be validated on load" } }, "additionalProperties": false, "description": "Request DTO representing current related party access layers inheritance configuration data" }, "GetJourneyConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneyConfigurationResponseDto" } ], "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" }, "GetJourneySlaConfigurationResponseDto": { "type": "object", "properties": { "workingDays": { "type": "array", "items": { "type": "string" }, "description": "List of working days of the week (e.g. Monday–Friday)", "nullable": true }, "referenceTimezone": { "type": "string", "description": "Reference timezone used for SLA calculations (e.g. \"UTC\", \"Europe/Dublin\")", "nullable": true } }, "additionalProperties": false }, "GetJourneySlaConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetJourneySlaConfigurationResponseDto" } ], "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" }, "GroupTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "subTasks": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "nullable": true } }, "additionalProperties": false } ] }, "HierarchyCaptureTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyRequirementTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataGroupSearchScope": { "type": "array", "items": { "type": "string" }, "nullable": true }, "unwrappingPolicyCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relatedPartyScopingRuleSet": { "type": "string", "nullable": true }, "relatedPartiesSearchEntitiesInGroupEnabled": { "type": "boolean" }, "autoExtractionEnabled": { "type": "boolean" }, "searchExcludeClientEntities": { "type": "boolean" }, "documentPersistence": { "type": "boolean", "nullable": true }, "documentAutoLink": { "type": "boolean", "nullable": true }, "externalDataConfiguration": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataConfigurationsDto" } ], "nullable": true } }, "additionalProperties": false } ] }, "IfThenConditionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/TaskConditionalGatewayDto" }, { "type": "object", "properties": { "property": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "IndividualIdvLivenessTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "regulaConfigurationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } ] }, "IndividualIdvReviewTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "IndividualIdvTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "IntegrationsDataPublishTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "integrationPipelineId": { "type": "string", "nullable": true }, "integrationSkipOnRerun": { "type": "boolean" } }, "additionalProperties": false } ] }, "InvestmentAccountsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryOrdering": { "type": "boolean" }, "policyRequirementType": { "type": "string", "nullable": true }, "fundSearchCategory": { "type": "string", "nullable": true }, "initialCreationCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enableLinkProduct": { "type": "boolean" }, "enableLinkBankAccount": { "type": "boolean" }, "enableOffboarding": { "type": "boolean" }, "enableDefaultInvestmentAccountName": { "type": "boolean" }, "validateMissingRequirements": { "type": "boolean" }, "displayAccessLayers": { "type": "boolean" }, "enableBankAccountPurpose": { "type": "boolean" }, "updateInvestmentAccountNamesOnVerification": { "type": "boolean" }, "displayPortalDocumentRequirements": { "type": "boolean" }, "documentPersistence": { "type": "boolean" }, "enforceInvestmentAccountCreation": { "type": "boolean" }, "enableStatusFiltering": { "type": "boolean" }, "brandFilterEnabled": { "type": "boolean" }, "brandDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "IsdaAmendOngoingUpdatesTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "IsdaAmendSearchTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "isdaActiveProtocols": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "JourneyInstanceDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey instance", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "entityDraftId": { "type": "string", "description": "The UiD of the entity draft", "format": "uuid", "example": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0" }, "entityId": { "type": "string", "description": "The UiD of the entity that journey instance belongs to", "format": "uuid", "example": "c698bcee-ca53-481d-a4cd-0bfde137555b" }, "journeySchemaId": { "type": "string", "description": "The UiD of the journey schema", "format": "uuid", "example": "cda1d366-8a7b-4317-af92-10a3aa7c1207" }, "journeySchemaVersionNumber": { "type": "integer", "description": "The VersionNumber of the journey schema", "format": "int32", "nullable": true, "example": 1 }, "applicationId": { "type": "string", "description": "The UiD of the grouped journeys", "format": "uuid", "nullable": true, "example": "45D738A5-0F06-4111-BDBF-B7E924FC5D9A" }, "applicationStatus": { "enum": [ "Active", "Rejected" ], "type": "string", "description": "Status of the journey from specific application", "nullable": true, "example": "Active" }, "applicationType": { "allOf": [ { "$ref": "#/components/schemas/ApplicationTypeDto" } ], "description": "Type of the service that triggered the application", "nullable": true, "example": "JourneyLaunchpad" }, "started": { "type": "string", "description": "Journey instance start date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "cancelled": { "type": "string", "description": "Journey instance cancelled date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "lastUpdatedBy": { "type": "string", "description": "Journey instance last updated by", "nullable": true, "example": "Test User" }, "cancelledBy": { "type": "string", "description": "Journey instance cancelled by", "nullable": true, "example": "Test User" }, "completed": { "type": "string", "description": "Journey instance completed date", "format": "date-time", "nullable": true, "example": "2021-03-05T14:48:00.000Z" }, "identifier": { "type": "string", "description": "Journey schema short identifier", "nullable": true, "example": "IND_ONB_1" }, "type": { "type": "string", "description": "Journey schema type", "nullable": true, "example": "Client Onboarding" }, "status": { "enum": [ "Not Started", "In Progress", "Done", "Cancelled", "Deleted", "Paused" ], "type": "string", "description": "Journey instance status", "nullable": true, "example": "In Progress" }, "name": { "type": "string", "description": "Journey instance name", "nullable": true, "example": "Individual Client Onboarding" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Journey instance access layers determining the access to the entity", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access this journey instance" }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Collection of jurisdictions this journey operates on", "nullable": true }, "cancellationReason": { "type": "string", "description": "Reason of journey cancelation", "nullable": true, "example": "Reason" }, "cancelationComment": { "type": "string", "description": "Comments to journey cancelation", "nullable": true, "example": "Reason" }, "journeyOwner": { "allOf": [ { "$ref": "#/components/schemas/JourneyOwnerDto" } ], "description": "Journey Owner", "nullable": true }, "customStatus": { "type": "string", "description": "Journey Instance custom status", "nullable": true, "example": "JourneyOnboarding" }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyInstanceStageDto" }, "description": "List of journey instance stages", "nullable": true }, "userTaskPermissions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UserTaskPermissionsDto" }, "description": "Per-task permissions for the current user, keyed by task id.\nEach entry carries a Fenergo.Nebula.Journey.Query.Application.Dto.PermissionDto per action (e.g. `canReopen`)\nwith a `permitted` flag and a human-readable `reason` tooltip.\nOnly emitted when at least one task has a denied permission; otherwise omitted.", "nullable": true }, "milestones": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyInstanceMilestoneDto" }, "description": "List of Journey Milestones", "nullable": true }, "serviceLevelAgreement": { "allOf": [ { "$ref": "#/components/schemas/ServiceLevelAgreementDto" } ], "description": "Journey Service Level Agreement", "nullable": true }, "stats": { "allOf": [ { "$ref": "#/components/schemas/JourneyStatsDto" } ], "description": "Represents progress of current stage", "nullable": true }, "version": { "type": "integer", "description": "Version of JourneyInstance", "format": "int32", "example": 1 }, "deleted": { "type": "string", "description": "Journey instance deletion date", "format": "date-time", "nullable": true, "example": "2021-03-05T14:48:00.000Z" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/JourneyMetadataDto" } ], "description": "Metadata of Journey Instance", "nullable": true }, "pauseComment": { "type": "string", "description": "Journey Instance pause action comment", "nullable": true, "example": "Pause comment" }, "pauseReason": { "type": "string", "description": "Journey Instance pause action reason", "nullable": true, "example": "Reopen comment" }, "pausedBy": { "type": "string", "description": "Journey Instance paused by information", "nullable": true, "example": "User" }, "paused": { "type": "string", "description": "Journey Instance paused date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "unpausedBy": { "type": "string", "description": "Journey Instance unpaused by information", "nullable": true, "example": "User" }, "unpaused": { "type": "string", "description": "Journey Instance unpaused date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "originSource": { "allOf": [ { "$ref": "#/components/schemas/OriginSource" } ], "description": "The Source that triggered the journey instance creation", "example": "JourneyLaunchpad" }, "originReferenceId": { "type": "string", "description": "The UiD of the origin source that triggered the journey", "format": "uuid", "nullable": true, "example": "JourneyLaunchpad" }, "areReopenCommentsOptional": { "type": "boolean", "description": "If true then comments are non-mandatory. If false then comments are mandatory.", "example": true }, "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelTypeDto" } ], "description": "Channel type describing whether journeys will be initiated by internal teams (Internal) or external customers\nthrough Portal (External)\n\nMight be null for older journey instances that were created before this property was introduced", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing all journey instance data" }, "JourneyInstanceDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneyInstanceDto" } ], "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" }, "JourneyInstanceLightDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey instance", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "entityDraftId": { "type": "string", "description": "The UiD of the entity draft", "format": "uuid", "example": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0" }, "entityId": { "type": "string", "description": "The UiD of the entity that journey instance belongs to", "format": "uuid", "example": "c698bcee-ca53-481d-a4cd-0bfde137555b" }, "journeySchemaId": { "type": "string", "description": "The UiD of the journey schema", "format": "uuid", "example": "cda1d366-8a7b-4317-af92-10a3aa7c1207" }, "journeySchemaVersionNumber": { "type": "integer", "description": "The VersionNumber of the journey schema", "format": "int32", "nullable": true, "example": 1 }, "applicationId": { "type": "string", "description": "The UiD of the grouped journeys", "format": "uuid", "nullable": true, "example": "45D738A5-0F06-4111-BDBF-B7E924FC5D9A" }, "applicationStatus": { "enum": [ "Active", "Rejected" ], "type": "string", "description": "Status of the journey from specific application", "nullable": true, "example": "Active" }, "applicationType": { "allOf": [ { "$ref": "#/components/schemas/ApplicationTypeDto" } ], "description": "Type of the service that triggered the application", "nullable": true, "example": "JourneyLaunchpad" }, "started": { "type": "string", "description": "Journey instance start date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "cancelled": { "type": "string", "description": "Journey instance cancelled date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "lastUpdatedBy": { "type": "string", "description": "Journey instance last updated by", "nullable": true, "example": "Test User" }, "cancelledBy": { "type": "string", "description": "Journey instance cancelled by", "nullable": true, "example": "Test User" }, "completed": { "type": "string", "description": "Journey instance completed date", "format": "date-time", "nullable": true, "example": "2021-03-05T14:48:00.000Z" }, "identifier": { "type": "string", "description": "Journey schema short identifier", "nullable": true, "example": "IND_ONB_1" }, "type": { "type": "string", "description": "Journey schema type", "nullable": true, "example": "Client Onboarding" }, "status": { "enum": [ "Not Started", "In Progress", "Done", "Cancelled", "Deleted", "Paused" ], "type": "string", "description": "Journey instance status", "nullable": true, "example": "In Progress" }, "name": { "type": "string", "description": "Journey instance name", "nullable": true, "example": "Individual Client Onboarding" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Journey instance access layers determining the access to the entity", "nullable": true }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access this journey instance" }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Collection of jurisdictions this journey operates on", "nullable": true }, "cancellationReason": { "type": "string", "description": "Reason of journey cancelation", "nullable": true, "example": "Reason" }, "cancelationComment": { "type": "string", "description": "Comments to journey cancelation", "nullable": true, "example": "Reason" }, "journeyOwner": { "allOf": [ { "$ref": "#/components/schemas/JourneyOwnerDto" } ], "description": "Journey Owner", "nullable": true }, "customStatus": { "type": "string", "description": "Journey Instance custom status", "nullable": true, "example": "JourneyOnboarding" } }, "additionalProperties": false, "description": "Response DTO representing journey instance data without Stages object" }, "JourneyInstanceLightDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyInstanceLightDto" }, "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" }, "JourneyInstanceMilestoneDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Journey Milestone", "format": "uuid", "example": "24511767-4586-4b69-af43-c405ec6b154a" }, "name": { "type": "string", "description": "Journey Milestone name", "nullable": true, "example": "New Request" }, "description": { "type": "string", "description": "Journey Milestone description", "nullable": true, "example": "New Request Milestone" }, "status": { "enum": [ "Not Started", "In Progress", "Done", "Cancelled", "Skipped" ], "type": "string", "description": "Journey Milestone status", "nullable": true, "example": "In Progress" }, "order": { "type": "integer", "description": "Journey Milestone order", "format": "int32", "example": 1 }, "stages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of Journey Milestone's stages", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Journey Milestone" }, "JourneyInstanceProcessDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the process", "format": "uuid", "example": "3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37" }, "schemaProcessId": { "type": "string", "description": "The UiD of the journey schema process", "format": "uuid", "nullable": true, "example": "8ddb2270-63dc-48fc-b6d5-cf94f386f73f" }, "name": { "type": "string", "description": "Process name", "nullable": true, "example": "New Request" }, "description": { "type": "string", "description": "Process description", "nullable": true, "example": "New Request Process" }, "status": { "enum": [ "Not Started", "In Evaluation", "Skipped", "In Progress", "Done", "Cancelled", "Descoped" ], "type": "string", "description": "Process status", "nullable": true, "example": "In Progress" }, "order": { "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": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "description": "List of process tasks", "nullable": true }, "started": { "type": "string", "description": "Process started date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "completed": { "type": "string", "description": "Process completed date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "List of conditions required to trigger process", "nullable": true }, "isConditional": { "type": "boolean", "description": "True if the process contains conditions, false otherwise", "example": false }, "isCompleted": { "type": "boolean", "description": "True if the process is completed, false otherwise", "example": false }, "isSkipped": { "type": "boolean", "description": "True if the process is skipped, false otherwise", "example": false }, "isHidden": { "type": "boolean", "description": "If true, the process and its contents should not be rendered", "example": false } }, "additionalProperties": false, "description": "Journey Instance Process metadata" }, "JourneyInstanceServiceLevelAgreementDto": { "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 }, "dueDate": { "type": "string", "description": "Due Date - calculated date by which Journey/Stage/Task is expected to be completed", "format": "date-time", "nullable": true }, "approachingDueHours": { "type": "integer", "description": "Approaching Due Hours - sets the amount of time when the SLA status change to ‘Approaching Due’", "format": "int32", "nullable": true }, "approachingDueDate": { "type": "string", "description": "Approaching Due Date - calculated date after which the SLA status change to ‘Approaching Due’", "format": "date-time", "nullable": true }, "status": { "enum": [ "Not Started", "In Progress", "Approaching Due", "Completed", "Completed Overdue", "Overdue", "In Evaluation", "Paused", "Error" ], "type": "string", "description": "Status of Service Level Agreement", "nullable": true }, "duePeriod": { "type": "string", "description": "Due Period of Service Level Agreement", "nullable": true }, "pausedPeriodSec": { "type": "integer", "description": "Total time in seconds when Journey/Stage/Task was paused", "format": "int32", "nullable": true }, "defaultCommittedHours": { "type": "integer", "description": "Committed Hours - sets the default amount of time a user has to complete a Journey/Stage/Task", "format": "int32", "nullable": true }, "defaultApproachingDueHours": { "type": "integer", "description": "Approaching Due Hours - sets the default amount of time when the SLA status change to ‘Approaching Due’", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing Service Level Agreement of a Journey/Stage/Task, omits Conditions property." }, "JourneyInstanceStageDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the stage", "format": "uuid", "example": "24511767-4586-4b69-af43-c405ec6b154a" }, "schemaStageId": { "type": "string", "description": "The UiD of the journey schema stage", "format": "uuid", "nullable": true }, "dataKey": { "type": "string", "description": "Stage Datakey", "nullable": true, "example": "NewRequestStageDataKey" }, "name": { "type": "string", "description": "Stage name", "nullable": true, "example": "New Request" }, "description": { "type": "string", "description": "Stage description", "nullable": true, "example": "New Request Stage" }, "status": { "enum": [ "Not Started", "In Evaluation", "Skipped", "In Progress", "Done", "Cancelled", "Descoped", "Paused" ], "type": "string", "description": "Stage status", "nullable": true, "example": "In Progress" }, "order": { "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": { "type": "string" }, "description": "The list of IDs of the assigned portal roles", "nullable": true }, "started": { "type": "string", "description": "Stage started date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "completed": { "type": "string", "description": "Stage completed date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "processes": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyInstanceProcessDto" }, "description": "List of stage processes", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "List of conditions required to trigger stage", "nullable": true }, "isConditional": { "type": "boolean", "description": "True if the stage contains conditions, false otherwise", "example": false }, "isHidden": { "type": "boolean", "description": "If true, the stage and its contents should not be rendered", "example": false }, "stats": { "allOf": [ { "$ref": "#/components/schemas/JourneyStatsDto" } ], "description": "Represents progress of current stage", "nullable": true }, "serviceLevelAgreement": { "allOf": [ { "$ref": "#/components/schemas/ServiceLevelAgreementDto" } ], "description": "Stage Service Level Agreement", "nullable": true }, "pauseComment": { "type": "string", "description": "Stage pause action comment", "nullable": true, "example": "Reassign comment" }, "pauseReason": { "type": "string", "description": "Stage pause action reason", "nullable": true, "example": "Reopen comment" }, "pausedBy": { "type": "string", "description": "Stage paused by information", "nullable": true, "example": "User" }, "paused": { "type": "string", "description": "Stage paused date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "unpausedBy": { "type": "string", "description": "Stage unpaused by information", "nullable": true, "example": "User" }, "unpaused": { "type": "string", "description": "Stage unpaused date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" } }, "additionalProperties": false, "description": "Journey Instance Stage metadata" }, "JourneyLaunchControlsDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey launch controls", "format": "uuid" }, "journeyType": { "type": "string", "description": "The journey type for journey launch controls", "nullable": true }, "description": { "type": "string", "description": "The journey description for journey launch controls", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Logic engine conditions for journey launch controls", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing journey launch controls data" }, "JourneyLaunchControlsDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneyLaunchControlsDto" } ], "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" }, "JourneyLaunchControlsListDto": { "type": "object", "properties": { "journeyLaunchControls": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyLaunchControlsDto" }, "description": "List of Journey Launch Controls", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing list of journey launch controls data" }, "JourneyLaunchControlsListDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneyLaunchControlsListDto" } ], "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" }, "JourneyLifecycleStatus": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "The UiD of the journey instance", "format": "uuid", "example": "3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37" }, "status": { "type": "string", "description": "Status of the journey instance", "nullable": true, "example": "In Progress" }, "name": { "type": "string", "description": "Name of the journey instance", "nullable": true }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Jurisdictions given journey operates on", "nullable": true } }, "additionalProperties": false, "description": "Single Journey Instance overview" }, "JourneyMetadataDto": { "type": "object", "properties": { "sourceEventId": { "type": "string", "description": "Id of a journey trigger source event", "format": "uuid", "nullable": true }, "transactionId": { "type": "string", "description": "External Id of the TransactionMonitoring event", "nullable": true } }, "additionalProperties": false, "description": "DTO representing journey metadata" }, "JourneyOwnerDto": { "type": "object", "properties": { "teamId": { "type": "string", "description": "The UiD of Journey Owner team", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "ownerId": { "type": "string", "description": "The UiD of Journey Owner", "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 }, "JourneyScheduleDateDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey Schedule Date", "format": "uuid", "example": "622d97e9-53d7-4df9-8bb3-ddf79774c519" }, "entityId": { "type": "string", "description": "The UiD of the Entity the journey is scheduled for", "format": "uuid", "example": "fa10b15a-bee2-482e-9a23-9a991d0f5462" }, "journeyScheduleId": { "type": "string", "description": "The UiD of the Journey Schedule this date is being set for", "format": "uuid", "example": "528160c5-ea3c-4653-a5e2-84fd671d02f0" }, "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 this was manually created by a user", "example": true }, "comment": { "type": "string", "description": "The reason for which the journey is scheduled", "nullable": true, "example": "Created by system scheduled job." }, "type": { "type": "string", "description": "The type of Journey that will be launched", "nullable": true, "example": "Client Onboarding" } }, "additionalProperties": false, "description": "Response DTO representing journey Schedule date 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": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey Schedule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyScheduleVersionDto" }, "description": "Versions associated to the journey Schedule", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing journey Schedule data" }, "JourneyScheduleDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$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" }, "JourneyScheduleVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey Schedule version", "format": "uuid", "example": "228313c6-91e6-4b05-a537-5a1ab906418f" }, "journeyScheduleId": { "type": "string", "description": "The UiD of the journey Schedule that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Display name of journey Schedule", "nullable": true, "example": "Individual Client Onboarding" }, "type": { "type": "string", "description": "Journey Schedule 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" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)", "example": true }, "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": "Version number for given Aggregate (concurrency check)", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing journey Schedule version data" }, "JourneyScheduleVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneyScheduleVersionDto" } ], "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" }, "JourneySchemaExportDto": { "type": "object", "properties": { "signedUrl": { "type": "string", "nullable": true }, "validUntil": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JourneySchemaExportDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneySchemaExportDto" } ], "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" }, "JourneySchemaLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey schema", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/JourneySchemaLiteVersionDto" }, "description": "Versions associated to the journey schema", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false }, "JourneySchemaLiteDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JourneySchemaLiteDto" }, "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" }, "JourneySchemaLiteVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey schema version", "format": "uuid", "example": "228313c6-91e6-4b05-a537-5a1ab906418f" }, "journeySchemaId": { "type": "string", "description": "The UiD of the journey schema that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Display name of journey schema", "nullable": true, "example": "Individual Client Onboarding" }, "identifier": { "type": "string", "description": "Short identifier of journey schema", "nullable": true, "example": "IND_ONB_1" }, "type": { "type": "string", "description": "Journey schema type", "nullable": true, "example": "Client Onboarding" }, "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" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)", "example": 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)\n\n" }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "nullable": true, "example": 1 }, "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" }, "areReopenCommentsOptional": { "type": "boolean", "description": "If true then comments are non-mandatory. If false then comments are mandatory.", "example": true } }, "additionalProperties": false }, "JourneySchemaMilestoneDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the Journey Milestone", "format": "uuid", "example": "24511767-4586-4b69-af43-c405ec6b154a" }, "name": { "type": "string", "description": "Journey Milestone name", "nullable": true, "example": "New Request" }, "description": { "type": "string", "description": "Journey Milestone description", "nullable": true, "example": "New Request Milestone" }, "order": { "type": "integer", "description": "Journey Milestone order", "format": "int32", "example": 1 }, "stages": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of Journey Milestone's stages", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Journey Milestone" }, "JourneySchemaProcessDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the process", "format": "uuid", "example": "3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37" }, "name": { "type": "string", "description": "Process name", "nullable": true, "example": "New Request" }, "description": { "type": "string", "description": "Process description", "nullable": true, "example": "New Request Process" }, "order": { "type": "integer", "description": "Process order", "format": "int32", "example": 1 }, "tasksCompletionOrder": { "type": "string", "description": "Determines the order of completing tasks. Defaults to Sequential.\nOne of Sequential, AnyOrder", "nullable": true, "example": "Sequential" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "description": "List of process tasks", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "List of conditions required to trigger process", "nullable": true }, "isConditional": { "type": "boolean", "description": "True if the process contains conditions, false otherwise", "example": false } }, "additionalProperties": false, "description": "Journey Schema Process metadata" }, "JourneySchemaStageDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the stage", "format": "uuid", "example": "24511767-4586-4b69-af43-c405ec6b154a" }, "name": { "type": "string", "description": "Stage name", "nullable": true, "example": "New Request" }, "dataKey": { "type": "string", "description": "Stage Datakey", "nullable": true, "example": "NewRequestStageDataKey" }, "description": { "type": "string", "description": "Stage description", "nullable": true, "example": "New Request Stage" }, "order": { "type": "integer", "description": "Stage order", "format": "int32", "example": 1 }, "processesCompletionOrder": { "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": { "type": "string" }, "description": "The list of IDs of the assigned portal roles", "nullable": true }, "processes": { "type": "array", "items": { "$ref": "#/components/schemas/JourneySchemaProcessDto" }, "description": "List of stage processes", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "description": "List of conditions required to trigger stage", "nullable": true }, "isConditional": { "type": "boolean", "description": "True if the stage contains conditions, false otherwise", "example": false }, "serviceLevelAgreement": { "allOf": [ { "$ref": "#/components/schemas/SchemaServiceLevelAgreementDto" } ], "description": "Stage Service Level Agreement", "nullable": true } }, "additionalProperties": false, "description": "Journey Schema Stage metadata" }, "JourneySchemaVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey schema version", "format": "uuid", "example": "228313c6-91e6-4b05-a537-5a1ab906418f" }, "journeySchemaId": { "type": "string", "description": "The UiD of the journey schema that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Display name of journey schema", "nullable": true, "example": "Individual Client Onboarding" }, "identifier": { "type": "string", "description": "Short identifier of journey schema", "nullable": true, "example": "IND_ONB_1" }, "type": { "type": "string", "description": "Journey schema type", "nullable": true, "example": "Client Onboarding" }, "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" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)", "example": 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)\n\n" }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "nullable": true, "example": 1 }, "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" }, "areReopenCommentsOptional": { "type": "boolean", "description": "If true then comments are non-mandatory. If false then comments are mandatory.", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/JourneySchemaStageDto" }, "description": "Collection of stages defining journey", "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/JourneySchemaMilestoneDto" }, "description": "List of Journey Schema Milestones", "nullable": true }, "serviceLevelAgreement": { "allOf": [ { "$ref": "#/components/schemas/SchemaServiceLevelAgreementDto" } ], "description": "Journey Schema Service Level Agreement", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing journey schema version data" }, "JourneySchemaVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneySchemaVersionDto" } ], "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" }, "JourneyStatsDto": { "type": "object", "properties": { "completed": { "type": "integer", "description": "Number of completed tasks", "format": "int32", "example": 12 }, "total": { "type": "integer", "description": "Number of total (visible) tasks", "format": "int32", "example": 24 }, "progress": { "type": "number", "description": "Progress in percents", "format": "float", "example": 50 } }, "additionalProperties": false, "description": "Represents the progress of journey instance or stage" }, "JourneyTaskDto": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "description": "The UiD of the task", "format": "uuid", "example": "c5207c1d-5242-4c28-b16f-ac028e2bfdfd" }, "schemaTaskId": { "type": "string", "description": "The UiD of the journey schema task", "format": "uuid", "nullable": true, "example": "982e3f33-8264-4188-94bb-3351a3df2ca4" }, "name": { "type": "string", "description": "Task name", "nullable": true, "example": "Capture Basic Details" }, "taskKey": { "type": "string", "description": "Task key", "nullable": true, "example": "CaptureBasicDetailsTaskKey" }, "description": { "type": "string", "description": "Task description", "nullable": true, "example": "Capture Basic Details task" }, "status": { "enum": [ "Not Started", "In Evaluation", "Skipped", "In Progress", "Done", "Cancelled", "Error", "Preprocessing", "Descoped", "Paused" ], "type": "string", "description": "Task status", "nullable": true, "example": "In Progress" }, "order": { "type": "integer", "description": "Task order", "format": "int32", "example": 1 }, "taskType": { "type": "string", "description": "Task type", "nullable": true, "example": "PolicyTask" }, "assignedTo": { "type": "string", "description": "Task assigned to information", "nullable": true, "example": "User" }, "reassignedBy": { "type": "string", "description": "Task reassigned by information", "nullable": true, "example": "User" }, "reopenedBy": { "type": "string", "description": "Task reopened by information", "nullable": true, "example": "User" }, "reassignComment": { "type": "string", "description": "Task reassign action comment", "nullable": true, "example": "Reassign comment" }, "reopened": { "type": "string", "description": "Task last reopened date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "isReopened": { "type": "boolean", "description": "Task indication it has been Reopened", "example": true }, "reopenComment": { "type": "string", "description": "Task reopen action comment", "nullable": true, "example": "Reopen comment" }, "reopenReason": { "type": "string", "description": "Task reopen action reason, selected from the lookup list", "nullable": true }, "pauseComment": { "type": "string", "description": "Task pause action comment", "nullable": true, "example": "Reassign comment" }, "pauseReason": { "type": "string", "description": "Task pause action reason", "nullable": true, "example": "Reopen comment" }, "pausedBy": { "type": "string", "description": "Task paused by information", "nullable": true, "example": "User" }, "unpausedBy": { "type": "string", "description": "Task unpaused by information", "nullable": true, "example": "User" }, "paused": { "type": "string", "description": "Task paused date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "unpaused": { "type": "string", "description": "Task unpaused date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "started": { "type": "string", "description": "Task started date", "format": "date-time", "nullable": true, "example": "2021-01-05T14:48:00.000Z" }, "completed": { "type": "string", "description": "Task completed date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "descoped": { "type": "string", "description": "Task descope date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "cancelled": { "type": "string", "description": "Task cancelled date", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "completedBy": { "type": "string", "description": "Task completed by information", "nullable": true, "example": "User" }, "completedByHistory": { "type": "array", "items": { "type": "string" }, "description": "All users who have completed this task across all rounds", "nullable": true }, "teamId": { "type": "string", "description": "The UiD of the team", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "defaultTeamId": { "type": "string", "description": "The UiD of the default team", "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 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "List of conditions required to trigger task", "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 }, "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 }, "isBranchedTask": { "type": "boolean", "description": "Flag indicates that is a branched task created from conditional task", "example": 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 }, "readOnly": { "type": "boolean", "description": "If true, the task content will be rendered in read only mode", "example": false }, "isHidden": { "type": "boolean", "description": "If true, the process and its contents should not be rendered", "example": false }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/TaskMessageDto" }, "description": "Task Messages that provide info or some description about either passed or failed task", "nullable": true }, "autocomplete": { "type": "boolean" }, "agentAutonomy": { "type": "string", "nullable": true }, "disableAgent": { "type": "boolean", "nullable": true }, "bulkCompletionEnabled": { "type": "boolean", "nullable": true }, "autocompleteConditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "autocompleteStatus": { "type": "string", "nullable": true }, "progressSource": { "type": "string", "description": "Backend-owned discriminator naming the source that exposes live autocomplete\nprogress for this task (e.g. \"relatedParties\"), or null when the task has no\nprogress source. Lets the UI poll the right service and poll nothing otherwise.", "nullable": true }, "isCompleted": { "type": "boolean", "deprecated": true }, "isPreprocessing": { "type": "boolean", "deprecated": true }, "isSkipped": { "type": "boolean", "deprecated": true }, "isInEvaluation": { "type": "boolean", "deprecated": true }, "isDescoped": { "type": "boolean", "deprecated": true }, "isConditional": { "type": "boolean", "deprecated": true }, "isInProgressOrPaused": { "type": "boolean", "deprecated": true } }, "additionalProperties": false, "description": "Journey Task metadata", "discriminator": { "propertyName": "discriminator", "mapping": { "AddMrAgencyOffboardingTask": "#/components/schemas/AddMrAgencyOffboardingTaskDto", "AddPartiesToRequestTask": "#/components/schemas/AddPartiesToRequestTaskDto", "AgencyEtlTask": "#/components/schemas/AgencyEtlTaskDto", "AgencyRequestDetailsTask": "#/components/schemas/AgencyRequestDetailsTaskDto", "AgentRequestJourneyCheckpointTask": "#/components/schemas/AgentRequestJourneyCheckpointTaskDto", "AlertAssessmentTask": "#/components/schemas/AlertAssessmentTaskDto", "AutomatedCreditAssessmentTask": "#/components/schemas/AutomatedCreditAssessmentTaskDto", "BankAccountsTask": "#/components/schemas/BankAccountsTaskDto", "BlockingTask": "#/components/schemas/BlockingTaskDto", "BranchableTask": "#/components/schemas/BranchableTaskDto", "CancelInflightJourneysTask": "#/components/schemas/CancelInflightJourneysTaskDto", "CombinedPolicyTask": "#/components/schemas/CombinedPolicyTaskDto", "ConflictResolutionTask": "#/components/schemas/ConflictResolutionTaskDto", "CreateOrLinkCaseTask": "#/components/schemas/CreateOrLinkCaseTaskDto", "CreditAssessmentTask": "#/components/schemas/CreditAssessmentTaskDto", "CreditScreeningTask": "#/components/schemas/CreditScreeningTaskDto", "DataDeletionInformationTask": "#/components/schemas/DataDeletionInformationTaskDto", "DataReviewTask": "#/components/schemas/DataReviewTaskDto", "DeferredDocRequirementsReviewTask": "#/components/schemas/DeferredDocRequirementsReviewTaskDto", "DocumentAssignmentTask": "#/components/schemas/DocumentAssignmentTaskDto", "DocumentDataExtractionTask": "#/components/schemas/DocumentDataExtractionTaskDto", "DocumentDataExtractionV2Task": "#/components/schemas/DocumentDataExtractionV2TaskDto", "DocumentsV2Task": "#/components/schemas/DocumentsV2TaskDto", "DocumentTask": "#/components/schemas/DocumentTaskDto", "EntityDataConditionTask": "#/components/schemas/EntityDataConditionTaskDto", "EntityGroupManagementTask": "#/components/schemas/EntityGroupManagementTaskDto", "EvaluateReviewDatesTask": "#/components/schemas/EvaluateReviewDatesTaskDto", "ExpectedActivityTask": "#/components/schemas/ExpectedActivityTaskDto", "ExternalDataAggregationTask": "#/components/schemas/ExternalDataAggregationTaskDto", "ExternalDataDocsCollectionTask": "#/components/schemas/ExternalDataDocsCollectionTaskDto", "ExternalDataTask": "#/components/schemas/ExternalDataTaskDto", "ExternalDataV2Task": "#/components/schemas/ExternalDataV2TaskDto", "FinalIsdaAmendSearchTask": "#/components/schemas/FinalIsdaAmendSearchTaskDto", "FinancialAnalysisImportTask": "#/components/schemas/FinancialAnalysisImportTaskDto", "FinancialAnalysisTask": "#/components/schemas/FinancialAnalysisTaskDto", "FinancialCrimeReportTask": "#/components/schemas/FinancialCrimeReportTaskDto", "GroupTask": "#/components/schemas/GroupTaskDto", "HierarchyCaptureTask": "#/components/schemas/HierarchyCaptureTaskDto", "IfThenConditionTask": "#/components/schemas/IfThenConditionTaskDto", "IndividualIdvLivenessTask": "#/components/schemas/IndividualIdvLivenessTaskDto", "IndividualIdvReviewTask": "#/components/schemas/IndividualIdvReviewTaskDto", "IndividualIdvTask": "#/components/schemas/IndividualIdvTaskDto", "IntegrationsDataPublishTask": "#/components/schemas/IntegrationsDataPublishTaskDto", "InvestmentAccountsTask": "#/components/schemas/InvestmentAccountsTaskDto", "IsdaAmendOngoingUpdatesTask": "#/components/schemas/IsdaAmendOngoingUpdatesTaskDto", "IsdaAmendSearchTask": "#/components/schemas/IsdaAmendSearchTaskDto", "ManageCollateralTask": "#/components/schemas/ManageCollateralTaskDto", "ManageDealsTask": "#/components/schemas/ManageDealsTaskDto", "ManagedRelationshipDetailsTask": "#/components/schemas/ManagedRelationshipDetailsTaskDto", "ManageGroupMembershipTask": "#/components/schemas/ManageGroupMembershipTaskDto", "ManualCreditScreeningTask": "#/components/schemas/ManualCreditScreeningTaskDto", "ManualGroupUpdatesTask": "#/components/schemas/ManualGroupUpdatesTaskDto", "ManualTask": "#/components/schemas/ManualTaskDto", "MatchAndMergeTask": "#/components/schemas/MatchAndMergeTaskDto", "OngoingMonitoringUnsubscribeTask": "#/components/schemas/OngoingMonitoringUnsubscribeTaskDto", "OutreachDataReviewTask": "#/components/schemas/OutreachDataReviewTaskDto", "OutreachRelatedPartiesReviewTask": "#/components/schemas/OutreachRelatedPartiesReviewTaskDto", "ParentDataSyncTask": "#/components/schemas/ParentDataSyncTaskDto", "PolicyTask": "#/components/schemas/PolicyTaskDto", "PortalQuickLinkTask": "#/components/schemas/PortalQuickLinkTaskDto", "PortalRpIndividualIdvLivenessTask": "#/components/schemas/PortalRpIndividualIdvLivenessTaskDto", "PortalRpIndividualIdvReviewTask": "#/components/schemas/PortalRpIndividualIdvReviewTaskDto", "ProductJourneyLaunchpadCheckpointTask": "#/components/schemas/ProductJourneyLaunchpadCheckpointTaskDto", "ProductRelatedPartyJourneyCheckpointTask": "#/components/schemas/ProductRelatedPartyJourneyCheckpointTaskDto", "ProductTask": "#/components/schemas/ProductTaskDto", "ProposedChangesTask": "#/components/schemas/ProposedChangesTaskDto", "PublishToEntityTask": "#/components/schemas/PublishToEntityTaskDto", "RelatedPartyDataAndDocumentsTask": "#/components/schemas/RelatedPartyDataAndDocumentsTaskDto", "RelatedPartyJourneyCheckpointTask": "#/components/schemas/RelatedPartyJourneyCheckpointTaskDto", "ReviewAndApprovalTask": "#/components/schemas/ReviewAndApprovalTaskDto", "ReviewOffboardedProductsTask": "#/components/schemas/ReviewOffboardedProductsTaskDto", "eSignatureReviewSignedDocumentsTask": "#/components/schemas/ReviewSignedDocumentsTaskDto", "RiskAssessConditionPolicy": "#/components/schemas/RiskAssessmentConditionPolicyTaskDto", "RiskAssessmentConditionTask": "#/components/schemas/RiskAssessmentConditionTaskDto", "ScreeningEntitySelectionTask": "#/components/schemas/ScreeningEntitySelectionTaskDto", "ScreeningMatchResolutionTask": "#/components/schemas/ScreeningMatchResolutionTaskDto", "ScreeningMatchResolutionTaskOgs": "#/components/schemas/ScreeningMatchResolutionTaskOgsDto", "ScreeningMaterialityAssessmentConditionTask": "#/components/schemas/ScreeningMaterialityAssessmentConditionTaskDto", "ScreeningMaterialityAssessmentConditionTaskOgs": "#/components/schemas/ScreeningMaterialityAssessmentConditionTaskOgsDto", "ScreeningMaterialityAssessmentTask": "#/components/schemas/ScreeningMaterialityAssessmentTaskDto", "ScreeningMaterialityAssessmentTaskOgs": "#/components/schemas/ScreeningMaterialityAssessmentTaskOgsDto", "ScreeningResolutionAndClientSelectionTaskOgs": "#/components/schemas/ScreeningResolutionAndClientSelectionTaskOgsDto", "ScreeningResolutionAndMaterialityAssessmentTask": "#/components/schemas/ScreeningResolutionAndMaterialityAssessmentDto", "SealedTask": "#/components/schemas/SealedTaskDto", "ServiceTask": "#/components/schemas/ServiceTaskDto", "SignificanceEngineResultsTask": "#/components/schemas/SignificanceEngineResultsTaskDto", "ConditionTask": "#/components/schemas/TaskConditionalGatewayDto", "TransactionMonitoringTask": "#/components/schemas/TransactionMonitoringTaskDto", "TransactionScreeningMatchResolutionTask": "#/components/schemas/TransactionScreeningMatchResolutionTaskDto", "ScreeningUnsubscribeOgsTask": "#/components/schemas/UnsubscribeOgsTaskDto", "VerifyScreeningPeriodTask": "#/components/schemas/VerifyScreeningPeriodTaskDto" } } }, "JourneyTaskDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" } ], "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" }, "LaunchJourneyBusinessProcessDto": { "type": "object", "properties": { "businessProcessId": { "type": "string", "description": "The UiD of the business process", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "status": { "type": "string", "description": "Status of business process", "nullable": true, "example": "In Progress" }, "payload": { "allOf": [ { "$ref": "#/components/schemas/LaunchJourneyBusinessProcessPayloadDto" } ], "description": "Business process payload", "nullable": true }, "created": { "type": "string", "description": "Business process created date", "format": "date-time", "example": "2021-01-05T14:48:00.000Z" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessProcessMessageDto" }, "description": "Business process messages", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LaunchJourneyBusinessProcessItemDto" }, "description": "Business Process items", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing journey launch business process" }, "LaunchJourneyBusinessProcessDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LaunchJourneyBusinessProcessDto" } ], "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" }, "LaunchJourneyBusinessProcessItemDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "The UiD of the launched journey", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "journeySchemaId": { "type": "string", "description": "The UiD of the launched journey schema", "format": "uuid", "example": "a5cfd4e8-732f-4601-ac88-652b64c8439c" }, "journeySchemaVersionNumber": { "type": "integer", "description": "Launched journey schema version number", "format": "int32", "nullable": true, "example": 1 }, "entityDraftId": { "type": "string", "description": "The UiD of the launched journey entity draft", "format": "uuid", "example": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0" }, "journeyType": { "type": "string", "description": "Type of the launched journey", "nullable": true, "example": "Client Onboarding" }, "journeyName": { "type": "string", "description": "Name of the launched journey", "nullable": true, "example": "COB Journey" }, "status": { "type": "string", "description": "Status of the launched journey", "nullable": true, "example": "In Progress" } }, "additionalProperties": false, "description": "Response DTO representing journey launch business process item" }, "LaunchJourneyBusinessProcessPayloadDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The UiD of the launched journey entity", "format": "uuid", "example": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0" }, "journeyType": { "type": "string", "description": "launched journey type", "nullable": true, "example": "Client Onboarding" } }, "additionalProperties": false, "description": "Response DTO representing journey launch business process payload" }, "LifecycleStatus": { "enum": [ "Unknown", "OnboardingInProgress", "MaintenanceInProgress", "Compliant", "ReviewInProgress", "PendingOffboarding", "ClientOffboarded" ], "type": "string", "description": "Lifecycle status enumeration" }, "LifecycleStatusSummary": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/LifecycleStatus" } ], "description": "Entity status summary", "example": "Compliant" }, "factors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LifecycleStatusSummaryFactor" }, "description": "Journeys by type which have direct impact of the Lifecycle status", "nullable": true } }, "additionalProperties": false, "description": "Value object representing summary of journey instances for given entity grouped by journey type" }, "LifecycleStatusSummaryFactor": { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/LifecycleSummaryFactorStatus" } ], "description": "Journey status summary", "example": "In Progress" }, "journeys": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyLifecycleStatus" }, "description": "Entity journeys overview", "nullable": true } }, "additionalProperties": false, "description": "Single Journey Type overview" }, "LifecycleStatusSummaryServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LifecycleStatusSummary" } ], "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" }, "LifecycleSummaryFactorStatus": { "enum": [ "Done", "InProgress", "Cancelled" ], "type": "string", "description": "The summary status of journey instances of given type" }, "LinkedJourneyDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the journey instance", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "entityId": { "type": "string", "description": "The UiD of the entity that journey instance belongs to", "format": "uuid", "example": "c698bcee-ca53-481d-a4cd-0bfde137555b" }, "applicationId": { "type": "string", "description": "The UiD of the grouped journeys", "format": "uuid", "nullable": true, "example": "45D738A5-0F06-4111-BDBF-B7E924FC5D9A" }, "applicationStatus": { "enum": [ "Active", "Rejected" ], "type": "string", "description": "Status of the journey from specific application", "nullable": true, "example": "Active" }, "applicationType": { "allOf": [ { "$ref": "#/components/schemas/ApplicationTypeDto" } ], "description": "Type of the service that triggered the application", "nullable": true, "example": "JourneyLaunchpad" }, "completed": { "type": "string", "description": "Journey instance completed date", "format": "date-time", "nullable": true, "example": "2021-03-05T14:48:00.000Z" }, "type": { "type": "string", "description": "Journey schema type", "nullable": true, "example": "Client Onboarding" }, "status": { "enum": [ "Not Started", "In Progress", "Done", "Cancelled", "Deleted", "Paused" ], "type": "string", "description": "Journey instance status", "nullable": true, "example": "In Progress" }, "name": { "type": "string", "description": "Journey instance name", "nullable": true, "example": "Individual Client Onboarding" }, "hasSlaSet": { "type": "boolean", "description": "Flag indicating if a Service Level Agreement has been set" }, "hasRequiredAccessLayers": { "type": "boolean", "description": "Flag indicating if current user has required access layers to access this journey instance" } }, "additionalProperties": false }, "LinkedJourneysRequestDto": { "type": "object", "properties": { "options": { "allOf": [ { "$ref": "#/components/schemas/PageOptions" } ], "description": "Options for setting up the results page", "nullable": true }, "statusFilter": { "type": "array", "items": { "type": "string" }, "nullable": true }, "onlyActive": { "type": "boolean" }, "applicationType": { "allOf": [ { "$ref": "#/components/schemas/ApplicationTypeDto" } ], "nullable": true } }, "additionalProperties": false }, "LinkedJourneysRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LinkedJourneysRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "LinkedJourneysResponseDto": { "type": "object", "properties": { "parent": { "allOf": [ { "$ref": "#/components/schemas/LinkedJourneyDto" } ], "nullable": true }, "current": { "allOf": [ { "$ref": "#/components/schemas/LinkedJourneyDto" } ], "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedJourneyDto" }, "nullable": true }, "nextPaginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LinkedJourneysResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LinkedJourneysResponseDto" } ], "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" }, "ManageCollateralTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "assetsCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collateralRelatedParty": { "type": "boolean" }, "collateralRelatedPartyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "assetRelatedParty": { "type": "boolean" }, "assetRelatedPartyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collateralAutoSaveEnabled": { "type": "boolean" }, "collateralActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enableAllCollateralActions": { "type": "boolean", "nullable": true }, "assetActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enableAllAssetActions": { "type": "boolean", "nullable": true }, "collateralSummaryCategory": { "type": "string", "nullable": true }, "assetSummaryTableCategory": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ManageDealsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "requirementSetId": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryOrdering": { "type": "boolean" }, "productCategoryOrdering": { "type": "boolean" }, "dataGroupCategoryOrdering": { "type": "boolean" }, "dealActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "covenantsConditionsCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealTabs": { "type": "object", "additionalProperties": { "type": "boolean" }, "nullable": true }, "enableDealCollaterals": { "type": "boolean", "nullable": true }, "dealCollateralsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealCollateralGridFieldConfigCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealCollateralDetailsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealCollateralAssetDetailsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsMainEntityCollateralSummaryEnabled": { "type": "boolean" }, "dealsMainEntityCollateralSummaryCategory": { "type": "string", "nullable": true }, "productDealActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsPolicyDataEnabled": { "type": "boolean" }, "dealsPolicyDataCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsPolicyDataGroupCategoryOrdering": { "type": "boolean" }, "dealsPolicyCategoryOrdering": { "type": "boolean" }, "dealsMainEntitySummaryCategory": { "type": "string", "nullable": true }, "dealsCustomTaskProviderEnabled": { "type": "boolean" }, "dealsCustomTaskProviderId": { "type": "string", "nullable": true }, "dealsCustomTaskButtonLabel": { "type": "string", "nullable": true }, "dealsRelatedPartiesCreateEntityEnabled": { "type": "boolean" }, "dealsRelatedPartiesSearchEntitiesInGroupEnabled": { "type": "boolean" }, "dealsRelatedProductsEnabled": { "type": "boolean" }, "dealsCollateralActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsDisplayCollateralLinkInProductsTab": { "type": "boolean" }, "dealsCovenantsConditionsActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsEntitiesTableCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsRelatedPartiesActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dealsRelatedProductsActions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "ManageGroupMembershipTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ManagedRelationshipDetailsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "ManualCreditScreeningTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "targetEntities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "creditScreeningSummaryEnabled": { "type": "boolean" }, "associationScopingCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "legalEntitySecondaryIdentifiersCategory": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ManualGroupUpdatesTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ManualTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "MatchAndMergeTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "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" }, "ObjectServiceResult": { "type": "object", "properties": { "content": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "customHeaders": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": false }, "OngoingMonitoringUnsubscribeTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "OriginSource": { "enum": [ "Unknown", "Review", "ReviewGroup" ], "type": "string" }, "OutreachDataReviewTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "OutreachRelatedPartiesReviewTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "PageOptions": { "type": "object", "properties": { "paginationToken": { "type": "string", "description": "Position token for the search results to start\n(leave empty to start from the 1st item)", "nullable": true }, "pageSize": { "type": "integer", "description": "Size of the page (result set)", "format": "int32", "example": 10 }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ], "description": "Sort Order (Ascending or Descending)" } }, "additionalProperties": false, "description": "Options for setting up the results page" }, "ParentDataSyncTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "taskIdToReopen": { "type": "string", "format": "uuid" }, "completeAutomatically": { "type": "boolean" } }, "additionalProperties": false } ] }, "PermissionDto": { "type": "object", "properties": { "permitted": { "type": "boolean", "description": "Whether the action is permitted.", "example": false }, "reason": { "type": "string", "description": "Human-readable explanation when Fenergo.Nebula.Journey.Query.Application.Dto.PermissionDto.Permitted is false.\nEmpty/null when permitted is true.", "nullable": true, "example": "Only members of the assigned team can reopen this task." } }, "additionalProperties": false, "description": "A single permission outcome for the current user, plus a human-readable\nreason that the UI surfaces as a tooltip when the action is not permitted." }, "PolicyTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "policyCategory": { "type": "string", "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "dataGroupCategoryOrdering": { "type": "boolean" }, "enforceOwnershipAndControlInPortal": { "type": "boolean", "nullable": true }, "enforceMandatoryRPCapture": { "type": "boolean", "nullable": true }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessSubCategory": { "type": "string", "nullable": true }, "documentPersistence": { "type": "boolean", "nullable": true }, "relatedPartyCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relatedPartyRelationshipTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataGroupSearchScope": { "type": "array", "items": { "type": "string" }, "nullable": true }, "captureRelatedPartyDocuments": { "type": "boolean", "nullable": true }, "relatedPartiesSearchEntitiesInGroupEnabled": { "type": "boolean" }, "autocompleteDocValidationStatuses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relatedPartyScopingRuleSet": { "type": "string", "description": "PolicyTask (OwnershipAndControl) - Scoping rule to filter which related parties are displayed to portal users when this task loads", "nullable": true }, "autoExtractionEnabled": { "type": "boolean", "description": "Related Parties Task - Determines if Auto Extraction of related parties is turned on" }, "disableIDV": { "type": "boolean", "description": "Related Parties Task - Determines if IDV is turned off when Related Parties Data and Docs task is in the stage/process", "nullable": true }, "searchExcludeClientEntities": { "type": "boolean", "description": "Related Parties Task - Determines whether to exclude client entities from the duplicate search" }, "eSignatureAutocomplete": { "type": "boolean", "description": "eSignature Documents Task - Determines if task should autocomplete when all eSignature documents have been signed" }, "eSignatureTypeConfiguration": { "type": "boolean", "description": "eSignature Documents Task - Determines if task should auto-select eSignature type based on predefined conditions" } }, "additionalProperties": false } ] }, "PortalQuickLinkTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "PortalRpIndividualIdvLivenessTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "regulaConfigurationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } ] }, "PortalRpIndividualIdvReviewTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProductJourneyLaunchpadCheckpointTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ProductRelatedPartyJourneyCheckpointTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ProductTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productRelatedPartyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relatedPartyEnabled": { "type": "boolean", "nullable": true }, "sequentialTaskEvalEnabled": { "type": "boolean", "nullable": true }, "relatedProductsEnabled": { "type": "boolean", "nullable": true }, "documentRequirementsEnabled": { "type": "boolean", "nullable": true }, "displayPortalDocumentRequirements": { "type": "boolean", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "productActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "displayCollateralGrid": { "type": "boolean", "nullable": true }, "collateralCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productScopingRuleSet": { "type": "string", "nullable": true }, "enforceProductCapture": { "type": "boolean" }, "documentPersistence": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "ProposedChangesTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "changeDomains": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "PublishToEntityTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "publishedTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "RelatedPartyDataAndDocumentsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyRequirementTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataGroupSearchScope": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentPersistence": { "type": "boolean", "nullable": true }, "documentAutoLink": { "type": "boolean", "nullable": true }, "smartDoc": { "type": "boolean", "nullable": true }, "idvScopingRuleSet": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "RelatedPartyJourneyCheckpointTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "RestrictedJourneyInstanceDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "description": "A journey instance the caller's access profile does not permit. Intentionally minimal —\nexposes only the id, with no other fields, since the caller isn't authorized to see them." }, "ReviewAndApprovalTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "selectedGroup": { "type": "string", "nullable": true }, "reviewAndApprovalSelectedEntityTask": { "type": "string", "nullable": true }, "reviewAndApprovalSelectedDocumentTask": { "type": "string", "nullable": true }, "reviewAndApprovalSelectedAssociationsTask": { "type": "string", "nullable": true }, "reviewAndApprovalSelectedRiskTask": { "type": "string", "nullable": true }, "preRelease": { "type": "boolean" }, "randomSamplingRate": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "ReviewOffboardedProductsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ReviewSignedDocumentsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "policyCategory": { "type": "string", "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessSubCategory": { "type": "string", "nullable": true }, "documentPersistence": { "type": "boolean", "nullable": true }, "relatedPartyCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataGroupCategoryOrdering": { "type": "boolean" } }, "additionalProperties": false } ] }, "RiskAssessmentConditionPolicyTaskDto": { "allOf": [ { "$ref": "#/components/schemas/TaskConditionalGatewayDto" }, { "type": "object", "properties": { "riskConditionField": { "type": "string", "nullable": true }, "riskLevels": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "RiskAssessmentConditionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/TaskConditionalGatewayDto" }, { "type": "object", "properties": { "riskLevels": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "SchemaServiceLevelAgreementDto": { "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 task", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing Service Level Agreement of a Journey/Stage/Task" }, "ScreeningEntitySelectionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ScreeningMatchResolutionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ScreeningMatchResolutionTaskOgsDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "ScreeningMaterialityAssessmentConditionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/TaskConditionalGatewayDto" }, { "type": "object", "additionalProperties": false } ] }, "ScreeningMaterialityAssessmentConditionTaskOgsDto": { "allOf": [ { "$ref": "#/components/schemas/TaskConditionalGatewayDto" }, { "type": "object", "additionalProperties": false } ] }, "ScreeningMaterialityAssessmentTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "policyCategory": { "type": "string", "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessSubCategory": { "type": "string", "nullable": true }, "dataGroupCategoryOrdering": { "type": "boolean" } }, "additionalProperties": false } ] }, "ScreeningMaterialityAssessmentTaskOgsDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "policyTarget": { "type": "string", "nullable": true }, "policyCategory": { "type": "string", "nullable": true }, "policyRequirementType": { "type": "string", "nullable": true }, "categoryOrdering": { "type": "boolean" }, "businessCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessSubCategory": { "type": "string", "nullable": true }, "dataGroupCategoryOrdering": { "type": "boolean" } }, "additionalProperties": false } ] }, "ScreeningResolutionAndClientSelectionTaskOgsDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "documentUploadAgainstEachAlertEnabled": { "type": "boolean" }, "hitDocumentType": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "ScreeningResolutionAndMaterialityAssessmentDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "taskCompletionWithUnresolvedItemsEnabled": { "type": "boolean" }, "sanctionsProceedDecisionEnabled": { "type": "boolean" }, "escalationEnabled": { "type": "boolean" }, "documentUploadAgainstEachAlertEnabled": { "type": "boolean" }, "hitDocumentType": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentReqForEachScreenedEntityEnabled": { "type": "boolean" }, "entityDocumentType": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "SealedTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "wasNonSealedTaskHidden": { "type": "boolean" } }, "additionalProperties": false } ] }, "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 }, "dueDate": { "type": "string", "description": "Due Date - calculated date by which Journey/Stage/Task is expected to be completed", "format": "date-time", "nullable": true, "example": "2021-02-05T14:48:00.000Z" }, "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": 2 }, "approachingDueDate": { "type": "string", "description": "Approaching Due Date - calculated date after which the SLA status change to ‘Approaching Due’", "format": "date-time", "nullable": true, "example": "2021-07-07T07:00:00.000Z" }, "status": { "enum": [ "Not Started", "In Progress", "Approaching Due", "Completed", "Completed Overdue", "Overdue", "In Evaluation", "Paused", "Error" ], "type": "string", "description": "Status of Service Level Agreement", "nullable": true, "example": "Overdue" }, "duePeriod": { "type": "string", "description": "Due Period of Service Level Agreement", "nullable": true, "example": "2 Days Overdue" }, "pausedPeriodSec": { "type": "integer", "description": "Total time in seconds when Journey/Stage/Task was paused", "format": "int32", "nullable": true, "example": 3600 }, "defaultCommittedHours": { "type": "integer", "description": "Committed Hours - sets the default amount of time a user has to complete a Journey/Stage/Task", "format": "int32", "nullable": true, "example": 7 }, "defaultApproachingDueHours": { "type": "integer", "description": "Approaching Due Hours - sets the default 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": "Response 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": { "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": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.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 }, "value": { "allOf": [ { "$ref": "#/components/schemas/ServiceLevelAgreementLightDto" } ], "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 }, "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" }, "ServiceTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "serviceName": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "targetEntities": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false, "description": "Defines a version Signee" }, "SignificanceEngineResultsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "properties": { "significanceEngineRules": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false } ] }, "SortOrder": { "enum": [ 0, 1 ], "type": "integer", "description": "Sort Order (Ascending or Descending)", "format": "int32" }, "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" }, "TaskConditionalGatewayDto": { "allOf": [ { "$ref": "#/components/schemas/BranchableTaskDto" }, { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string" }, "outcome": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "EntityDataConditionTask": "#/components/schemas/EntityDataConditionTaskDto", "IfThenConditionTask": "#/components/schemas/IfThenConditionTaskDto", "RiskAssessConditionPolicy": "#/components/schemas/RiskAssessmentConditionPolicyTaskDto", "RiskAssessmentConditionTask": "#/components/schemas/RiskAssessmentConditionTaskDto", "ScreeningMaterialityAssessmentConditionTask": "#/components/schemas/ScreeningMaterialityAssessmentConditionTaskDto", "ScreeningMaterialityAssessmentConditionTaskOgs": "#/components/schemas/ScreeningMaterialityAssessmentConditionTaskOgsDto" } } } ] }, "TaskMessageDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Message", "nullable": true, "example": "Generated Message" }, "date": { "type": "string", "description": "Date", "format": "date-time", "example": "02/02/2000" }, "messageType": { "type": "string", "description": "Message Type", "nullable": true, "example": "Success" }, "messageSource": { "type": "string", "description": "Message Source", "nullable": true, "example": "Autocomplete" } }, "additionalProperties": false }, "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" }, "TeamAssignmentDtoConditionalValueDto": { "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": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.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 }, "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 }, "TransactionMonitoringTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "TransactionScreeningMatchResolutionTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "UnsubscribeOgsTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "additionalProperties": false } ] }, "UserTaskPermissionsDto": { "type": "object", "properties": { "canReopen": { "allOf": [ { "$ref": "#/components/schemas/PermissionDto" } ], "description": "Whether the current user is permitted to reopen this task, plus reason.", "nullable": true } }, "additionalProperties": false, "description": "The current user's permissions for a single task within a journey instance.\nEntries are only emitted for tasks where at least one permission is denied." }, "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 }, "VerifyScreeningPeriodTaskDto": { "allOf": [ { "$ref": "#/components/schemas/JourneyTaskDto" }, { "type": "object", "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": [ ] } ] }