openapi: 3.2.0 info: title: Fenergo Journey Schedule API version: '1.0' description: 'Operations tagged JourneySchedule 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: JourneySchedule paths: /api/journey-schedule: post: tags: - JourneySchedule summary: Create journey Schedule description: 'Creates a new journey Schedule 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: JourneySchedulerEdit' operationId: CreateJourneySchedule parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/JourneyScheduleDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule created content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - JourneySchedule summary: Get journey Schedules description: 'Returns the list of all journey Schedules. Required permissions: Following permissions are required: JourneySchedulerAccess' operationId: GetAllJourneySchedules parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of journey Schedules is returned content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule/{journeyScheduleId}: post: tags: - JourneySchedule summary: Create journey Schedule version description: 'Creates a new version of an existing journey Schedule. 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: JourneySchedulerEdit' operationId: CreateJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Create journey Schedule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/JourneyScheduleDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule version created content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey schema with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - JourneySchedule summary: Delete journey Schedule and all its versions description: 'Deletes an existing journey Schedule and all its versions. Required permissions: Following permissions are required: JourneySchedulerDelete' operationId: DeleteJourneySchedule parameters: - name: journeyScheduleId in: path description: Journey Schedule Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey schedule deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - JourneySchedule summary: Get journey Schedule by id description: 'Returns the active, currently in effect, published version of journey Schedule for a given Schedule id. Required permissions: Following permissions are required: JourneySchedulerAccess' operationId: GetJourneyScheduleById parameters: - name: journeyScheduleId in: path description: Journey Schedule id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. An instance of journey Schedule is returned content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule/{journeyScheduleId}/version/{versionNumber}: put: tags: - JourneySchedule summary: Update journey Schedule version description: 'Updates an existing journey Schedule version. Only draft and rejected versions are allowed to be updated. Required permissions: Following permissions are required: JourneySchedulerEdit' operationId: UpdateJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Update journey Schedule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateJourneyScheduleVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule version updated '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - JourneySchedule summary: Delete journey Schedule version description: 'Deletes the selected version of an existing journey Schedule. 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: JourneySchedulerDelete' operationId: DeleteJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey Schedule version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - JourneySchedule summary: Get journey Schedule by id and version description: 'Returns journey Schedule for a given id and version number. Required permissions: Following permissions are required: JourneySchedulerAccess' operationId: GetJourneyScheduleVersionById parameters: - name: journeyScheduleId in: path description: Journey Schedule id required: true schema: type: string format: uuid - name: versionNumber in: path description: Journey Schedule version number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Journey Schedule is returned content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule/{journeyScheduleId}/version/{versionNumber}/clone: post: tags: - JourneySchedule summary: Clone journey Schedule version description: 'Clones the selected version of an existing journey Schedule 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: JourneySchedulerEdit' operationId: CloneJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to clone required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Clone journey Schedule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneJourneyScheduleVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule version cloned content: application/json: schema: $ref: '#/components/schemas/CloneJourneyScheduleVersionResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule/{journeyScheduleId}/version/{versionNumber}/submit-for-approval: put: tags: - JourneySchedule summary: Submit journey Schedule version for approval description: 'Submits the selected version of an existing journey Schedule for approval. Required permissions: Following permissions are required: JourneySchedulerApprove' operationId: SubmitJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey Schedule version submitted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule/{journeyScheduleId}/version/{versionNumber}/sign: put: tags: - JourneySchedule summary: Sign journey Schedule version description: 'Signs the selected version of an existing journey Schedule and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: JourneySchedulerApprove' operationId: SignJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: description: Sign journey Schedule version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule version signed content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleVersionSignResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule/{journeyScheduleId}/version/{versionNumber}/archive: put: tags: - JourneySchedule summary: Archive journey Schedule version description: 'Archives the selected version of an existing journey Schedule. Required permissions: Following permissions are required: JourneySchedulerArchive' operationId: ArchiveJourneyScheduleVersion parameters: - name: journeyScheduleId in: path description: Journey Schedule Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey Schedule version archived '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand components: schemas: UpdateJourneyScheduleVersionDto: type: object properties: journeyScheduleId: type: string description: The UiD of the journey Schedule format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 name: type: - string - 'null' description: Journey schedule name example: Client Onboarding type: type: - string - 'null' description: Journey Type example: Client Onboarding 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 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 Schedule can be used version: type: integer description: "Current version of journey instance aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 example: 5 additionalProperties: false description: Request DTO representing set of properties which define a new version of journey Schedule CloneJourneyScheduleVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneJourneyScheduleVersionResponse' 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 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 JourneyScheduleDto: required: - conditions - name - type type: object properties: id: type: string description: The UiD of journey Schedule format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 name: maxLength: 255 minLength: 1 type: string description: Journey Schedule name example: Client Onboarding notes: maxLength: 2000 type: - string - '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 type: minLength: 1 type: string description: Journey Type example: Client Onboarding versionNumber: type: integer description: The version number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' created: type: string description: The creation date of the version (Read-only) format: date-time example: '2021-01-05T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version conditions: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDto' description: Conditions under which the Schedule can be used additionalProperties: false description: DTO representing journey Schedule data CloneJourneyScheduleVersionDto: type: object properties: name: type: - string - 'null' description: Name of new journey Schedule example: Client Onboarding type: type: - string - 'null' description: The type of new journey Schedule example: Client Onboarding additionalProperties: false description: Request DTO representing clone journey Schedule 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: [] 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 Decision: enum: - Approve - Reject type: string CloneJourneyScheduleVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneJourneyScheduleVersionDto' description: The service request DTO additionalProperties: false description: Service request data UpdateJourneyScheduleVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateJourneyScheduleVersionDto' description: The service request DTO additionalProperties: false description: Service request data 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 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 CloneJourneyScheduleVersionResponse: type: object properties: journeyScheduleId: type: string description: Id of the cloned journey schedule format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 additionalProperties: false description: Cloned journey schedule response data JourneyScheduleVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyScheduleVersionSignResponse' 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 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 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 JourneyScheduleVersionSignResponse: type: object properties: journeyScheduleId: type: string description: The UiD of the journey Schedule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versionNumber: type: integer description: The number of the version that has been signed format: int32 example: 2 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The new version status example: Rejected additionalProperties: false description: Sign journey Schedule response contains the new version status 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 JourneyScheduleDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyScheduleDto' 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 JourneyScheduleDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyScheduleDto' description: The service request DTO additionalProperties: false description: Service request data ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false JourneyScheduleDto_2: type: object properties: id: type: string description: The UiD of the journey Schedule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versions: type: - array - 'null' items: $ref: '#/components/schemas/JourneyScheduleVersionDto' description: Versions associated to the journey Schedule version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Response DTO representing journey Schedule data JourneyScheduleDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/JourneyScheduleDto_2' 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 JourneyScheduleVersionDto: type: object properties: id: type: string description: The UiD of the journey Schedule version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f journeyScheduleId: type: string description: The UiD of the journey Schedule that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Display name of journey Schedule example: Individual Client Onboarding type: type: - string - 'null' description: Journey Schedule type example: Client Onboarding 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 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 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_2' description: Conditions under which the Schedule can be used version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Response DTO representing journey Schedule version data ConditionDto_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 additionalProperties: false description: Represents condition root JourneyScheduleVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyScheduleVersionDto' 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 securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-journeycommand-v1-0-openapi.json - fenergo-journeyquery-v1-0-openapi.json