openapi: 3.2.0 info: title: Fenergo Journey Instance API version: '1.0' description: 'Operations tagged JourneyInstance across 2 of this provider''s published API definitions: fenergo-journeycommand-v1-0-openapi.json, fenergo-journeyquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /journeycommand - url: /journeyquery security: - Bearer: [] tags: - name: JourneyInstance paths: /api/journey-instance: post: tags: - JourneyInstance summary: Create journey instance description: 'Creates a new journey instance. The request must contain journey schema id that is currently published and in effect. Required permissions: Following permissions are required: JourneyCreate' operationId: CreateJourney parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Create journey instance request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateJourneyInstanceDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instance created content: application/json: schema: $ref: '#/components/schemas/JourneyInstanceCreatedDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/abort: put: tags: - JourneyInstance summary: Cancel journey instance description: 'Cancels a currently in progress journey instance and rejects the associated entity draft. Required permissions: Following permissions are required: JourneyCancel' operationId: AbortJourneyInstance parameters: - name: journeyInstanceId in: path description: Journey instance id to cancel required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Abort journey instance details (Optional) content: application/json: schema: allOf: - $ref: '#/components/schemas/AbortJourneyDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instance canceled '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/batch/abort: put: tags: - JourneyInstance summary: Batch cancel journey instances description: 'Cancels all currently in progress journey instance and rejects the associated entity draft. Required permissions: Following permissions are required: JourneyCancel' operationId: BatchAbortJourneyInstances parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Abort journey instances request content: application/json: schema: allOf: - $ref: '#/components/schemas/AbortMultipleJourneysDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instances canceled '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/complete: put: tags: - JourneyInstance summary: Complete journey instance task description: 'Completes a currently in progress task. If the task is not the last one in given process, the next task will be started, otherwise next process will be started. If all the processes within stage finished, the next stage will be started. If it''s the last stage, the Journey Instance will complete. Required permissions: Following permissions are required: JourneyEdit' operationId: CompleteTask parameters: - name: taskId in: query description: Task id required: true schema: type: string format: uuid - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey instance task completed '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance/task with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/{taskId}/reviewOutcome: put: tags: - JourneyInstance summary: Save review outcome description: 'Completes review outcome task. Required permissions: Following permissions are required: JourneyEdit' operationId: SaveReviewOutcome parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: taskId in: path description: Task id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Save review outcome task request content: application/json: schema: allOf: - $ref: '#/components/schemas/ReviewOutcomeDtoServiceRequest' description: Service request data responses: '202': description: Success. Review outcome task completed '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance/task with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/{taskId}/reassign: put: tags: - JourneyInstance summary: Reassign task description: 'Reassigns task to new team. Required permissions: At least one of the following permissions is required: JourneyReassignTask, JourneyReassignTaskOwnerOnly, JourneyReassignOwnerNoTaskAccess, JourneyUnassignOwner' operationId: ReassignTask parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: taskId in: path description: Task id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reassign task properties content: application/json: schema: allOf: - $ref: '#/components/schemas/ReassignTaskDtoServiceRequest' description: Service request data responses: '202': description: Success. Task team reassigned '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance/task with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/bulk-reassign: put: tags: - JourneyInstance summary: Bulk reassign task description: 'Reassigns tasks to new teams. Required permissions: At least one of the following permissions is required: JourneyReassignTask, JourneyReassignTaskOwnerOnly, JourneyReassignOwnerNoTaskAccess, JourneyUnassignOwner' operationId: ReassignTaskBulk parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: List of reassign task properties content: application/json: schema: allOf: - $ref: '#/components/schemas/ReassignMultipleTasksDtoServiceRequest' description: Service request data responses: '202': description: Accepted. At least one task reassigned content: application/json: schema: $ref: '#/components/schemas/TaskReassignOutcomeDtoListServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/{taskId}/reset: put: tags: - JourneyInstance summary: Reset task description: 'Reset journey task. Warning: If the Task being reset belongs to parallel process (or stage), any changes made, may impact already closed tasks in this process (or stage) Required permissions: Following permissions are required: JourneyReopenTask' operationId: ResetTask parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: taskId in: path description: Task id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reset task properties content: application/json: schema: allOf: - $ref: '#/components/schemas/ResetTaskDtoServiceRequest' description: Service request data responses: '202': description: Success. Task reopened content: application/json: schema: $ref: '#/components/schemas/ReopenTaskCommandResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance/task with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/{taskId}/pause: put: tags: - JourneyInstance summary: Pause journey instance task description: 'Pause a currently in progress journey instance task. Required permissions: Following permissions are required: JourneyPauseTask' operationId: PauseTask parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: taskId in: path description: Task id to pause required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Pause task details content: application/json: schema: allOf: - $ref: '#/components/schemas/PauseJourneyInstanceTaskDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instance task paused '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/{taskId}/unpause: put: tags: - JourneyInstance summary: Unpause journey instance task description: 'Unpause a currently paused journey instance task. Required permissions: Following permissions are required: JourneyPauseTask' operationId: UnpauseTask parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: taskId in: path description: Task id to unpause required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey instance task unpaused '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/stage/{stageId}/pause: put: tags: - JourneyInstance summary: Pause journey instance stage description: 'Pause a currently in-progress journey instance stage and its tasks with SLA configuration Required permissions: Following permissions are required: JourneyPauseStage' operationId: PauseStage parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: stageId in: path description: Stage id to pause required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Pause stage details content: application/json: schema: allOf: - $ref: '#/components/schemas/PauseJourneyInstanceStageDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instance stage paused '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/stage/{stageId}/unpause: put: tags: - JourneyInstance summary: Unpause journey instance stage description: 'Unpause a currently paused journey instance stage and its tasks Required permissions: Following permissions are required: JourneyPauseStage' operationId: UnpauseStage parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: stageId in: path description: Stage id to unpause required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey instance stage unpaused '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/pause: put: tags: - JourneyInstance summary: Pause journey instance description: 'Pause a currently in-progress journey instance and all stages and tasks with SLA configuration Required permissions: Following permissions are required: JourneyPauseInstance' operationId: PauseInstance parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Pause instance details content: application/json: schema: allOf: - $ref: '#/components/schemas/PauseJourneyInstanceDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instance stage paused '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/unpause: put: tags: - JourneyInstance summary: Unpause journey instance description: 'Unpause a currently paused journey instance and all stages and tasks with SLA configuration Required permissions: Following permissions are required: JourneyPauseInstance' operationId: UnpauseInstance parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey instance unpaused '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{id}/access-layers: put: tags: - JourneyInstance summary: Update journey instance access layers description: 'Updates access layers of the journey instance. Required permissions: Following permissions are required: JourneyChangeAccessLayers' operationId: UpdateJourneyAccessLayers parameters: - name: id in: path description: Journey instance id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update journey instance access layers request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateJourneyInstanceAccessLayersDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey instance access layers updated '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/task/{taskId}/reassign-read-only-teams: put: tags: - JourneyInstance summary: Reassign task read only teams description: 'Reassign task read only teams. Required permissions: Following permissions are required: JourneyReassignReadOnlyTask' operationId: ReassignTaskReadOnlyTeams parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: taskId in: path description: Task id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reassign details content: application/json: schema: allOf: - $ref: '#/components/schemas/ReassignReadOnlyTeamsDtoServiceRequest' description: Service request data responses: '202': description: Success. Task read only teams reassigned '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance/task with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/reassign-journey-owner: put: tags: - JourneyInstance summary: Reassign journey owner description: 'Reassign journey owner. Required permissions: At least one of the following permissions is required: JourneyOwnerEdit, JourneyOwnerEditOwnerOnly, JourneyUnassignOwner' operationId: ReassignJourneyOwner parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Reassign details content: application/json: schema: allOf: - $ref: '#/components/schemas/ReassignJourneyOwnerDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey owner reassigned '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}/custom-status: put: tags: - JourneyInstance summary: Update journey instance custom status description: 'Edit journey instance custom status. Required permissions: Following permissions are required: JourneyCustomStatusEdit' operationId: CustomStatusUpdate parameters: - name: journeyInstanceId in: path description: Journey instance id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Custom status details content: application/json: schema: allOf: - $ref: '#/components/schemas/CustomStatusUpdateDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Custom Status changed '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey instance given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/launch-journey: post: tags: - JourneyInstance summary: Launch journey business process description: 'Initialize a launch journey business process. Required permissions: Following permissions are required: JourneyCreate' operationId: LaunchJourney parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Launch journey request content: application/json: schema: allOf: - $ref: '#/components/schemas/LaunchJourneyDtoServiceRequest' description: Service request data responses: '202': description: Success. Launch journey business process initialized content: application/json: schema: $ref: '#/components/schemas/JourneyLaunchedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-instance/{journeyInstanceId}: get: tags: - JourneyInstance summary: Get journey instance by id description: 'Returns 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 servers: - url: /journeyquery /api/journey-instance/{journeyInstanceId}/task/{taskId}: get: tags: - JourneyInstance summary: Get journey instance task by id description: 'Returns 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 servers: - url: /journeyquery /api/journey-instance/search: get: tags: - JourneyInstance summary: Get journey instances by entity id description: 'Returns 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: 'Returns one page of journey instances for a given entity id, sorted by started date in descending order (not caller-configurable). Journeys the caller lacks access-layer permission for are not included in `Items`; their id appears in `RestrictedItems` instead. Callers MUST use `NextPaginationToken` — not `Items.Count` — to decide whether more pages remain. A page''s non-restricted count can be smaller than the requested page size (or even zero) while `NextPaginationToken` is still non-null, since restricted journeys are filtered out of a fetched page after it is sized, not before. An omitted or empty-GUID `EntityId` is not treated as an invalid request - it 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 servers: - url: /journeyquery /api/journey-instance/{journeyInstanceId}/linked-journeys: get: tags: - JourneyInstance summary: Get linked journeys by main journey id description: 'Returns 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: 'Returns 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 servers: - url: /journeyquery /api/journey-instance/lifecycle-status/entity/{entityId}: get: tags: - JourneyInstance summary: Get lifecycle status of all journey instances by entity id description: 'Calculates 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 servers: - url: /journeyquery /api/journey-instance/launch-journey/{businessProcessId}: get: tags: - JourneyInstance summary: Get launch journey business process description: 'Returns 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 servers: - url: /journeyquery components: schemas: LaunchJourneyDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LaunchJourneyDto' description: The service request DTO additionalProperties: false description: Service request data JourneyLaunchedDto: type: object properties: businessProcessId: type: string description: The UiD of the launched journey business process format: uuid example: 24511767-4586-4b69-af43-c405ec6b154a additionalProperties: false description: DTO representing launched journey business process JourneyInstanceCreatedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyInstanceCreatedDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ReassignReadOnlyTeamsDto: type: object properties: readOnlyTeams: type: - array - 'null' items: type: string format: uuid description: List of task read only teams UiDs additionalProperties: false description: DTO representing reassign read only teams JourneyInstanceCreatedDto: type: object properties: journeyInstanceId: type: string description: Id of the created journey instance format: uuid example: 7a15bd4a-20f7-497f-b16a-a75d52c8fe01 journeySchemaId: type: string description: Id of journey schema of the created journey instance format: uuid example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6 journeySchemaVersionNumber: type: - integer - 'null' description: Version number of the journey schema of created journey instance format: int32 example: 1 entityId: type: string description: Entity id from FenX entity data service format: uuid example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6 additionalProperties: false description: Response DTO representing created journey instance AbortJourneyDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AbortJourneyDto' description: The service request DTO additionalProperties: false description: Service request data ReassignMultipleTasksDto: required: - tasks type: object properties: tasks: minItems: 1 type: array items: $ref: '#/components/schemas/ReassignTaskInBulkDto' description: List of tasks to reassign additionalProperties: false description: DTO representing reassign tasks in bulk AccessLayerDto: type: object properties: geographic: uniqueItems: true type: - array - 'null' items: type: string description: Collection of geographic access layers businessRelated: uniqueItems: true type: - array - 'null' items: type: string description: Collection of business related access layers additionalProperties: false description: DTO representing access layers attached AbortMultipleJourneysDto: required: - journeysIds type: object properties: journeysIds: maxItems: 20 minItems: 1 type: array items: type: string format: uuid description: List of journeys to abort reason: type: - string - 'null' description: Reason for journeys cancelation example: Reason comments: type: - string - 'null' description: Comments to journeys cancelation example: Comment additionalProperties: false description: DTO representing aborting journeys in bulk ReassignTaskDto: required: - teamId type: object properties: teamId: minLength: 1 type: string description: The UiD of the team format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f ownerId: type: - string - 'null' description: The UiD of the task owner - user of the system who belongs to the reassigned team format: uuid example: 56ea1e7d-6896-4138-be9a-e2e0a636e2bf comment: type: - string - 'null' description: Optional comment for task reassign action example: Example comment disableConditionalTeamAssignment: type: boolean description: Flag to determine if team should be automatically assigned to tak when team assignment conditions are met example: false additionalProperties: false description: DTO representing reassign task ReopenedTaskDto: type: object properties: id: type: string format: uuid taskType: type: - string - 'null' serviceName: type: - string - 'null' additionalProperties: false JourneyLaunchedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyLaunchedDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data JourneyJurisdictionDto: type: object properties: name: type: - string - 'null' description: Name of the jurisdiction example: Irleand additionalProperties: false description: Request DTO representing jurisdiction journey should operate on PauseJourneyInstanceStageDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PauseJourneyInstanceStageDto' description: The service request DTO additionalProperties: false description: Service request data PauseJourneyInstanceStageDto: required: - reason type: object properties: reason: maxLength: 256 minLength: 1 type: string description: Reason for stage pause example: Reason comment: maxLength: 1024 type: - string - 'null' description: Comments to stage pause example: Comment additionalProperties: false PauseJourneyInstanceDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PauseJourneyInstanceDto' description: The service request DTO additionalProperties: false description: Service request data ReopenTaskCommandResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ReopenTaskCommandResponse' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ReassignJourneyOwnerDto: type: object properties: teamId: type: string description: The UiD of the team format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f ownerId: type: - string - 'null' description: The UiD of the journey owner - user of the system who belongs to the reassigned team format: uuid example: 56ea1e7d-6896-4138-be9a-e2e0a636e2bf comment: type: - string - 'null' description: Optional comment for journey owner reassign action example: Example comment additionalProperties: false description: DTO representing reassign journey owner PauseJourneyInstanceTaskDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PauseJourneyInstanceTaskDto' description: The service request DTO additionalProperties: false description: Service request data ReopenTaskCommandResponse: type: object properties: reopenedTasks: type: - array - 'null' items: $ref: '#/components/schemas/ReopenedTaskDto' additionalProperties: false ReassignTaskDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReassignTaskDto' description: The service request DTO additionalProperties: false description: Service request data CustomStatusUpdateDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CustomStatusUpdateDto' description: The service request DTO additionalProperties: false description: Service request data AbortMultipleJourneysDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AbortMultipleJourneysDto' description: The service request DTO additionalProperties: false description: Service request data TaskReassignOutcomeDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/TaskReassignOutcomeDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ResetTaskDto: type: object properties: comment: type: - string - 'null' description: Comment for task reopen action example: Example comment reopenReason: type: - string - 'null' description: Reason for task reopen action, selected from the lookup list additionalProperties: false description: DTO representing reset task ReassignJourneyOwnerDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReassignJourneyOwnerDto' description: The service request DTO additionalProperties: false description: Service request data UpdateJourneyInstanceAccessLayersDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateJourneyInstanceAccessLayersDto' description: The service request DTO additionalProperties: false description: Service request data CreateJourneyInstanceDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateJourneyInstanceDto' description: The service request DTO additionalProperties: false description: Service request data CustomStatusUpdateDto: type: object properties: customStatus: maxLength: 255 type: - string - 'null' description: Journey Instance custom status example: JourneyOnboarding additionalProperties: false description: Request DTO representing journey custom status update data ReassignReadOnlyTeamsDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReassignReadOnlyTeamsDto' description: The service request DTO additionalProperties: false description: Service request data ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response 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 ReassignTaskInBulkDto: required: - journeyInstanceId - taskId type: object properties: taskId: minLength: 1 type: string description: The UiD of the task format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f journeyInstanceId: minLength: 1 type: string description: The UiD of the journey format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f teamId: type: string description: The UiD of the team format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f ownerId: type: - string - 'null' description: The UiD of the task owner - user of the system who belongs to the reassigned team format: uuid example: 56ea1e7d-6896-4138-be9a-e2e0a636e2bf comment: type: - string - 'null' description: Optional comment for task reassign action example: Example comment disableConditionalTeamAssignment: type: boolean description: Flag to determine if team should be automatically assigned to tak when team assignment conditions are met example: false additionalProperties: false description: DTO representing an request of a task reassignment process UpdateJourneyInstanceAccessLayersDto: required: - accessLayers type: object properties: accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Journey access layers determining the access to the journey instance version: type: integer description: "Current version of the Journey instance where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 additionalProperties: false description: Request DTO representing the journey instance access layers data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data PauseJourneyInstanceDto: required: - reason type: object properties: reason: maxLength: 256 minLength: 1 type: string description: Reason for instance pause example: Reason comment: maxLength: 1024 type: - string - 'null' description: Comments to instance pause example: Comment additionalProperties: false PauseJourneyInstanceTaskDto: required: - reason type: object properties: reason: maxLength: 256 minLength: 1 type: string description: Reason for task pause example: Reason comment: maxLength: 1024 type: - string - 'null' description: Comments to task pause example: Comment additionalProperties: false ReviewOutcomeDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReviewOutcomeDto' description: The service request DTO additionalProperties: false description: Service request data TaskReassignOutcomeDto: type: object properties: journeyInstanceId: type: string description: The UiD of the journey format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f taskId: type: string description: The UiD of the task format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f success: type: boolean description: Information if task has been reassigned successfully example: true errorMessage: type: - string - 'null' description: Information about the reason why the task could not be reassigned. example: Reason additionalProperties: false description: DTO representing an outcome of a task reassignment process ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error ResetTaskDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ResetTaskDto' description: The service request DTO additionalProperties: false description: Service request data ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response ReviewOutcomeDto: required: - outcome type: object properties: outcome: minLength: 1 type: string description: Outcome of the review - must be present on schema branches key parameter example: Approve message: type: - string - 'null' description: Review comment example: Review comment message. additionalProperties: false description: Request DTO representing review outcome task data to save CreateJourneyInstanceDto: required: - journeySchemaId type: object properties: entityId: type: string description: Entity id from FenX entity data service format: uuid example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6 journeySchemaId: minLength: 1 type: string description: Id of existing and published journey schema format: uuid example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6 accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Journey access layers jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/JourneyJurisdictionDto' description: Jurisdictions this journey instance operates on. Only Client Offboarding journey type supports per jurisdiction journey instances. journeySchemaVersionNumber: type: - integer - 'null' description: (Optional) Version number of journey schema to use; if null latest published version is used format: int32 example: 1 additionalProperties: false description: Request DTO representing journey instance to create ReassignMultipleTasksDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReassignMultipleTasksDto' description: The service request DTO additionalProperties: false description: Service request data AbortJourneyDto: type: object properties: cancellationReason: maxLength: 256 type: - string - 'null' description: Reason for journey cancelation example: Reason comments: maxLength: 1024 type: - string - 'null' description: Comments to journey cancelation example: Comment additionalProperties: false description: DTO to abort journey LaunchJourneyDto: type: object properties: entityId: type: string description: The UiD of the Entity from FenX entity data service format: uuid example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6 journeyType: type: - string - 'null' description: Journey type to launch jurisdictions: uniqueItems: true type: - array - 'null' items: type: string description: Jurisdictions this journey instance operates on. Only Client OffBoarding and ReOnboarding journey type supports per jurisdiction journey instances. accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Journey access layers additionalProperties: false description: Response DTO representing launch journey instance(s) ConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: type: - string - 'null' description: Value that should be returned when conditions are met 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 - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false 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 - 'null' description: Status of business process example: In Progress payload: allOf: - $ref: '#/components/schemas/LaunchJourneyBusinessProcessPayloadDto' description: Business process payload created: type: string description: Business process created date format: date-time example: '2021-01-05T14:48:00.000Z' messages: type: - array - 'null' items: $ref: '#/components/schemas/BusinessProcessMessageDto' description: Business process messages items: type: - array - 'null' items: $ref: '#/components/schemas/LaunchJourneyBusinessProcessItemDto' description: Business Process items additionalProperties: false description: Response DTO representing journey launch business process LinkedJourneysRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LinkedJourneysRequestDto' description: The service request DTO additionalProperties: false description: Service request 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 - 'null' description: Launched journey schema version number format: int32 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 - 'null' description: Type of the launched journey example: Client Onboarding journeyName: type: - string - 'null' description: Name of the launched journey example: COB Journey status: type: - string - 'null' description: Status of the launched journey example: In Progress additionalProperties: false description: Response DTO representing journey launch business process item AccessLayerDto_2: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers additionalProperties: false description: Response DTO representing associated access layers TaskMessageDto: type: object properties: message: type: - string - 'null' description: Message example: Generated Message date: type: string description: Date format: date-time example: 02/02/2000 messageType: type: - string - 'null' description: Message Type example: Success messageSource: type: - string - 'null' description: Message Source example: Autocomplete additionalProperties: false JourneyInstanceDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyInstanceDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 - 'null' description: The UiD of Journey Owner format: uuid example: 56ea1e7d-6896-4138-be9a-e2e0a636e2bf comment: type: - string - 'null' description: Optional comment for Journey Owner reassign action example: Example comment additionalProperties: false LinkedJourneysResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LinkedJourneysResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data JourneyInstanceServiceLevelAgreementDto: type: object properties: committedHours: type: - integer - 'null' description: Committed Hours - sets the amount of time a user has to complete a Journey/Stage/Task format: int32 dueDate: type: - string - 'null' description: Due Date - calculated date by which Journey/Stage/Task is expected to be completed format: date-time approachingDueHours: type: - integer - 'null' description: Approaching Due Hours - sets the amount of time when the SLA status change to ‘Approaching Due’ format: int32 approachingDueDate: type: - string - 'null' description: Approaching Due Date - calculated date after which the SLA status change to ‘Approaching Due’ format: date-time status: enum: - Not Started - In Progress - Approaching Due - Completed - Completed Overdue - Overdue - In Evaluation - Paused - Error type: - string - 'null' description: Status of Service Level Agreement duePeriod: type: - string - 'null' description: Due Period of Service Level Agreement pausedPeriodSec: type: - integer - 'null' description: Total time in seconds when Journey/Stage/Task was paused format: int32 defaultCommittedHours: type: - integer - 'null' description: Committed Hours - sets the default amount of time a user has to complete a Journey/Stage/Task format: int32 defaultApproachingDueHours: type: - integer - 'null' description: Approaching Due Hours - sets the default amount of time when the SLA status change to ‘Approaching Due’ format: int32 additionalProperties: false description: Response DTO representing Service Level Agreement of a Journey/Stage/Task, omits Conditions property. JourneyInstanceLightDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/JourneyInstanceLightDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data Condition: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinition' additionalProperties: false LifecycleStatus: enum: - Unknown - OnboardingInProgress - MaintenanceInProgress - Compliant - ReviewInProgress - PendingOffboarding - ClientOffboarded type: string description: Lifecycle status enumeration EntityJourneyInstanceSearchRequestDto: type: object properties: entityId: type: string format: uuid options: allOf: - $ref: '#/components/schemas/PageOptions' description: Options for setting up the results page additionalProperties: false EntityJourneyInstanceSearchRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityJourneyInstanceSearchRequestDto' description: The service request DTO additionalProperties: false description: Service request data 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 - 'null' description: The VersionNumber of the journey schema format: int32 example: 1 applicationId: type: - string - 'null' description: The UiD of the grouped journeys format: uuid example: 45D738A5-0F06-4111-BDBF-B7E924FC5D9A applicationStatus: enum: - Active - Rejected type: - string - 'null' description: Status of the journey from specific application example: Active applicationType: allOf: - $ref: '#/components/schemas/ApplicationTypeDto' description: Type of the service that triggered the application example: JourneyLaunchpad started: type: - string - 'null' description: Journey instance start date format: date-time example: '2021-01-05T14:48:00.000Z' cancelled: type: - string - 'null' description: Journey instance cancelled date format: date-time example: '2021-02-05T14:48:00.000Z' lastUpdatedBy: type: - string - 'null' description: Journey instance last updated by example: Test User cancelledBy: type: - string - 'null' description: Journey instance cancelled by example: Test User completed: type: - string - 'null' description: Journey instance completed date format: date-time example: '2021-03-05T14:48:00.000Z' identifier: type: - string - 'null' description: Journey schema short identifier example: IND_ONB_1 type: type: - string - 'null' description: Journey schema type example: Client Onboarding status: enum: - Not Started - In Progress - Done - Cancelled - Deleted - Paused type: - string - 'null' description: Journey instance status example: In Progress name: type: - string - 'null' description: Journey instance name example: Individual Client Onboarding accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Journey instance access layers determining the access to the entity hasRequiredAccessLayers: type: boolean description: Flag indicating if current user has required access layers to access this journey instance jurisdictions: type: - array - 'null' items: type: string description: Collection of jurisdictions this journey operates on cancellationReason: type: - string - 'null' description: Reason of journey cancelation example: Reason cancelationComment: type: - string - 'null' description: Comments to journey cancelation example: Reason journeyOwner: allOf: - $ref: '#/components/schemas/JourneyOwnerDto' description: Journey Owner customStatus: type: - string - 'null' description: Journey Instance custom status example: JourneyOnboarding stages: type: - array - 'null' items: $ref: '#/components/schemas/JourneyInstanceStageDto' description: List of journey instance stages userTaskPermissions: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/UserTaskPermissionsDto' description: 'Per-task permissions for the current user, keyed by task id. Each entry carries a Fenergo.Nebula.Journey.Query.Application.Dto.PermissionDto per action (e.g. `canReopen`) with a `permitted` flag and a human-readable `reason` tooltip. Only emitted when at least one task has a denied permission; otherwise omitted.' milestones: type: - array - 'null' items: $ref: '#/components/schemas/JourneyInstanceMilestoneDto' description: List of Journey Milestones serviceLevelAgreement: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementDto' description: Journey Service Level Agreement stats: allOf: - $ref: '#/components/schemas/JourneyStatsDto' description: Represents progress of current stage version: type: integer description: Version of JourneyInstance format: int32 example: 1 deleted: type: - string - 'null' description: Journey instance deletion date format: date-time example: '2021-03-05T14:48:00.000Z' metadata: allOf: - $ref: '#/components/schemas/JourneyMetadataDto' description: Metadata of Journey Instance pauseComment: type: - string - 'null' description: Journey Instance pause action comment example: Pause comment pauseReason: type: - string - 'null' description: Journey Instance pause action reason example: Reopen comment pausedBy: type: - string - 'null' description: Journey Instance paused by information example: User paused: type: - string - 'null' description: Journey Instance paused date format: date-time example: '2021-01-05T14:48:00.000Z' unpausedBy: type: - string - 'null' description: Journey Instance unpaused by information example: User unpaused: type: - string - 'null' description: Journey Instance unpaused date format: date-time 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 - 'null' description: The UiD of the origin source that triggered the journey format: uuid 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" additionalProperties: false description: Response DTO representing all journey instance 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 LaunchJourneyBusinessProcessDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LaunchJourneyBusinessProcessDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data BusinessProcessMessageDto: type: object properties: message: type: - string - 'null' description: Business process message example: Error occurred messageType: type: - string - 'null' description: Type of business process message example: Error additionalProperties: false description: Response DTO representing business process message OriginSource: enum: - Unknown - Review - ReviewGroup type: string 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 - 'null' description: The UiD of the grouped journeys format: uuid example: 45D738A5-0F06-4111-BDBF-B7E924FC5D9A applicationStatus: enum: - Active - Rejected type: - string - 'null' description: Status of the journey from specific application example: Active applicationType: allOf: - $ref: '#/components/schemas/ApplicationTypeDto' description: Type of the service that triggered the application example: JourneyLaunchpad completed: type: - string - 'null' description: Journey instance completed date format: date-time example: '2021-03-05T14:48:00.000Z' type: type: - string - 'null' description: Journey schema type example: Client Onboarding status: enum: - Not Started - In Progress - Done - Cancelled - Deleted - Paused type: - string - 'null' description: Journey instance status example: In Progress name: type: - string - 'null' description: Journey instance name 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 EntityJourneyInstanceSearchResponseDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/EntityJourneyInstanceViewModelDto' restrictedItems: type: - array - 'null' items: $ref: '#/components/schemas/RestrictedJourneyInstanceDto' nextPaginationToken: type: - string - 'null' description: 'Token to fetch the next page, or null when there are no more pages. This is the only valid signal that pagination is complete - Items and RestrictedItems can both be empty on a page that still has more pages after it (e.g. a page consisting entirely of access-layer-restricted journeys), since filtering happens after a page is fetched from the data store, not before it is sized.' additionalProperties: false ConditionDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root TeamAssignmentDto: type: object properties: teamId: type: - string - 'null' description: The UiD of the team format: uuid 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 LinkedJourneysResponseDto: type: object properties: parent: allOf: - $ref: '#/components/schemas/LinkedJourneyDto' current: allOf: - $ref: '#/components/schemas/LinkedJourneyDto' children: type: - array - 'null' items: $ref: '#/components/schemas/LinkedJourneyDto' nextPaginationToken: type: - string - 'null' additionalProperties: false LifecycleStatusSummaryServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LifecycleStatusSummary' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ServiceLevelAgreementLightDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementLightDto' description: Value that should be returned when conditions are met priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false PageOptions: type: object properties: paginationToken: type: - string - 'null' description: 'Position token for the search results to start (leave empty to start from the 1st item)' 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 ApplicationTypeDto: enum: - JourneyLaunchpad - RelatedPartyLaunchpad - OngoingScreeningJourney - OgsRelatedClientJourneyLaunchpad - CompleteClientOffboarding - CompleteClientReOnboarding - CompleteAgencyOffboarding - EntityGroupUpdatesLaunchpad - AgencyUpJourneyLaunchpad - AgencyAgentJourneyLaunchpad - ProductJourneyLaunchpad - ProductRelatedPartyLaunchpad type: string description: The types of application ValueField: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false ChannelTypeDto: enum: - Internal - External - InternalAndExternal type: string SortOrder: enum: - 0 - 1 type: integer description: Sort Order (Ascending or Descending) format: int32 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 - 'null' description: Journey schema short identifier example: IND_ONB_1 type: type: - string - 'null' description: Journey schema type example: Client Onboarding status: enum: - Not Started - In Progress - Done - Cancelled - Deleted - Paused type: - string - 'null' description: Journey instance status example: In Progress name: type: - string - 'null' description: Journey instance name 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 - 'null' description: The VersionNumber of the journey schema format: int32 example: 1 applicationId: type: - string - 'null' description: The UiD of the grouped journeys format: uuid example: 45D738A5-0F06-4111-BDBF-B7E924FC5D9A applicationType: allOf: - $ref: '#/components/schemas/ApplicationTypeDto' description: Type of the service that triggered the application example: JourneyLaunchpad applicationStatus: enum: - Active - Rejected type: - string - 'null' description: Status of the journey from specific application example: Active started: type: - string - 'null' description: Journey instance start date format: date-time example: '2021-01-05T14:48:00.000Z' cancelled: type: - string - 'null' description: Journey instance cancelled date format: date-time example: '2021-02-05T14:48:00.000Z' lastUpdatedBy: type: - string - 'null' description: Journey instance last updated by example: Test User cancelledBy: type: - string - 'null' description: Journey instance cancelled by example: Test User completed: type: - string - 'null' description: Journey instance completed date format: date-time example: '2021-03-05T14:48:00.000Z' jurisdictions: type: - array - 'null' items: type: string description: Collection of jurisdictions this journey operates on cancellationReason: type: - string - 'null' description: Reason of journey cancelation example: Reason cancelationComment: type: - string - 'null' description: Comments to journey cancelation example: Reason journeyOwner: allOf: - $ref: '#/components/schemas/JourneyOwnerDto' description: Journey Owner customStatus: type: - string - 'null' description: Journey Instance custom status example: JourneyOnboarding stats: allOf: - $ref: '#/components/schemas/JourneyStatsDto' description: Journey instance task completion statistics serviceLevelAgreement: allOf: - $ref: '#/components/schemas/JourneyInstanceServiceLevelAgreementDto' description: Journey instance Service Level Agreement accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Journey instance access layers determining the access to the entity 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 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 - 'null' description: The VersionNumber of the journey schema format: int32 example: 1 applicationId: type: - string - 'null' description: The UiD of the grouped journeys format: uuid example: 45D738A5-0F06-4111-BDBF-B7E924FC5D9A applicationStatus: enum: - Active - Rejected type: - string - 'null' description: Status of the journey from specific application example: Active applicationType: allOf: - $ref: '#/components/schemas/ApplicationTypeDto' description: Type of the service that triggered the application example: JourneyLaunchpad started: type: - string - 'null' description: Journey instance start date format: date-time example: '2021-01-05T14:48:00.000Z' cancelled: type: - string - 'null' description: Journey instance cancelled date format: date-time example: '2021-02-05T14:48:00.000Z' lastUpdatedBy: type: - string - 'null' description: Journey instance last updated by example: Test User cancelledBy: type: - string - 'null' description: Journey instance cancelled by example: Test User completed: type: - string - 'null' description: Journey instance completed date format: date-time example: '2021-03-05T14:48:00.000Z' identifier: type: - string - 'null' description: Journey schema short identifier example: IND_ONB_1 type: type: - string - 'null' description: Journey schema type example: Client Onboarding status: enum: - Not Started - In Progress - Done - Cancelled - Deleted - Paused type: - string - 'null' description: Journey instance status example: In Progress name: type: - string - 'null' description: Journey instance name example: Individual Client Onboarding accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Journey instance access layers determining the access to the entity hasRequiredAccessLayers: type: boolean description: Flag indicating if current user has required access layers to access this journey instance jurisdictions: type: - array - 'null' items: type: string description: Collection of jurisdictions this journey operates on cancellationReason: type: - string - 'null' description: Reason of journey cancelation example: Reason cancelationComment: type: - string - 'null' description: Comments to journey cancelation example: Reason journeyOwner: allOf: - $ref: '#/components/schemas/JourneyOwnerDto' description: Journey Owner customStatus: type: - string - 'null' description: Journey Instance custom status example: JourneyOnboarding additionalProperties: false description: Response DTO representing journey instance data without Stages object LinkedJourneysRequestDto: type: object properties: options: allOf: - $ref: '#/components/schemas/PageOptions' description: Options for setting up the results page statusFilter: type: - array - 'null' items: type: string onlyActive: type: boolean applicationType: allOf: - $ref: '#/components/schemas/ApplicationTypeDto' additionalProperties: false JourneyInstanceProcessDto: type: object properties: id: type: string description: The UiD of the process format: uuid example: 3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37 schemaProcessId: type: - string - 'null' description: The UiD of the journey schema process format: uuid example: 8ddb2270-63dc-48fc-b6d5-cf94f386f73f name: type: - string - 'null' description: Process name example: New Request description: type: - string - 'null' description: Process description example: New Request Process status: enum: - Not Started - In Evaluation - Skipped - In Progress - Done - Cancelled - Descoped type: - string - 'null' description: Process status example: In Progress order: type: integer description: Process order format: int32 example: 1 tasksCompletionOrder: enum: - Sequential - AnyOrder type: - string - 'null' description: 'Determines the order of completing tasks. Defaults to Sequential. One of Sequential, AnyOrder' example: Sequential tasks: type: - array - 'null' items: $ref: '#/components/schemas/JourneyTaskDto' description: List of process tasks started: type: - string - 'null' description: Process started date format: date-time example: '2021-01-05T14:48:00.000Z' completed: type: - string - 'null' description: Process completed date format: date-time example: '2021-02-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/Condition' description: List of conditions required to trigger process 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 JourneyMetadataDto: type: object properties: sourceEventId: type: - string - 'null' description: Id of a journey trigger source event format: uuid transactionId: type: - string - 'null' description: External Id of the TransactionMonitoring event additionalProperties: false description: DTO representing journey metadata JourneyTaskDto: required: - discriminator type: object properties: discriminator: type: - string - 'null' readOnly: true id: type: string description: The UiD of the task format: uuid example: c5207c1d-5242-4c28-b16f-ac028e2bfdfd schemaTaskId: type: - string - 'null' description: The UiD of the journey schema task format: uuid example: 982e3f33-8264-4188-94bb-3351a3df2ca4 name: type: - string - 'null' description: Task name example: Capture Basic Details taskKey: type: - string - 'null' description: Task key example: CaptureBasicDetailsTaskKey description: type: - string - 'null' description: Task description example: Capture Basic Details task status: enum: - Not Started - In Evaluation - Skipped - In Progress - Done - Cancelled - Error - Preprocessing - Descoped - Paused type: - string - 'null' description: Task status example: In Progress order: type: integer description: Task order format: int32 example: 1 taskType: type: - string - 'null' description: Task type example: PolicyTask assignedTo: type: - string - 'null' description: Task assigned to information example: User reassignedBy: type: - string - 'null' description: Task reassigned by information example: User reopenedBy: type: - string - 'null' description: Task reopened by information example: User reassignComment: type: - string - 'null' description: Task reassign action comment example: Reassign comment reopened: type: - string - 'null' description: Task last reopened date format: date-time example: '2021-01-05T14:48:00.000Z' isReopened: type: boolean description: Task indication it has been Reopened example: true reopenComment: type: - string - 'null' description: Task reopen action comment example: Reopen comment reopenReason: type: - string - 'null' description: Task reopen action reason, selected from the lookup list pauseComment: type: - string - 'null' description: Task pause action comment example: Reassign comment pauseReason: type: - string - 'null' description: Task pause action reason example: Reopen comment pausedBy: type: - string - 'null' description: Task paused by information example: User unpausedBy: type: - string - 'null' description: Task unpaused by information example: User paused: type: - string - 'null' description: Task paused date format: date-time example: '2021-01-05T14:48:00.000Z' unpaused: type: - string - 'null' description: Task unpaused date format: date-time example: '2021-01-05T14:48:00.000Z' started: type: - string - 'null' description: Task started date format: date-time example: '2021-01-05T14:48:00.000Z' completed: type: - string - 'null' description: Task completed date format: date-time example: '2021-02-05T14:48:00.000Z' descoped: type: - string - 'null' description: Task descope date format: date-time example: '2021-02-05T14:48:00.000Z' cancelled: type: - string - 'null' description: Task cancelled date format: date-time example: '2021-02-05T14:48:00.000Z' completedBy: type: - string - 'null' description: Task completed by information example: User completedByHistory: type: - array - 'null' items: type: string description: All users who have completed this task across all rounds teamId: type: - string - 'null' description: The UiD of the team example: 118313c6-91e6-4b05-a537-5a1ab906418f defaultTeamId: type: - string - 'null' description: The UiD of the default team 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 - 'null' items: type: string format: uuid description: List of teams that can access task in read only mode conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: List of conditions required to trigger task 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 - 'null' items: $ref: '#/components/schemas/ConditionalValueDto' description: List of conditions required to dynamically assign team to task teamAssignmentConditionsV2: type: - array - 'null' items: $ref: '#/components/schemas/TeamAssignmentDtoConditionalValueDto' description: List of conditions required to dynamically assign team or journey owner to task completeAfter: type: - array - 'null' items: type: string format: uuid description: List of previous tasks that must be completed before this task isBranchedTask: type: boolean description: Flag indicates that is a branched task created from conditional task example: true checkerTaskList: type: - array - 'null' items: type: string format: uuid description: List of tasks that must be completed by different users than user who completes this task 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 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 - 'null' items: $ref: '#/components/schemas/TaskMessageDto' description: Task Messages that provide info or some description about either passed or failed task autocomplete: type: boolean agentAutonomy: type: - string - 'null' disableAgent: type: - boolean - 'null' bulkCompletionEnabled: type: - boolean - 'null' autocompleteConditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' autocompleteStatus: type: - string - 'null' progressSource: type: - string - 'null' description: 'Backend-owned discriminator naming the source that exposes live autocomplete progress for this task (e.g. "relatedParties"), or null when the task has no progress source. Lets the UI poll the right service and poll nothing otherwise.' 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' 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 - 'null' description: launched journey type example: Client Onboarding additionalProperties: false description: Response DTO representing journey launch business process payload TeamAssignmentDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/TeamAssignmentDto' description: Value that should be returned when conditions are met priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false JourneyTaskDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyTaskDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EntityJourneyInstanceSearchResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityJourneyInstanceSearchResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EntityJourneyInstanceViewModelDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EntityJourneyInstanceViewModelDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data JourneyInstanceStageDto: type: object properties: id: type: string description: The UiD of the stage format: uuid example: 24511767-4586-4b69-af43-c405ec6b154a schemaStageId: type: - string - 'null' description: The UiD of the journey schema stage format: uuid dataKey: type: - string - 'null' description: Stage Datakey example: NewRequestStageDataKey name: type: - string - 'null' description: Stage name example: New Request description: type: - string - 'null' description: Stage description example: New Request Stage status: enum: - Not Started - In Evaluation - Skipped - In Progress - Done - Cancelled - Descoped - Paused type: - string - 'null' description: Stage status example: In Progress order: type: integer description: Stage order format: int32 example: 1 processesCompletionOrder: enum: - Sequential - AnyOrder type: - string - 'null' description: 'Determines the order of completing processes. Defaults to Sequential. One of Sequential, AnyOrder' example: Sequential inParallelWithStages: type: - array - 'null' items: type: string format: uuid description: Optional list of previous stages when this stage should start stageChannel: type: - string - 'null' description: Stage channel example: Internal assignedPortalRoleIds: type: - array - 'null' items: type: string description: The list of IDs of the assigned portal roles started: type: - string - 'null' description: Stage started date format: date-time example: '2021-01-05T14:48:00.000Z' completed: type: - string - 'null' description: Stage completed date format: date-time example: '2021-02-05T14:48:00.000Z' processes: type: - array - 'null' items: $ref: '#/components/schemas/JourneyInstanceProcessDto' description: List of stage processes conditions: type: - array - 'null' items: $ref: '#/components/schemas/Condition' description: List of conditions required to trigger stage 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 serviceLevelAgreement: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementDto' description: Stage Service Level Agreement pauseComment: type: - string - 'null' description: Stage pause action comment example: Reassign comment pauseReason: type: - string - 'null' description: Stage pause action reason example: Reopen comment pausedBy: type: - string - 'null' description: Stage paused by information example: User paused: type: - string - 'null' description: Stage paused date format: date-time example: '2021-01-05T14:48:00.000Z' unpausedBy: type: - string - 'null' description: Stage unpaused by information example: User unpaused: type: - string - 'null' description: Stage unpaused date format: date-time example: '2021-01-05T14:48:00.000Z' additionalProperties: false description: Journey Instance Stage metadata 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 — exposes only the id, with no other fields, since the caller isn''t authorized to see them.' ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' 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 valueField: allOf: - $ref: '#/components/schemas/ValueField' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition 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 - 'null' description: Journey Milestone name example: New Request description: type: - string - 'null' description: Journey Milestone description example: New Request Milestone status: enum: - Not Started - In Progress - Done - Cancelled - Skipped type: - string - 'null' description: Journey Milestone status example: In Progress order: type: integer description: Journey Milestone order format: int32 example: 1 stages: type: - array - 'null' items: type: string format: uuid description: List of Journey Milestone's stages additionalProperties: false description: DTO representing Journey Milestone 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 LifecycleStatusSummaryFactor: type: object properties: status: allOf: - $ref: '#/components/schemas/LifecycleSummaryFactorStatus' description: Journey status summary example: In Progress journeys: type: - array - 'null' items: $ref: '#/components/schemas/JourneyLifecycleStatus' description: Entity journeys overview additionalProperties: false description: Single Journey Type overview ServiceLevelAgreementDto: type: object properties: committedHours: type: - integer - 'null' description: Committed Hours - sets the amount of time a user has to complete a Journey/Stage/Task format: int32 example: 7 dueDate: type: - string - 'null' description: Due Date - calculated date by which Journey/Stage/Task is expected to be completed format: date-time example: '2021-02-05T14:48:00.000Z' approachingDueHours: type: - integer - 'null' description: Approaching Due Hours - sets the amount of time when the SLA status change to ‘Approaching Due’ format: int32 example: 2 approachingDueDate: type: - string - 'null' description: Approaching Due Date - calculated date after which the SLA status change to ‘Approaching Due’ format: date-time 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 - 'null' description: Status of Service Level Agreement example: Overdue duePeriod: type: - string - 'null' description: Due Period of Service Level Agreement example: 2 Days Overdue pausedPeriodSec: type: - integer - 'null' description: Total time in seconds when Journey/Stage/Task was paused format: int32 example: 3600 defaultCommittedHours: type: - integer - 'null' description: Committed Hours - sets the default amount of time a user has to complete a Journey/Stage/Task format: int32 example: 7 defaultApproachingDueHours: type: - integer - 'null' description: Approaching Due Hours - sets the default amount of time when the SLA status change to ‘Approaching Due’ format: int32 example: 8 conditions: type: - array - 'null' items: $ref: '#/components/schemas/ServiceLevelAgreementLightDtoConditionalValueDto' description: List of conditions required to dynamically assign SLA to Journey/Stage/Task additionalProperties: false description: Response DTO representing Service Level Agreement of a Journey/Stage/Task UserTaskPermissionsDto: type: object properties: canReopen: allOf: - $ref: '#/components/schemas/PermissionDto' description: Whether the current user is permitted to reopen this task, plus reason. additionalProperties: false description: 'The current user''s permissions for a single task within a journey instance. Entries are only emitted for tasks where at least one permission is denied.' PermissionDto: type: object properties: permitted: type: boolean description: Whether the action is permitted. example: false reason: type: - string - 'null' description: 'Human-readable explanation when Fenergo.Nebula.Journey.Query.Application.Dto.PermissionDto.Permitted is false. Empty/null when permitted is 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 reason that the UI surfaces as a tooltip when the action is not permitted.' ConditionDefinition: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinition' valueField: allOf: - $ref: '#/components/schemas/ValueField' isCondition: type: boolean readOnly: true additionalProperties: false LifecycleStatusSummary: type: object properties: status: allOf: - $ref: '#/components/schemas/LifecycleStatus' description: Entity status summary example: Compliant factors: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/LifecycleStatusSummaryFactor' description: Journeys by type which have direct impact of the Lifecycle status additionalProperties: false description: Value object representing summary of journey instances for given entity grouped by journey type 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 - 'null' description: Status of the journey instance example: In Progress name: type: - string - 'null' description: Name of the journey instance jurisdictions: type: - array - 'null' items: type: string description: Jurisdictions given journey operates on additionalProperties: false description: Single Journey Instance overview securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-journeycommand-v1-0-openapi.json - fenergo-journeyquery-v1-0-openapi.json