openapi: 3.2.0 info: title: Fenergo Journey Schedule Date API version: '1.0' description: 'Operations tagged JourneyScheduleDate 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: JourneyScheduleDate paths: /api/journey-schedule-date: post: tags: - JourneyScheduleDate summary: Create journey Schedule Date description: 'Creates a new Journey Schedule Date. Required permissions: Following permissions are required: JourneySchedulerEdit' operationId: CreateJourneyScheduleDate parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/JourneyScheduleDateDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule Date created content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleDateDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT put: tags: - JourneyScheduleDate summary: Update journey Schedule Date description: 'Updates and existing Journey Schedule Date Record. Required permissions: Following permissions are required: JourneySchedulerEdit' operationId: UpdateJourneyScheduleDate parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/JourneyScheduleDateDtoServiceRequest' description: Service request data responses: '202': description: Success. Journey Schedule Date Updated content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleDateDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule date with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule-date/{journeyScheduleDateId}: delete: tags: - JourneyScheduleDate summary: Delete journey Schedule date record description: 'Deletes a Journey Schedule Date Record. Required permissions: Following permissions are required: JourneySchedulerDelete' operationId: DeleteJourneyScheduleDate parameters: - name: journeyScheduleDateId in: path description: Journey Schedule Date Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 - name: X-CORRELATION-ID in: header description: The UiD of the correlation id schema: type: string example: fee5b5f5-b220-4fef-ba38-bf802b98d74d responses: '202': description: Success. Journey Schedule Date deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule date with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - JourneyScheduleDate summary: Get journey Schedule Date by id description: 'Returns Journey Schedule Date Record for the specified Id Required permissions: Following permissions are required: JourneySchedulerAccess' operationId: GetJourneyScheduleDateById parameters: - name: journeyScheduleDateId in: path description: Journey Schedule id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. An instance of journey Schedule Date is returned content: application/json: schema: $ref: '#/components/schemas/JourneyScheduleDateDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Schedule Date with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeycommand /api/journey-schedule-date/search: get: tags: - JourneyScheduleDate summary: Search Journey Schedule Date records by the Schedule Date description: 'Returns journey schedule date records for a given date. Required permissions: Following permissions are required: JourneySchedulerAccess' operationId: GetScheduleDatesByScheduleDate parameters: - name: scheduleDate in: query description: The date the journeys are scheduled for launch e.g. 2019-01-31 required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '200': description: Success. The list of journey schedule Dates is returned '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /journeyquery components: schemas: 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 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 JourneyScheduleDateDto: required: - comment - entityId - journeyScheduleId - type - userCreated type: object properties: id: type: string description: The UiD of the Journey Schedule Date format: uuid example: daf0f511-9e0f-434e-9093-326e7710d9cc entityId: minLength: 1 type: string description: The UiD of the Entity the Journey is scheduled for format: uuid example: c7d47bf5-5226-4152-a09d-188af9a9bd14 journeyScheduleId: minLength: 1 type: string description: The UiD of the Journey Schedule this date is being set for format: uuid example: b5c3dd6a-49a8-4454-af89-7a7f27aaee4a scheduledDate: type: string description: The date the journey will be launched for format: date-time example: '2021-01-05T14:48:00.000Z' userCreated: type: boolean description: To track if schedule record was manually created by a user example: true comment: maxLength: 255 minLength: 1 type: string description: The reason for which the journey is scheduled example: Created by system scheduled job. type: minLength: 1 type: string description: The type of Journey that will be launched example: Client Onboarding additionalProperties: false description: Response DTO representing Journey Schedule date data 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 JourneyScheduleDateDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyScheduleDateDto' 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 JourneyScheduleDateDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/JourneyScheduleDateDto' 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 JourneyScheduleDateDto_2: type: object properties: id: type: string description: The UiD of the journey Schedule Date format: uuid example: 622d97e9-53d7-4df9-8bb3-ddf79774c519 entityId: type: string description: The UiD of the Entity the journey is scheduled for format: uuid example: fa10b15a-bee2-482e-9a23-9a991d0f5462 journeyScheduleId: type: string description: The UiD of the Journey Schedule this date is being set for format: uuid example: 528160c5-ea3c-4653-a5e2-84fd671d02f0 scheduledDate: type: string description: The date the journey will be launched for format: date-time example: '2021-01-05T14:48:00.000Z' userCreated: type: boolean description: To track if this was manually created by a user example: true comment: type: - string - 'null' description: The reason for which the journey is scheduled example: Created by system scheduled job. type: type: - string - 'null' description: The type of Journey that will be launched example: Client Onboarding additionalProperties: false description: Response DTO representing journey Schedule date 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