openapi: 3.2.0 info: title: Fenergo Journey Schema API version: '1.0' description: 'Operations tagged JourneySchema 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: JourneySchema paths: /api/journey-schema: post: tags: - JourneySchema summary: Create journey schema description: 'Creates a new journey schema with a first draft version. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: JourneyBuilderEdit' operationId: CreateJourneySchema parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/JourneySchemaDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey schema created content: application/json: schema: $ref: '#/components/schemas/JourneySchemaDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}: post: tags: - JourneySchema summary: Create journey schema version description: 'Creates a new version of an existing journey schema. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: JourneyBuilderEdit' operationId: CreateJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Create journey schema version request content: application/json: schema: allOf: - $ref: '#/components/schemas/JourneySchemaDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey schema version created content: application/json: schema: $ref: '#/components/schemas/JourneySchemaDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - JourneySchema summary: Delete journey schema and all its versions description: 'Deletes an existing journey schema and all its versions. Required permissions: Following permissions are required: JourneyBuilderDelete' operationId: DeleteJourneySchema parameters: - name: journeySchemaId in: path description: Journey schema Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey schema deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - JourneySchema summary: Get journey schema by id description: 'Returns the active, currently in effect, published version of journey schema for a given schema id. Required permissions: Following permissions are required: JourneyBuilderAccess' operationId: GetJourneySchemaById parameters: - name: journeySchemaId in: path description: Journey schema id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. An instance of journey schema is returned content: application/json: schema: $ref: '#/components/schemas/JourneySchemaVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}/version/{versionNumber}/draft: post: tags: - JourneySchema summary: Create journey schema version from provided version number description: 'Creates a new version of an existing journey schema version. Required permissions: Following permissions are required: JourneyBuilderEdit' operationId: CreateJourneySchemaDraftFromVersionNumber parameters: - name: journeySchemaId in: path description: Journey schema id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number from which new draft will be created required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey schema version created content: application/json: schema: $ref: '#/components/schemas/CreateJourneySchemaDraftFromVersionResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id and version number does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}/version/{versionNumber}: put: tags: - JourneySchema summary: Update journey schema version description: 'Updates an existing journey schema version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: JourneyBuilderEdit' operationId: UpdateJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update journey schema version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateJourneySchemaVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey schema version updated content: application/json: schema: $ref: '#/components/schemas/JourneySchemaUpdatedDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - JourneySchema summary: Delete journey schema version description: 'Deletes the selected version of an existing journey schema. If the version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as deleted and become unavailable. Required permissions: Following permissions are required: JourneyBuilderDelete' operationId: DeleteJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey schema version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - JourneySchema summary: Get journey schema by id and version description: 'Returns journey schema for a given id and version number. Required permissions: Following permissions are required: JourneyBuilderAccess' operationId: GetJourneySchemaVersionById parameters: - name: journeySchemaId in: path description: Journey schema id required: true schema: type: string format: uuid - name: versionNumber in: path description: Journey schema version number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Journey schema is returned content: application/json: schema: $ref: '#/components/schemas/JourneySchemaVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}/version/{versionNumber}/clone: post: tags: - JourneySchema summary: Clone journey schema version description: 'Clones the selected version of an existing journey schema and creates a new model with a single version. The new version contains all the data of the original selected one, will have the default status of draft and the author as the only required signee. Returns the id of the cloned data group version. Required permissions: Following permissions are required: JourneyBuilderEdit' operationId: CloneJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to clone required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Clone journey schema version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneJourneySchemaVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey schema version cloned content: application/json: schema: $ref: '#/components/schemas/CloneJourneySchemaVersionResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}/version/{versionNumber}/submit-for-approval: put: tags: - JourneySchema summary: Submit journey schema version for approval description: 'Submits the selected version of an existing journey schema for approval. Required permissions: Following permissions are required: JourneyBuilderEdit' operationId: SubmitJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey schema version submitted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}/version/{versionNumber}/sign: put: tags: - JourneySchema summary: Sign journey schema version description: 'Signs the selected version of an existing journey schema and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: JourneyBuilderApprove' operationId: SignJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Sign journey schema version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data responses: '202': description: Success. Journey schema version signed content: application/json: schema: $ref: '#/components/schemas/JourneySchemaVersionSignResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/{journeySchemaId}/version/{versionNumber}/archive: put: tags: - JourneySchema summary: Archive journey schema version description: 'Archives the selected version of an existing journey schema. Required permissions: Following permissions are required: JourneyBuilderArchive' operationId: ArchiveJourneySchemaVersion parameters: - name: journeySchemaId in: path description: Journey schema Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey schema version archived '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schema/lite: get: tags: - JourneySchema summary: Get journey schemas (lite) description: 'Returns the list of all journey schemas. This is lite endpoint and will not return the definitions of the stages, processes and tasks. Required permissions: Following permissions are required: JourneyBuilderAccess' operationId: GetAllJourneySchemasLite parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of lite journey schemas is returned content: application/json: schema: $ref: '#/components/schemas/JourneySchemaLiteDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeyquery /api/journey-schema/{journeySchemaId}/version/{versionNumber}/export: get: tags: - JourneySchema summary: Export journey schema by id and version to a PDF description: 'Returns a PDF export for a journey schema for a given id and version number. Required permissions: Following permissions are required: JourneyBuilderAccess' operationId: ExportJourneySchemaVersionById parameters: - name: journeySchemaId in: path description: Journey schema id required: true schema: type: string format: uuid - name: versionNumber in: path description: Journey schema version number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Signed S3 URL to Journey schema export is returned. The URL expires after 5m content: application/json: schema: $ref: '#/components/schemas/JourneySchemaExportDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeyquery components: schemas: ConditionalValueDto: required: - logicalOperation - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - '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: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: type: - string - '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 exclusiveMinimum: 0 valueId: type: - string - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false CloneJourneySchemaVersionDto: type: object properties: name: type: - string - 'null' description: Name of new journey schema example: Client Onboarding identifier: type: - string - 'null' description: Identifier of new journey schema example: COB_COMP_1 type: type: - string - 'null' description: The type of new journey schema example: Client Onboarding channelType: allOf: - $ref: '#/components/schemas/ChannelTypeDto' description: Channel type of new journey schema additionalProperties: false description: Request DTO representing clone journey schema data Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false description: Defines a version Signee JourneySchemaUpdatedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneySchemaUpdatedDto' 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 JourneySchemaDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneySchemaDto' 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 CloneJourneySchemaVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneJourneySchemaVersionDto' description: The service request DTO additionalProperties: false description: Service request data ProcessDto: required: - id - name - tasks type: object properties: id: minLength: 1 type: string description: The UiD of the process format: uuid example: 3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37 name: maxLength: 255 minLength: 1 type: string description: Process name example: New Request description: maxLength: 255 type: - string - 'null' description: Process description example: New Request Process order: minimum: 0 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: minItems: 1 type: array items: $ref: '#/components/schemas/TaskDto' description: List of process tasks conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: List of conditions required to trigger process additionalProperties: false description: DTO representing journey process ExternalDataProviderConfigurationDto: type: object properties: providerId: type: - string - 'null' mandatory: type: boolean name: type: - string - 'null' order: type: integer format: int32 additionalProperties: false CreateJourneySchemaDraftFromVersionResponse: type: object properties: versionNumber: type: integer format: int32 versionId: type: string format: uuid additionalProperties: false CloneJourneySchemaVersionResponse: type: object properties: journeySchemaId: type: string description: Id of the cloned journey schema format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 additionalProperties: false description: Cloned journey schema response data ConditionDto: required: - logicalOperation - name - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root example: id: 118313c6-91e6-4b05-a537-5a1ab906418f name: Company-type only description: Applicable only when EntityType=Company logicalOperation: AND operands: - fieldName: EntityType value: - string valueType: text operation: equal operands: [] UpdateJourneySchemaVersionDto: type: object properties: journeySchemaId: type: string description: The UiD of the journey schema format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 name: type: - string - 'null' description: Journey schema name example: Client Onboarding type: type: - string - 'null' description: Journey schema type example: Client Onboarding stages: type: - array - 'null' items: $ref: '#/components/schemas/StageDto' description: Journey schema stage collection versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions under which the schema can be used externalConditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: External Conditions under which the schema can be used milestones: type: - array - 'null' items: $ref: '#/components/schemas/JourneyMilestoneDto' description: List of Journey Schema Milestones channelType: allOf: - $ref: '#/components/schemas/ChannelTypeDto' description: Channel type describing whether journeys will be initiated by internal teams (Internal) or external customers through Portal (External) version: type: integer description: "Current version of journey schema version aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 example: 5 notes: type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes serviceLevelAgreement: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementDto' description: Journey Schema Service Level Agreement areReopenCommentsOptional: type: boolean description: If true then comments are non-mandatory. If false then comments are mandatory. example: true additionalProperties: false description: Request DTO representing set of properties which define a new version of journey schema 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 CloneJourneySchemaVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneJourneySchemaVersionResponse' 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: required: - logicalOperation - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - '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: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementLightDto' description: Value that should be returned when conditions are met priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 exclusiveMinimum: 0 additionalProperties: false EntityResolutionSearchQueryFieldDto: type: object properties: name: type: - string - 'null' additionalProperties: false JourneyMilestoneDto: required: - id - name - stages type: object properties: id: minLength: 1 type: string description: The UiD of the Journey Milestone format: uuid example: 24511767-4586-4b69-af43-c405ec6b154a name: maxLength: 255 minLength: 1 type: string description: Journey Milestone name example: New Request description: maxLength: 255 type: - string - 'null' description: Journey Milestone description example: New Request Milestone order: minimum: 0 type: integer description: Journey Milestone order format: int32 example: 1 stages: minItems: 1 type: array items: type: string format: uuid description: List of Journey Milestone's stages additionalProperties: false description: DTO representing Journey Milestone 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 CreateJourneySchemaDraftFromVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateJourneySchemaDraftFromVersionResponse' 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 ExternalDataConfigurationsDto: type: object properties: default: allOf: - $ref: '#/components/schemas/ExternalDataConfigurationDto' configurations: type: - object - 'null' properties: Company: $ref: '#/components/schemas/ExternalDataConfigurationDto' Individual: $ref: '#/components/schemas/ExternalDataConfigurationDto' Other: $ref: '#/components/schemas/ExternalDataConfigurationDto' DataGroup: $ref: '#/components/schemas/ExternalDataConfigurationDto' additionalProperties: false additionalProperties: false JourneySchemaVersionSignResponse: type: object properties: journeySchemaId: type: string description: The UiD of the journey schema format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versionNumber: type: integer description: The number of the version that has been signed format: int32 example: 2 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The new version status example: Rejected additionalProperties: false description: Sign journey schema response contains the new version status JourneySchemaDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneySchemaDto' description: The service request DTO additionalProperties: false description: Service request data JourneySchemaUpdatedDto: type: object properties: version: type: integer description: Journey schema aggregate version after update format: int32 example: 4 additionalProperties: false description: Response DTO representing updated journey schema Decision: enum: - Approve - Reject type: string UpdateJourneySchemaVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateJourneySchemaVersionDto' description: The service request DTO additionalProperties: false description: Service request data TaskDto: required: - id - name - taskType type: object properties: id: minLength: 1 type: string description: The UiD of the task format: uuid example: c5207c1d-5242-4c28-b16f-ac028e2bfdfd name: maxLength: 255 minLength: 1 type: string description: Task name example: Capture Basic Details taskKey: maxLength: 255 pattern: (^$)|(^[\dA-z]+$) type: - string - 'null' description: Task key example: CaptureBasicDetailsTaskKey description: maxLength: 2000 type: - string - 'null' description: Task description example: Capture Basic Details task order: minimum: 0 type: integer description: Task order format: int32 example: 1 taskType: minLength: 1 type: string description: Task type example: PolicyTask teamId: type: - string - 'null' description: Team id that task belongs to example: c7b9fd6f-cdea-46fb-ab9c-1006adc812a0 defaultTeamId: type: - string - 'null' description: Default Team of a task 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 disableConditionalTeamAssignment: type: boolean description: Flag to determine if team should be automatically assigned to tak when team assignment conditions are met example: false conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: List of conditions required to trigger task 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 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 associationScopingCategories: type: - array - 'null' items: type: string description: Configure association scoping categories for a task autocomplete: type: boolean description: Task automation.If true enables the autocomplete capability autocompleteConditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Task automation conditions. autocompleteDocValidationStatuses: type: - array - 'null' items: type: string description: '"Waived" and "Deferred" Document Requirements' agentAutonomy: type: - string - 'null' description: Degree of autonomy that the agent has disableAgent: type: - boolean - 'null' description: Flag to disable agent functionality for this task smartDoc: type: - boolean - 'null' description: Enable SmartDoc example: true bulkCompletionEnabled: type: - boolean - 'null' description: Bulk task completion. If true enables the ability to bulk complete tasks example: true dataExtractionEnabled: type: - boolean - 'null' description: Enable Data Extraction example: true documentRequirementApproval: type: - boolean - 'null' description: Enable the document requirement approval workflow (manual Approve/Reject before completion) example: true policyTarget: type: - string - 'null' description: Policy target example: Client policyCategory: type: - string - 'null' description: Policy category example: Basic Details policyRequirementType: type: - string - 'null' description: Policy requirement type example: Data categoryOrdering: type: boolean description: Flag indicating BusinessCategory property order. Alphabetically if false. example: false dataGroupCategoryOrdering: type: boolean description: Flag indicating if data groups will be ordered by category. example: false businessCategory: type: - array - 'null' items: type: string description: List of policy business category e.g. ["Basic Details", "Enrich Details"] productCategory: type: - array - 'null' items: type: string description: Manage Deals Task - List of Product categories to be displayed example: - Account Information - Basic Details businessSubCategory: type: - string - 'null' description: Policy subcategory example: Test SubCategory documentPersistence: type: - boolean - 'null' description: Enable Document Persistence example: true documentAutoLink: type: - boolean - 'null' description: Enable Document Auto-Linking. When enabled, all documents will be reviewed and auto-linked when this task opens. example: true relatedPartyCategory: type: - array - 'null' items: type: string description: List of related party data and document category e.g. ["Related Party Basic Details", "Relationship Details"] relatedPartyRelationshipTypes: type: - array - 'null' items: type: string description: List of related party relationship types used for filtering recipients. dataGroupSearchScope: type: - array - 'null' items: maxLength: 255 type: string description: List of data group identifiers used to scope duplicate search for related-party tasks. productRelatedPartyCategories: type: - array - 'null' items: type: string description: List of product related party business category e.g. ["Green Loan"] captureRelatedPartyDocuments: type: - boolean - 'null' description: Enable Capturing Related Party Documents in Outreach Related Party Task enforceOwnershipAndControlInPortal: type: - boolean - 'null' description: Enable Enforce Ownership and Control in Related Party Task in Portal enforceMandatoryRPCapture: type: - boolean - 'null' description: Enable Enforce Mandatory Related Party Capture in Related Party Task in Portal relatedPartiesSearchEntitiesInGroupEnabled: type: boolean description: Related Parties Task - Determines if Related Parties Search should be restricted to Group Entities only autoExtractionEnabled: type: boolean description: Related Parties Task - Determines if Auto Extraction of related parties is turned on disableIDV: type: - boolean - 'null' description: Related Parties task - Disable IDV processing in as there might be separate IDV task set within the journeyś searchExcludeClientEntities: type: boolean description: Related Parties Task - Determines whether to exclude client entities from the duplicate search relatedPartyScopingRuleSet: type: - string - 'null' description: PolicyTask (OwnershipAndControl) and HierarchyCaptureTask - Scoping rule to filter which related parties are displayed when this task loads eSignatureAutocomplete: type: boolean description: eSignature Autocomplete - When enabled, this task will autocomplete when all eSignature documents have been signed eSignatureTypeConfiguration: type: boolean description: eSignature Type Configuration - When enabled, this task will auto-select eSignature type based on predefined conditions serviceName: type: - string - 'null' description: Service name example: cancelJourney properties: type: - object - 'null' additionalProperties: type: - string - 'null' description: Service task properties targetEntities: type: - array - 'null' items: type: string description: Credit Screening service/ Financial Analysis task - List of target entitiy example: - Client - Related Party riskLevels: type: - array - 'null' items: type: string description: Risk assessment condition task - List of risk levels e.g. ["High", "Restricted"] riskConditionField: type: - string - 'null' description: Risk assessment condition task - the policy field where the risk is stored, used in the condition property: type: - string - 'null' description: Entity data and If/Then condition task property example: testProperty value: type: - string - 'null' description: Entity data condition task value example: testValue subTasks: type: - array - 'null' items: $ref: '#/components/schemas/TaskDto' description: Group task - list of sub tasks branches: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/TaskDto' description: Branchable task - list of branches approvalMethod: type: - string - 'null' description: Data review task - approval method outcome: type: - string - 'null' description: Data review task - outcome example: Approved message: type: - string - 'null' description: Data review task - message example: test message includeReviseOutcome: type: boolean description: Data review task - include revise outcome example: true includeRiskSection: type: boolean description: Data review task - include risk section example: false deprecated: true policyRequirementTypes: type: - array - 'null' items: type: string description: Combined policy task - list of policy requirement types documentTaskVersion: type: - integer - 'null' description: Combined policy task - the version number of the document task to be used format: int32 sequentialTaskEvalEnabled: type: - boolean - 'null' description: Product task - enable sequential task evaluation relatedPartyEnabled: type: - boolean - 'null' description: Product task - enable related parties relatedProductsEnabled: type: - boolean - 'null' description: Product task - enable related products grid documentRequirementsEnabled: type: - boolean - 'null' description: Product task - enable document requirements displayPortalDocumentRequirements: type: - boolean - 'null' description: Product task - enable display of document requirements in portal productActions: type: - array - 'null' items: type: string description: Product task - List of Product Actions displayCollateralGrid: type: - boolean - 'null' description: Product task - display Collateral grid collateralCategories: type: - array - 'null' items: type: string description: Product task - List of Collateral categories to be displayed productScopingRuleSet: type: - string - 'null' description: Product task - Product Scoping Rule Set to filter out products in task enforceProductCapture: type: boolean description: Product task - When true, users must capture at least one product before completing the task detailsCategories: type: - array - 'null' items: type: string description: Credit Assessment task - Configurable details categories creditAssessmentProductsEnabled: type: boolean description: Credit Assessment Task - States whether products are accessible during the credit assessment task. productSummaryGridColumnCategories: type: - array - 'null' items: type: string description: Credit Assessment or Financial Analysis Task - Gives the categories used to configure the columns for the product grid in the task. productSummaryGridTotalRow: type: - boolean - 'null' description: Credit Assessment or Financial Analysis Task - Enabled total rows in product summary grid. creditScreeningSummaryEnabled: type: boolean description: Manual Credit Screening Task - States whether summaries are accessible during the credit screening task. legalEntitySecondaryIdentifiersCategory: type: - string - 'null' description: Manual Credit Screening Task - The policy category used for legal entity secondary identifiers. externalDataProviderIds: type: - array - 'null' items: type: string description: External DataV2 Task - External Data Provider Ids externalDataAutomaticSearchProviderIds: type: - array - 'null' items: type: string description: External DataV2 Task - External Data Automatic Search Provider Ids externalDataAutomaticProfileDownloadIds: type: - array - 'null' items: type: string description: External DataV2 Task - External Data Automatic Profile Download Ids externalDataAutomaticImportProviderIds: type: - array - 'null' items: type: string description: External DataV2 Task - Automatically Import From Specific Provider externalDataAutomaticCompleteTypes: type: - array - 'null' items: type: string description: External DataV2 Task - Automatically Complete Under Specific Condition e.g. When no results returned or When Single Exact Match returned externalDataRelatedPartiesAutomationIds: type: - array - 'null' items: type: string description: External DataV2 Task - Automatically Import Related Parties for specific provider externalDataAutomaticUboDiscovery: type: boolean description: External DataV2 Task - External Data Automatic Ubo Discovery externalDataIgnoreDuplicates: type: boolean description: External DataV2 Task - Ignore Duplicates when executing Related Parties Automation externalDataAutoImportOptimizationEnabled: type: boolean description: External DataV2 Task - Enable optimized auto import SF (skip redundant searches/GETs already done by NR Import) documentCollectionProviderIds: type: - array - 'null' items: type: string description: External Data Docs Collection Task - Document Collection Provider Ids scenarioCategory: type: - array - 'null' items: type: string description: Financial Analysis Task - Configure scenario categories summaryCategory: type: - array - 'null' items: type: string description: Financial Analysis Task - Configure summary categories allocationsEnabled: type: boolean description: Financial Analysis Task - Enable Capacity to Service Allocations persistManualDataEnabled: type: boolean description: Financial Analysis Task - Persist manually input financial analysis data financialAnalysisProductSummary: type: boolean description: Financial Analysis Task - Enable product summary for financial analysis financialAnalysisCustomTaskProviderEnabled: type: boolean description: Financial Analysis Task - Enable custom task provider financialAnalysisCustomTaskProviderId: type: - string - 'null' description: Financial Analysis Task - provider id if FinancialAnalysisCustomTaskProviderEnabled is true financialAnalysisCustomTaskButtonLabel: type: - string - 'null' description: Financial Analysis Task - Button Label if custom task is enabled jointFinancialAnalysisEnabled: type: boolean description: Financial Analysis Task - Enable Joint Financial Analysis financialAnalysisAutoSaveEnabled: type: boolean description: Financial Analysis Task - Enable Financial Analysis Auto Save financialAnalysisDataVisualisationEnabled: type: boolean description: Financial Analysis Task - Enable Financial Analysis Data Visualisation financialAnalysisMultiAdjustmentsEnabled: type: boolean description: "Financial Analysis Task - The user has the ability to capture multiple adjustments \nagainst a financial item in the Summary Tab" financialAnalysisDeferAbilityEnabled: type: boolean description: "Financial Analysis Task - When it's enabled, the user has the ability to defer \nFinancial Analysis by switching the toggle on the task page" assetsCategory: type: - array - 'null' items: type: string description: Manage Collateral Task - Assets categories collateralRelatedParty: type: boolean description: Collateral task - enable related parties for collateral collateralRelatedPartyCategories: type: - array - 'null' items: type: string description: Collateral task - categories relating to the collateral related party. assetRelatedParty: type: boolean description: Collateral task - enable related parties for assets assetRelatedPartyCategories: type: - array - 'null' items: type: string description: Collateral task - categories relating to the assets related party. collateralAutoSaveEnabled: type: boolean description: Collateral task - Enable Collateral Auto Save collateralActions: type: - array - 'null' items: type: string description: Collateral task - List of Collateral Actions enableAllCollateralActions: type: - boolean - 'null' description: Collateral task - Enable all Collateral Actions assetActions: type: - array - 'null' items: type: string description: Collateral task - List of Asset Actions enableAllAssetActions: type: - boolean - 'null' description: Collateral task - Enable all Asset Actions collateralSummaryCategory: type: - string - 'null' description: Collateral Summary Category - Category to define second identifiers for collaterals example: Secondary Identifier assetSummaryTableCategory: type: - string - 'null' description: Collateral task - Asset summary table category example: Asset summary table covenantsConditionsCategory: type: - array - 'null' items: type: string description: Covenants & Conditions - CovenantsConditions categories dealRequirementSetId: type: - string - 'null' description: Manage Deals Task - Requirement Set Id example: 2d198b05-e805-407d-a289-080d72dc6910 dealTabs: type: - object - 'null' additionalProperties: type: boolean description: Manage Deals Task - Tab , Enabled/Disabled productCategoryOrdering: type: boolean description: Flag indicating ProductCategory property order. Alphabetically if false. example: false dealActions: type: - array - 'null' items: type: string description: Manage Deals Task - List of Deal Actions example: false enableDealCollaterals: type: - boolean - 'null' description: Manage Deals Task - Display Collateral Grid dealCollateralsCategories: type: - array - 'null' items: type: string description: Manage Deals Task - List of Collateral Categories to be displayed dealCollateralGridFieldConfigCategories: type: - array - 'null' items: type: string description: Manage Deals Task - List of Deal Collateral Summary Table order categories dealCollateralDetailsCategories: type: - array - 'null' items: type: string description: Manage Deals Task - List of Collateral Categories which it will display the individual collateral dealCollateralAssetDetailsCategories: type: - array - 'null' items: type: string description: Manage Deals Task - List of Collateral Asset Categories for assets details tab in collateral modal productDealActions: type: - array - 'null' items: type: string description: Manage Deals Task - List of Product Deal Actions example: false dealsPolicyDataEnabled: type: boolean description: Flag indicating if deals policy data is enabled. example: false dealsPolicyDataCategories: type: - array - 'null' items: type: string description: Manage Deals Task - List of Policy categories to be displayed example: - Booking Details - Basic Details dealsPolicyDataGroupCategoryOrdering: type: boolean description: Flag indicating if deals policy data groups will be ordered by category. example: false dealsPolicyCategoryOrdering: type: boolean description: Flag indicating PolicyDate property order. Alphabetically if false. . example: false dealsMainEntitySummaryCategory: type: - string - 'null' description: Category to be displayed in the Main Entity Details Tab example: Basic Details dealsMainEntityCollateralSummaryEnabled: type: boolean description: Flag indicating if collateral grid, which is under Main Entity Collateral Tab, should be displayed example: false dealsMainEntityCollateralSummaryCategory: type: - string - 'null' description: Columns to be displayed in the collateral grid under Main Entity Collateral Tab example: Main Entity Collateral Category dealsCustomTaskProviderEnabled: type: boolean description: Deals - Enable custom task provider dealsCustomTaskProviderId: type: - string - 'null' description: Deals - provider id if custom task provider is enabled example: 2d198b05-e805-407d-a289-080d72dc6910 dealsCustomTaskButtonLabel: type: - string - 'null' description: Deals - Button label if custom task provider is enabled example: Generate dealsRelatedPartiesCreateEntityEnabled: type: boolean description: Deals - Determines if creation of entity on related parties should be enabled dealsRelatedPartiesSearchEntitiesInGroupEnabled: type: boolean description: Deals - Determines if Related Parties Search should be restricted to Group Entities only dealsRelatedProductsEnabled: type: boolean description: Deals - Determines if Related Products should be enabled in Deals Products dealsCollateralActions: type: - array - 'null' items: type: string description: Manage Deals Task - List of Deal Collateral Actions example: - Edit - Delete - Link dealsDisplayCollateralLinkInProductsTab: type: boolean description: Deals - Display related collateral table in Products Tab dealsCovenantsConditionsActions: type: - array - 'null' items: type: string description: Manage Deals Task - List of Covenant & Conditions Actions example: - Add - Delete - Edit dealsEntitiesTableCategories: type: - array - 'null' items: type: string description: Manage Deals Task - List of categories for entities table example: - Category1 dealsRelatedPartiesActions: type: - array - 'null' items: type: string description: Manage Deals Task - List of action controls for related parties example: - Add - Delete - Edit dealsRelatedProductsActions: type: - array - 'null' items: type: string description: Manage Deals Task - List of action controls for related products example: - Add - Delete - Edit reviewAndApprovalSelectedGroup: type: - string - 'null' description: Selected group for Review and Approval task example: Primary Entity Data reviewAndApprovalSelectedEntityTask: type: - string - 'null' description: Selected entity task for Review and Approval task example: Primary Entity Data reviewAndApprovalSelectedDocumentTask: type: - string - 'null' description: Selected document task for Review and Approval task example: Primary Entity Data reviewAndApprovalSelectedAssociationsTask: type: - string - 'null' description: Selected associations task for Review and Approval task example: Primary Entity Data reviewAndApprovalSelectedRiskTask: type: - string - 'null' description: Selected risk task for Review and Approval task example: Primary Entity Data preRelease: type: boolean description: Flag indicating if pre-release is enabled example: true randomSamplingRate: type: - integer - 'null' description: Percentage of the task that is picked for random sampling format: int32 example: 15 changeDomains: type: - array - 'null' items: type: string description: Proposed changes task - list of tabs to show example: - Primary Entity Data - Related Parties changeDomainsConflictResolution: type: - array - 'null' items: type: string description: Conflict resolution task - list of tabs to show example: - Primary Entity Data - Product hideUnchangedCategories: type: boolean description: Conflict resolution task - when true, categories with no field changes are hidden showCalculatedFieldMessage: type: boolean description: Conflict resolution task - when true, fields with a calculated value will be read only and tagged as calculated publishedTypes: type: - array - 'null' items: type: string description: Publish to Entity task - list of types to publish example: - Primary Entity Data - Product portalEnrichDocumentMetadataEnabled: type: - boolean - 'null' description: DocumentsV2Task - Enable Portal Enrich Document Metadata example: true portalEnhancedDocsLayoutEnabled: type: - boolean - 'null' description: DocumentsV2Task - Enable Updated Docs View example: true defaultToExistingValue: type: boolean description: DocumentDataExtractionTask - Default to Existing Value in review panel example: false relatedPartyExtractionEnabled: type: boolean description: DocumentDataExtractionV2Task - Enable related party extraction example: false currentJourneyOnly: type: boolean description: DocumentDataExtractionV2Task - Extract only from documents uploaded in this journey example: false fundSearchCategory: type: - string - 'null' description: Investment Account Task - Fund Search Category. A value indicating which business category should be used for searching a fund example: Fund Basic Search initialCreationCategories: type: - array - 'null' items: type: string description: Investment Account Task - Initial Creation Categories. A value indicating which business categories will be used at initial investment account creation validateMissingRequirements: type: boolean description: Investment Account Task - Validate Missing Requirements. A value indicating if the task should validate missing requirements for inaccessible requirements enableLinkProduct: type: boolean description: Investment Account Task - Enable Link Product. If true a user will be able to link a Product of a Fund to an Investment Account enableLinkBankAccount: type: boolean description: Investment Account Task - Enable Link Bank Account. If true a user will be able to link a Bank Account to an Investment Account enableOffboarding: type: boolean description: Investment Account Task - Enable Offboarding. If true a user will be able to mark Investment Accounts for offboarding and offboard on task verification enableDefaultInvestmentAccountName: type: boolean description: "Investment Account Task - Enable Default Investment Account Name. \nIf true the name of investment account will be automatically set to 'Entity Name'_Account OR 'Entity Name'_'Name of Fund'_Account" displayAccessLayersOnInvestmentAccount: type: boolean description: Investment Account Task - Determines if Access Layers should be displayed on the Investment Account Task enableBankAccountPurpose: type: boolean description: Investment Account Task - Bank Account Purpose.Enables Bank account purpose capture when linking a Bank Account to an Investment Account. This toggle is disabled until the Bank account purpose category is configured in Policy. updateInvestmentAccountNamesOnVerification: type: boolean description: Investment Account Task - Determines if Investment Accounts names should be updated on the Verification Task example: true displayPortalDocumentRequirementsOnInvestmentAccount: type: boolean description: Investment Account Task - Determines if Document Requirements should be displayed to the Portal user per Investment Account. documentPersistenceOnInvestmentAccount: type: boolean description: Investment Account Task - When enabled, documents previously supplied for an Investment Account are re-linked to the equivalent requirement when that account appears in a later journey. example: true enforceInvestmentAccountCreation: type: boolean description: Investment Account Task - When enabled, at least one Investment Account must be created before the task can be completed example: true enableStatusFilteringOnInvestmentAccount: type: boolean description: Investment Account Task - When enabled, Portal surfaces Investment Accounts across multiple lifecycle statuses (not only Onboarding-In-Progress) and exposes a status filter on the IA list. brandFilterEnabledOnInvestmentAccount: type: boolean description: Investment Account Task - When enabled, the Portal IA list is filtered to accounts whose linked funds carry the current Portal Tenant's brand on the configured Fenergo.Nebula.Journey.Command.Application.Dto.TaskDto.BrandDataKeyOnInvestmentAccount property. brandDataKeyOnInvestmentAccount: type: - string - 'null' description: Investment Account Task - Name of the fund entity property whose value (pipe-delimited brand tokens) is matched against the current Portal Tenant's name when Fenergo.Nebula.Journey.Command.Application.Dto.TaskDto.BrandFilterEnabledOnInvestmentAccount is on. example: brandName managedRelationshipCategory: type: - array - 'null' items: type: string description: Agency Request Detail Task - Managed Relationship Category. A value indicating which business category should be used for filtering fields on the task documentCategory: type: - array - 'null' items: type: string description: Managed Relationship Detail Task - Document Category. A value indicating which category should be used for filtering fields on the task integrationPipelineId: type: - string - 'null' description: Integrations Data Publish Task - Integration Pipeline Id or Flow Key. Identifier of pipeline that will be used for Data Publish purposes. example: a222cedb-9a43-4191-832c-ed56f345f602 integrationSkipOnRerun: type: boolean description: Integrations Data Publish Task - Integration skip on rerun. Boolean value that determines if Data Publish should be rerunned when task is reopened. isdaActiveProtocols: type: - array - 'null' items: type: string description: Isda Amend Search Task - Isda Provider Ids significanceEngineRules: type: - array - 'null' items: type: string format: uuid description: Significance Engine Rules Ids. isComplianceTask: type: boolean description: Enable Alert Assessment Compliance task regulaConfigurationId: type: string description: Individual Id Verification Liveness Task. format: uuid bulkEntityManagement: type: - boolean - 'null' description: Enable Bulk Entity Management - EntityGroupManagement Task idvScopingRuleSet: type: - string - 'null' description: Related Party Data And Documents task - IDV Scoping Rule Set to filter out related parties in task unwrappingPolicyCategory: type: - array - 'null' items: type: string description: Hierarchy Capture task - Unwrapping Policy Categories determine policy categories for Ownership and Control requirements in task externalDataConfiguration: allOf: - $ref: '#/components/schemas/ExternalDataConfigurationsDto' description: Hierarchy Capture task - External Data Configuration for data providers agencyEtlDataTypes: type: - array - 'null' items: type: string description: Agency ETL Task - Data Types to be used in the creation of the ETL migration agencyEtlPolicyId: type: - string - 'null' description: Agency ETL Task - Policy to be used in the creation of the ETL migration example: a222cedb-9a43-4191-832c-ed56f345f602 agencyEtlProductPolicyId: type: - string - 'null' description: Agency ETL Task - Product Policy to be used in the creation of the ETL migration example: a222cedb-9a43-4191-832c-ed56f345f602 agencyEtlEntityResolutionSearchQueryFields: type: - array - 'null' items: $ref: '#/components/schemas/EntityResolutionSearchQueryFieldDto' description: 'Agency ETL Task - Entity Resolution Fields to be used in ETL agency entity resolution process and their corresponding weights for elasticsearch matching' example: - legalEntityName - countryOfIncorporation agencyEtlEntityResolutionMatchScoreThreshold: type: number description: Sets the match score threshold for entity resolution in Agency ETL Task format: double example: 0.9 taskIdToReopen: type: - string - 'null' description: Parent Data Sync Task - Guid of the task to be reopened format: uuid example: a222cedb-9a43-4191-832c-ed56f345f602 completeAutomatically: type: boolean description: Parent Data Sync Task - boolean indicating that the task is auto-completed. It will not reopen any previously completed tasks example: false displayAccessLayersOnBankAccount: type: boolean description: Bank Account Task - Determines if Access Layers should be displayed on the Bank Account Task enforceBankAccountCreation: type: boolean description: Bank Account Task - When enabled, at least one Bank Account must be created before the task can be completed example: true autoManagedRelationshipName: type: boolean description: Set automatic naming of the managed relationship entity created from the task example: true taskCompletionWithUnresolvedItemsEnabled: type: boolean description: Task completion with unresolved items example: true sanctionsProceedDecisionEnabled: type: boolean description: Sanctions proceed decision example: true escalationEnabled: type: boolean description: Escalation example: true documentUploadAgainstEachAlertEnabled: type: boolean description: Hit document required example: true hitDocumentType: type: - array - 'null' items: type: string description: Hit document required document type documentReqForEachScreenedEntityEnabled: type: boolean description: Entity document required example: true entityDocumentType: type: - array - 'null' items: type: string description: Entity document required document type additionalProperties: false description: DTO representing journey task TeamAssignmentDtoConditionalValueDto: required: - logicalOperation - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - '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: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/TeamAssignmentDto' description: Value that should be returned when conditions are met priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 exclusiveMinimum: 0 additionalProperties: false StageDto: required: - id - name - processes type: object properties: id: minLength: 1 type: string description: The UiD of the stage format: uuid example: 24511767-4586-4b69-af43-c405ec6b154a name: maxLength: 255 minLength: 1 type: string description: Stage name example: New Request dataKey: maxLength: 255 pattern: (^$)|(^[\dA-z]+$) type: - string - 'null' description: Stage Datakey example: NewRequestStageDataKey description: maxLength: 255 type: - string - 'null' description: Stage description example: New Request Stage order: minimum: 0 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: maxLength: 20 type: string description: The list of IDs of the assigned portal roles processes: minItems: 1 type: array items: $ref: '#/components/schemas/ProcessDto' description: List of stage processes conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: List of conditions required to trigger stage serviceLevelAgreement: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementDto' description: Stage Service Level Agreement additionalProperties: false description: DTO representing journey stage ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' 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 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 JourneySchemaDto: type: object properties: journeySchemaId: type: string description: The UiD of journey schema format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 name: type: - string - 'null' description: Journey schema name example: Client Onboarding identifier: type: - string - 'null' description: Journey schema identifier example: COB_COMP_1 type: type: - string - 'null' description: Journey schema type example: Client Onboarding stages: type: - array - 'null' items: $ref: '#/components/schemas/StageDto' description: Journey schema stage collection versionNumber: type: integer description: The version number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' created: type: string description: The creation date of the version (Read-only) format: date-time example: '2021-01-05T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions under which the schema can be used externalConditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: External Conditions under which the schema can be used milestones: type: - array - 'null' items: $ref: '#/components/schemas/JourneyMilestoneDto' description: List of Journey Schema Milestones channelType: allOf: - $ref: '#/components/schemas/ChannelTypeDto' description: Channel type describing whether journeys will be initiated by internal teams (Internal) or external customers through Portal (External) notes: type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes serviceLevelAgreement: allOf: - $ref: '#/components/schemas/ServiceLevelAgreementDto' description: Journey Schema Service Level Agreement areReopenCommentsOptional: type: boolean description: If true then comments are non-mandatory. If false then comments are mandatory. example: true additionalProperties: false description: DTO representing journey schema data Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false 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 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 ExternalDataConfigurationDto: type: object properties: providers: type: - array - 'null' items: $ref: '#/components/schemas/ExternalDataProviderConfigurationDto' additionalProperties: false 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 VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string JourneySchemaVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneySchemaVersionSignResponse' 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 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 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 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 approachingDueHours: type: - integer - 'null' description: Approaching Due Hours - sets the 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: Request DTO representing Service Level Agreement of a Journey/Stage/Task ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false JourneySchemaVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneySchemaVersionDto' 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 ConditionalValueDto_2: 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 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 JourneySchemaProcessDto: type: object properties: id: type: string description: The UiD of the process format: uuid example: 3bdd0379-11e9-4fa7-9ddf-05a8eb5e3d37 name: type: - string - 'null' description: Process name example: New Request description: type: - string - 'null' description: Process description example: New Request Process order: type: integer description: Process order format: int32 example: 1 tasksCompletionOrder: 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 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 additionalProperties: false description: Journey Schema Process metadata 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 JourneySchemaLiteDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/JourneySchemaLiteDto' 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 JourneySchemaMilestoneDto: type: object properties: id: type: string description: The UiD of the Journey Milestone format: uuid example: 24511767-4586-4b69-af43-c405ec6b154a name: type: - string - 'null' description: Journey Milestone name example: New Request description: type: - string - 'null' description: Journey Milestone description example: New Request Milestone 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 JourneySchemaExportDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneySchemaExportDto' 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 JourneySchemaVersionDto: type: object properties: id: type: string description: The UiD of the journey schema version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f journeySchemaId: type: string description: The UiD of the journey schema that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Display name of journey schema example: Individual Client Onboarding identifier: type: - string - 'null' description: Short identifier of journey schema example: IND_ONB_1 type: type: - string - 'null' description: Journey schema type example: Client Onboarding versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true channelType: allOf: - $ref: '#/components/schemas/ChannelTypeDto' description: 'Channel type describing whether journeys will be initiated by internal teams (Internal) or external customers through Portal (External)