openapi: 3.2.0 info: title: Fenergo Nebula Integration Core Configuration Version API description: '**Integration Core API**: Integration Core BFF API allows to create and access integration flows and its'' executions.' version: '1.0' servers: - url: /integrationcore security: - Bearer: [] tags: - name: ConfigurationVersion paths: /api/configurationVersion/{id}: get: tags: - ConfigurationVersion summary: Gets a configuration in current version by ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetCurrentConfigurationVersion parameters: - name: id in: path description: Either the ID or the Flow Key of the configuration. 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 delete: tags: - ConfigurationVersion summary: Deletes the configuration version for the specified ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationDelete Required permissions: Following permissions are required: IntegrationFlowsConfigurationDelete' operationId: DeleteConfigurationVersion parameters: - name: id in: path description: Either the ID or the Flow Key of the configuration. 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: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/{id}/versions/{version}: get: tags: - ConfigurationVersion summary: Gets a specific version of a configuration by ID and version number description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetConfigurationByVersionNumber parameters: - name: id in: path description: Either the ID or the Flow Key of the configuration. required: true schema: type: string - name: version in: path description: The 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: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/{id}/lightversions/{version}: get: tags: - ConfigurationVersion summary: Gets a specific version of a configuration by ID and version number operationId: GetConfigurationLightByVersionNumber parameters: - name: id in: path description: Either the ID or the Flow Key of the configuration. required: true schema: type: string - name: version in: path description: The 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: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionFlatDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/configurationschema: get: tags: - ConfigurationVersion summary: Gets configuration schema description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetConfigurationSchema 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationSchemaDtoServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/all: post: tags: - ConfigurationVersion summary: Gets all latest configuration versions description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetAllLatestConfigurationVersions parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Pagination parameters. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pager' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationFlatDtoPaginatedResponseServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/all/current: get: tags: - ConfigurationVersion summary: Gets all current configuration versions description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetAllCurrentConfigurationVersions 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: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionFlatDtoIReadOnlyCollectionServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/{id}/versions: post: tags: - ConfigurationVersion summary: Gets all versions of a configuration by ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetConfigurationVersions parameters: - name: id in: path description: Either the ID or the Flow Key of the configuration. 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 requestBody: description: Pagination parameters. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pager' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionFlatDtoPaginatedResponseServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/configs/{configurationId}/versions/{version}/draft: post: tags: - ConfigurationVersion summary: Creates a draft of a specific version of a configuration description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: CreateConfigurationDraft parameters: - name: configurationId in: path description: Either the ID or the Flow Key of the configuration. required: true schema: type: string - name: version in: path description: The 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 requestBody: description: The configuration draft request object. content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateConfigurationDraftDto' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionFlatDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion: post: tags: - ConfigurationVersion summary: Creates a new configuration version description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: CreateConfigurationVersion parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The configuration version data transfer object. content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateConfigurationVersionDto' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/GuidServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/configs/{configurationId}/draft/sign: put: tags: - ConfigurationVersion summary: Signs a configuration draft description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationApprove Required permissions: Following permissions are required: IntegrationFlowsConfigurationApprove' operationId: SignConfigurationDraft parameters: - name: configurationId in: path description: Either the ID or the Flow Key of the configuration. 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 requestBody: description: The sign configuration draft request. content: application/json: schema: allOf: - $ref: '#/components/schemas/SignConfigurationDraftRequest' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/configs/{configurationId}/draft/submit: put: tags: - ConfigurationVersion summary: Submits the configuration draft for the specified configuration ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: SubmitConfigurationDraft parameters: - name: configurationId in: path description: Either the ID or the Flow Key of the configuration. 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: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/configs/{configurationId}/draft: put: tags: - ConfigurationVersion summary: Updates the configuration draft for the specified configuration ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: UpdateConfigurationDraft parameters: - name: configurationId in: path description: Either the ID or the Flow Key of the configuration. 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 requestBody: description: The update configuration version request DTO. content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateConfigurationVersionRequestDto' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 delete: tags: - ConfigurationVersion summary: Deletes the configuration draft for the specified configuration ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: DeleteConfigurationDraft parameters: - name: configurationId in: path description: Either the ID or the Flow Key of the configuration. 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: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found 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 /api/configurationVersion/globalvariables: get: tags: - ConfigurationVersion summary: Gets all global variables description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetAllGlobalVariables 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GlobalVariableDtoIReadOnlyCollectionServiceResponse' '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: - ConfigurationVersion summary: Save a global variable description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationApprove Required permissions: Following permissions are required: IntegrationFlowsConfigurationApprove' operationId: SaveGlobalVariable parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the details of the global variable to save. content: application/json: schema: allOf: - $ref: '#/components/schemas/GlobalVariableDto' responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/globalvariables/{name}: delete: tags: - ConfigurationVersion summary: Delete a global variable by name description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationApprove Required permissions: Following permissions are required: IntegrationFlowsConfigurationApprove' operationId: DeleteGlobalVariable parameters: - name: name in: path description: The name of the global variable to delete. 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 content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '204': description: No Content '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/globalvariables/{name}/audit: post: tags: - ConfigurationVersion summary: Gets global variable audit events description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: SearchGlobalVariableAuditEvents parameters: - name: name in: path 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 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/Pager' responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GlobalVariableAuditPaginatedResponseServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/mappings: get: tags: - ConfigurationVersion summary: Gets all mappings description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetMappings 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MappingLightDtoIReadOnlyCollectionServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT post: tags: - ConfigurationVersion summary: Create a new mapping description: 'Required permissions: Following permissions are required: IntegrationFlowsMappingEdit Required permissions: Following permissions are required: IntegrationFlowsMappingEdit' operationId: CreateMapping parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the details of the mapping to create. content: application/json: schema: allOf: - $ref: '#/components/schemas/MappingCreateRequestDto' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/GuidServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/mappings/{mappingId}: get: tags: - ConfigurationVersion summary: Get a mapping by ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetMapping parameters: - name: mappingId in: path description: The ID of the mapping or MappingKey. 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MappingDtoServiceResponse' '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: - ConfigurationVersion summary: Update an existing mapping description: 'Required permissions: Following permissions are required: IntegrationFlowsMappingEdit Required permissions: Following permissions are required: IntegrationFlowsMappingEdit' operationId: UpdateMapping parameters: - name: mappingId in: path description: The ID of the mapping to update. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the updated details of the mapping. content: application/json: schema: allOf: - $ref: '#/components/schemas/MappingUpdateRequestDto' responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - ConfigurationVersion summary: Delete an existing mapping description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: DeleteMapping parameters: - name: mappingId in: path description: The ID of the mapping to delete. 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: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/schedules: get: tags: - ConfigurationVersion summary: Gets all schedules description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetSchedules 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScheduleLightDtoIReadOnlyCollectionServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT post: tags: - ConfigurationVersion summary: Create a new schedule description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: CreateSchedule parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the details of the schedule to create. content: application/json: schema: allOf: - $ref: '#/components/schemas/ScheduleCreateRequestDto' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GuidServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/schedules/{scheduleId}: get: tags: - ConfigurationVersion summary: Get a schedule by ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetSchedule parameters: - name: scheduleId in: path description: The ID of the schedule or ScheduleKey. 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScheduleDtoServiceResponse' '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: - ConfigurationVersion summary: Update an existing schedule description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: UpdateSchedule parameters: - name: scheduleId in: path description: The ID of the schedule to update. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the updated details of the schedule. content: application/json: schema: allOf: - $ref: '#/components/schemas/ScheduleUpdateRequestDto' responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - ConfigurationVersion summary: Delete an existing schedule description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: DeleteSchedule parameters: - name: scheduleId in: path description: The ID of the schedule to delete. 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: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/schemas: get: tags: - ConfigurationVersion summary: Gets all schemas description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetSchemas 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SchemaLightDtoIReadOnlyCollectionServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT post: tags: - ConfigurationVersion summary: Create a new schema description: 'Required permissions: Following permissions are required: IntegrationFlowsMappingEdit Required permissions: Following permissions are required: IntegrationFlowsMappingEdit' operationId: CreateSchema parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the details of the schema to create. content: application/json: schema: allOf: - $ref: '#/components/schemas/SchemaCreateRequestDto' responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/GuidServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/configurationVersion/schemas/{schemaId}: get: tags: - ConfigurationVersion summary: Get a schema by ID description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess Required permissions: Following permissions are required: IntegrationFlowsConfigurationAccess' operationId: GetSchema parameters: - name: schemaId in: path description: The ID of the schema or SchemaKey. 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: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SchemaDtoServiceResponse' '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: - ConfigurationVersion summary: Update an existing schema description: 'Required permissions: Following permissions are required: IntegrationFlowsMappingEdit Required permissions: Following permissions are required: IntegrationFlowsMappingEdit' operationId: UpdateSchema parameters: - name: schemaId in: path description: The ID of the schema to update. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The data transfer object containing the updated details of the schema. content: application/json: schema: allOf: - $ref: '#/components/schemas/SchemaUpdateRequestDto' responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - ConfigurationVersion summary: Delete an existing schema description: 'Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit Required permissions: Following permissions are required: IntegrationFlowsConfigurationEdit' operationId: DeleteSchema parameters: - name: schemaId in: path description: The ID of the schema to delete. 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: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT components: schemas: VariableType: enum: - Text - Number - Json - Guid - Request - Secret - TaskError type: string ConfigurationSchema: type: object properties: schemaVariables: allOf: - $ref: '#/components/schemas/ConfigurationSchemaVariables' readOnly: true schemaSources: allOf: - $ref: '#/components/schemas/ConfigurationSchemaSources' readOnly: true schemaErrors: allOf: - $ref: '#/components/schemas/ConfigurationSchemaErrors' readOnly: true additionalProperties: false Source: type: object properties: type: allOf: - $ref: '#/components/schemas/SourceType' properties: type: - array - 'null' items: $ref: '#/components/schemas/SourceProperty' additionalProperties: false ConfigurationFlatDtoPaginatedResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationFlatDtoPaginatedResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationVersionFlatDtoPaginatedResponse: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationVersionFlatDto' nextToken: type: - string - 'null' hasNextPage: type: boolean additionalProperties: false MappingType: enum: - Text - LoV - Object - LoVArray - Constant - ObjectCollection - ObjectToText - ObjectCollectionToText - Number - Date - MultiSelect type: string ParticipantDto: type: object properties: userId: type: - string - 'null' date: type: string format: date-time additionalProperties: false StorageTaskOperation: enum: - QueryByKey - QueryByPrefix - PutRecord - DeleteRecord type: string InlineTransformerTaskOperation: enum: - JsonMerge - JsonFormat - ArrayMerge - ArrayAppend - Compress - Uncompress - ParseCsv type: string TaskErrorSchema: type: object properties: name: allOf: - $ref: '#/components/schemas/TaskErrorType' additionalProperties: false ObjectSelector: type: object properties: fieldName: type: - string - 'null' value: type: - string - 'null' additionalProperties: false RouteDto: required: - condition - next type: object properties: condition: allOf: - $ref: '#/components/schemas/ConditionDto' next: minLength: 1 type: string additionalProperties: false SingleVariable: type: object properties: category: allOf: - $ref: '#/components/schemas/VariableCategory' taskName: type: - string - 'null' propertyName: type: - string - 'null' additionalProperties: false TaskErrorType: enum: - HttpTimeout - HttpErrorCode - HttpInvalidResponse - HttpRequestError - HttpInvalidRequest - HttpCallbackTimeout - HttpExternalAuthenticationJsonError - HttpExternalAuthenticationError - JsError - JsUnhandledError - JsInvalidOutput - SuperGraphInvalidQueryByValue - SuperGraphResponseErrors - SuperGraphRateLimitExceeded - EventIngressTimeout - EventIngressError - EventIngressInvalidRequest - EventIngressRateLimitExceeded - InvalidNoOfSeconds - SecondsAboveTheLimit - WaitCallbackTimeout - InvalidInternalApiRequest - InternalApiExecutionError - InternalApiRateLimitExceeded - FlowExecutionError - StorageError - StorageKeyNotFound - StorageLimitExceeded - InlineTransformerInvalidRequest - ParallelTaskError - ForEachInvalidRequest - ForEachTaskError - ReportFailed - AiInvokerError type: string SchemaUpdateRequestDto: type: object properties: name: type: - string - 'null' source: allOf: - $ref: '#/components/schemas/SchemaSource' sourceProperties: allOf: - $ref: '#/components/schemas/SchemaSourcePropertiesDto' schemaEntry: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false TasksErrors: type: object properties: taskTypesErrors: type: - array - 'null' items: $ref: '#/components/schemas/TaskErrors' additionalProperties: false TemplateOriginDto: type: object properties: templateKey: type: - string - 'null' templateVersion: type: integer format: int32 importedAt: type: string format: date-time isManaged: type: boolean additionalProperties: false ConditionDto: required: - leftValue - name - operatorType - rightValue type: object properties: name: minLength: 1 type: string leftValue: allOf: - $ref: '#/components/schemas/StraightValueDto' rightValue: allOf: - $ref: '#/components/schemas/StraightValueDto' operatorType: allOf: - $ref: '#/components/schemas/ConditionOperator' additionalProperties: false TaskVariables: type: object properties: type: allOf: - $ref: '#/components/schemas/TaskType' variables: type: - array - 'null' items: $ref: '#/components/schemas/TaskVariable' additionalProperties: false ConstantVariableDto: type: object properties: value: type: - string - 'null' additionalProperties: false AiModel: enum: - GPT5 - GPT4o - O3 - NovaPremier type: string ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupDto: type: object properties: name: type: - string - 'null' values: type: - array - 'null' items: type: string additionalProperties: false CreateConfigurationDraftDto: type: object properties: notes: maxLength: 1000 type: - string - 'null' additionalProperties: false Decision: enum: - Approve - Reject type: string WaitConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true secondsToWait: allOf: - $ref: '#/components/schemas/StraightValueDto' callbackTimeout: type: - string - 'null' additionalProperties: false Mapping: type: object properties: source: type: - string - 'null' target: type: - string - 'null' type: allOf: - $ref: '#/components/schemas/MappingType' loVMapName: type: - string - 'null' toArray: type: boolean displaySource: type: boolean constantValue: type: - string - 'null' objectToTextProperties: allOf: - $ref: '#/components/schemas/ObjectToTextProperties' mappings: type: - array - 'null' items: $ref: '#/components/schemas/Mapping' additionalProperties: false ReportTaskConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true reportQueryId: type: string format: uuid queryParameters: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/StraightValueDto' reportFileName: allOf: - $ref: '#/components/schemas/StraightValueDto' reportTTL: allOf: - $ref: '#/components/schemas/StorageTaskTTL' reportSensitivity: allOf: - $ref: '#/components/schemas/StorageTaskSensitivity' additionalProperties: false LoVArrayMap: type: object properties: name: type: - string - 'null' map: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string additionalProperties: false ConfigurationSchemaDto: type: object properties: schema: allOf: - $ref: '#/components/schemas/ConfigurationSchema' additionalProperties: false StraightValue: type: object properties: type: allOf: - $ref: '#/components/schemas/StraightValueType' value: type: - string - 'null' variables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/Variable' additionalProperties: false AiRequestType: enum: - ExternalDataSearchAndCollect - ExternalDataSearchCustomPrompt - ExternalDataSearchGetSummary - ExternalDataGetSchema type: string ErrorProperty: type: object properties: name: allOf: - $ref: '#/components/schemas/TaskErrorProperty' type: allOf: - $ref: '#/components/schemas/VariableType' additionalProperties: false ErrorsProperties: type: object properties: errorsTypesProperties: type: - array - 'null' items: $ref: '#/components/schemas/ErrorProperties' additionalProperties: false SingleVariableDto: type: object properties: category: allOf: - $ref: '#/components/schemas/VariableCategory' taskName: type: - string - 'null' propertyName: type: - string - 'null' additionalProperties: false FuncVariable: type: object properties: type: allOf: - $ref: '#/components/schemas/VariableDefinitionFuncType' jsonPath: type: - string - 'null' variable: allOf: - $ref: '#/components/schemas/SingleVariable' additionalProperties: false OpenApiSchemaSource: enum: - Url - File type: string FormDataPartType: enum: - Text - File type: string MappingCreateRequestDto: type: object properties: sourceSchemaId: type: - string - 'null' targetSchemaId: type: - string - 'null' name: type: - string - 'null' mappingKey: type: - string - 'null' map: allOf: - $ref: '#/components/schemas/Map' additionalProperties: false GlobalVariableAudit: type: object properties: auditId: type: string format: uuid name: type: - string - 'null' operation: allOf: - $ref: '#/components/schemas/AuditOperationType' previousValue: {} newValue: {} updatedAt: type: string format: date-time updatedBy: type: - string - 'null' additionalProperties: false SchemaEntryDto: type: object properties: lookups: type: - array - 'null' items: $ref: '#/components/schemas/LookupDto' dataGroups: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupDto' fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' additionalProperties: false SuperGraphConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true queryFlags: allOf: - $ref: '#/components/schemas/SuperGraphQueryFlagsDto' queryBy: allOf: - $ref: '#/components/schemas/SuperGraphQueryBy' queryByValue: allOf: - $ref: '#/components/schemas/StraightValueDto' additionalProperties: false AiInvokerConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true aiModel: allOf: - $ref: '#/components/schemas/AiModel' requestType: allOf: - $ref: '#/components/schemas/AiRequestType' id: allOf: - $ref: '#/components/schemas/StraightValueDto' providerId: allOf: - $ref: '#/components/schemas/StraightValueDto' apiKey: allOf: - $ref: '#/components/schemas/StraightValueDto' userPrompt: allOf: - $ref: '#/components/schemas/StraightValueDto' systemPrompt: allOf: - $ref: '#/components/schemas/StraightValueDto' entityId: allOf: - $ref: '#/components/schemas/StraightValueDto' searchCriteria: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/StraightValueDto' additionalProperties: false TaskVariable: type: object properties: name: allOf: - $ref: '#/components/schemas/TaskVariableName' type: allOf: - $ref: '#/components/schemas/VariableType' condition: allOf: - $ref: '#/components/schemas/TaskVariableCondition' additionalProperties: false ScheduleLightDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScheduleLightDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationVersionSnapshotDto: type: object properties: name: type: - string - 'null' version: type: integer format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' additionalProperties: false FlowParticipantsDto: type: object properties: contributors: type: - array - 'null' items: $ref: '#/components/schemas/ContributorDto' approver: allOf: - $ref: '#/components/schemas/ApproverDto' submitter: allOf: - $ref: '#/components/schemas/SubmitterDto' additionalProperties: false SchemaSourcePropertiesDto: type: object properties: policy: allOf: - $ref: '#/components/schemas/PolicySchemaPropertiesDto' openApi: allOf: - $ref: '#/components/schemas/OpenApiSchemaPropertiesDto' additionalProperties: false ComplexValueType: enum: - Variable - Json type: string TaskRetryDefinitionDto: type: object properties: maxAttempts: type: integer format: int32 intervalSeconds: type: integer format: int32 backoffRate: type: number format: float maxDelaySeconds: type: integer format: int32 additionalProperties: false FlowDependenciesDto: type: object properties: globalVariables: type: - array - 'null' items: type: string mappings: type: - array - 'null' items: type: string format: uuid schemas: type: - array - 'null' items: type: string format: uuid flows: type: - array - 'null' items: type: string format: uuid schedules: type: - array - 'null' items: type: string format: uuid transformerLibraries: type: - array - 'null' items: type: string additionalProperties: false ConfigurationSchemaErrors: type: object properties: tasksErrors: allOf: - $ref: '#/components/schemas/TasksErrors' errorsProperties: allOf: - $ref: '#/components/schemas/ErrorsProperties' additionalProperties: false EventIngressConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - eventSubtype - eventType - payload - runMode - source - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string source: minLength: 1 type: string payload: allOf: - $ref: '#/components/schemas/ComplexValueDto' runMode: allOf: - $ref: '#/components/schemas/EventIngressRunMode' priority: allOf: - $ref: '#/components/schemas/StraightValue' additionalProperties: false ScheduleLightDto: type: object properties: id: type: string format: uuid scheduleKey: type: - string - 'null' name: type: - string - 'null' flowKey: type: - string - 'null' isEnabled: type: boolean isSystemDisabled: type: - boolean - 'null' systemDisabledReason: type: - string - 'null' additionalProperties: false OpenApiSchemaPropertiesDto: type: object properties: source: allOf: - $ref: '#/components/schemas/OpenApiSchemaSource' model: type: - string - 'null' url: type: - string - 'null' additionalProperties: false InternalApiEndpoint: enum: - GetJourneyInstanceById - CreateEntity - UpdateEntityDraft - LegalEntityIdentifierSearch - LegalEntityAdvancedSearch - CreateEntityDraft - ReopenTask - GetSignificanceResult - GetInternalEntityIdByExDataSubscriptionId - GetDocumentSignedUrl - GetDataSources type: string LoVMap: type: object properties: name: type: - string - 'null' map: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ConfigurationVersionFlatDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationVersionFlatDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Pager: required: - first type: object properties: first: type: integer format: int32 after: type: - string - 'null' additionalProperties: false DataGroupDto: type: object properties: name: type: - string - 'null' friendlyName: type: - string - 'null' fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' additionalProperties: false ObjectInitiatorDto: type: object properties: type: allOf: - $ref: '#/components/schemas/SourceType' config: {} additionalProperties: false InternalApiConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - endpoint - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true endpoint: allOf: - $ref: '#/components/schemas/InternalApiEndpoint' request: allOf: - $ref: '#/components/schemas/ComplexValueDto' additionalProperties: false SchemaFieldType: enum: - Select - MultiSelect - DataGroup - MultiDataGroup - Text - Number - Date - Boolean - Collection type: string StraightValueDto: type: object properties: type: allOf: - $ref: '#/components/schemas/StraightValueType' value: type: - string - 'null' variables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/VariableDto' additionalProperties: false Variable: type: object properties: definitionType: allOf: - $ref: '#/components/schemas/VariableDefinitionType' constantVariable: allOf: - $ref: '#/components/schemas/ConstantVariable' singleVariable: allOf: - $ref: '#/components/schemas/SingleVariable' funcVariable: allOf: - $ref: '#/components/schemas/FuncVariable' additionalProperties: false ComplexValueDto: type: object properties: type: allOf: - $ref: '#/components/schemas/ComplexValueType' variable: allOf: - $ref: '#/components/schemas/VariableDto' json: {} variables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/VariableDto' additionalProperties: false InlineTransformerConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true operation: allOf: - $ref: '#/components/schemas/InlineTransformerTaskOperation' saveToState: type: boolean statePropertyName: type: - string - 'null' leftOperand: allOf: - $ref: '#/components/schemas/ComplexValueDto' rightOperand: allOf: - $ref: '#/components/schemas/ComplexValueDto' withHeaders: type: - boolean - 'null' additionalProperties: false TaskCatchRouteDto: type: object properties: condition: allOf: - $ref: '#/components/schemas/ConditionDto' next: type: - string - 'null' additionalProperties: false MapperConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true mappingId: type: - string - 'null' input: allOf: - $ref: '#/components/schemas/ComplexValueDto' additionalProperties: false SchemaLightDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/SchemaLightDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExecutionVariableName: enum: - ExecutionId - AttemptId - SourceId - CorrelationId - SourceType - Metadata - Request - State - AsyncId - BranchRequest - ForEachRequest type: string ScheduleDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' scheduleKey: type: - string - 'null' scheduleExpression: type: - string - 'null' scheduleTimezone: type: - string - 'null' flowKey: type: - string - 'null' flowInput: type: - string - 'null' isEnabled: type: boolean isSystemDisabled: type: - boolean - 'null' systemDisabledReason: type: - string - 'null' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string PolicySchemaPropertiesDto: type: object properties: jurisdictions: type: - array - 'null' items: type: string categories: type: - array - 'null' items: type: string entityType: type: - string - 'null' targetEntity: type: - string - 'null' additionalProperties: false RouterConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true routes: type: - array - 'null' items: $ref: '#/components/schemas/RouteDto' additionalProperties: false ScheduleCreateRequestDto: type: object properties: name: type: - string - 'null' description: type: - string - 'null' scheduleKey: type: - string - 'null' scheduleExpression: type: - string - 'null' scheduleTimezone: type: - string - 'null' flowKey: type: - string - 'null' flowInput: {} additionalProperties: false StorageTaskTTL: enum: - OneWeek - OneMonth type: string SuperGraphQueryBy: enum: - JourneyId - EntityId type: string VariableDefinitionType: enum: - Constant - Single - Func type: string FileSource: enum: - PersistedStorage - FenergoDocument type: string TaskType: enum: - SuperGraphV1 - TransformerV1 - EventIngressV1 - RouterV1 - MapperV1 - HttpInvokerV2 - WaitV1 - EndV1 - InternalApiV1 - FlowInvokerV1 - StorageV1 - InlineTransformerV1 - ParallelTaskV1 - ForEachTaskV1 - ReportTaskV1 - AiInvokerV1 type: string ParallelTaskConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true branches: type: - array - 'null' items: $ref: '#/components/schemas/ParallelBranchConfigV1Dto' additionalProperties: false SchemaSource: enum: - Manual - Policy - OpenApi type: string ContributorDto: allOf: - $ref: '#/components/schemas/ParticipantDto' - type: object additionalProperties: false FlowVariableDto: type: object properties: name: type: - string - 'null' value: {} type: allOf: - $ref: '#/components/schemas/VariableType' additionalProperties: false UpdateConfigurationVersionRequestDto: type: object properties: name: type: - string - 'null' startTaskKey: type: - string - 'null' flowVariables: type: - array - 'null' items: $ref: '#/components/schemas/FlowVariableDto' tasks: type: - array - 'null' items: $ref: '#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto' additionalProperties: false MappingDto: type: object properties: id: type: string format: uuid sourceSchemaId: type: - string - 'null' targetSchemaId: type: - string - 'null' name: type: - string - 'null' mappingKey: type: - string - 'null' map: allOf: - $ref: '#/components/schemas/Map' additionalProperties: false EventIngressRunMode: enum: - FireAndForget - Sync - Async type: string SignConfigurationDraftRequest: required: - decision type: object properties: decision: allOf: - $ref: '#/components/schemas/Decision' comment: type: - string - 'null' additionalProperties: false TaskVariableCondition: type: object properties: propertyName: type: - string - 'null' values: type: - array - 'null' items: type: string additionalProperties: false TaskRetryDto: type: object properties: rules: type: - array - 'null' items: $ref: '#/components/schemas/TaskRetryRuleDto' default: allOf: - $ref: '#/components/schemas/TaskRetryDefinitionDto' additionalProperties: false VariableCategory: enum: - Global - Flow - Execution - Task type: string ConfigurationVersionFlatDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationVersionFlatDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationSchemaSources: type: object properties: sources: type: - array - 'null' items: $ref: '#/components/schemas/Source' additionalProperties: false GuidServiceResponse: type: object properties: data: type: string format: uuid messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AuditOperationType: enum: - Create - Edit - Delete type: string TaskErrorProperty: enum: - HttpStatusCode - HttpResponseBody - HttpRawResponse - JsErrorCode - JsErrorMessage - JsUnhandledErrorMessage - SuperGraphErrors - EventId - InternalApiErrorDetails - FailedBranches - Responses - FailedIterations - ReportErrorMessage - AiInvokerErrorMessage type: string ContentType: enum: - None - Json - Xml - Text - FormUrlEncoded - FormData - BinaryFile type: string EndConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true flowOutput: allOf: - $ref: '#/components/schemas/ComplexValueDto' additionalProperties: false TaskVariableName: enum: - ResponseBody - RawResponse - StatusCode - Output - FormattedResponse - EventId - ResponseHeaders - CallbackRequest - EventResponse - OperationOutput - StorageRecord - RecordsList - Responses - StorageKey - ContentType - Error type: string CreateConfigurationVersionDto: required: - flowKey - initiator - name type: object properties: name: minLength: 1 type: string flowKey: maxLength: 30 minLength: 6 pattern: '[a-zA-Z0-9_-]+' type: string initiator: allOf: - $ref: '#/components/schemas/ObjectInitiatorDto' notes: maxLength: 1000 type: - string - 'null' additionalProperties: false SourceType: enum: - Unknown - Journey - ExternalData - Api - Policy - Scheduler type: string ConfigurationSchemaDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationSchemaDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false TaskErrors: type: object properties: type: allOf: - $ref: '#/components/schemas/TaskType' errors: type: - array - 'null' items: $ref: '#/components/schemas/TaskErrorSchema' additionalProperties: false TasksVariables: type: object properties: tasksTypesVariables: type: - array - 'null' items: $ref: '#/components/schemas/TaskVariables' additionalProperties: false ConfigurationFlatDto: type: object properties: configurationId: type: string format: uuid flowKey: type: - string - 'null' initiatorType: allOf: - $ref: '#/components/schemas/SourceType' created: type: string format: date-time currentConfiguration: allOf: - $ref: '#/components/schemas/ConfigurationVersionSnapshotDto' latestConfiguration: allOf: - $ref: '#/components/schemas/ConfigurationVersionSnapshotDto' additionalProperties: false MappingDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/MappingDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ObjectToTextProperties: type: object properties: separator: type: - string - 'null' fields: type: - array - 'null' items: $ref: '#/components/schemas/ObjectField' selector: allOf: - $ref: '#/components/schemas/ObjectSelector' additionalProperties: false GlobalVariableDto: type: object properties: name: type: - string - 'null' value: {} type: allOf: - $ref: '#/components/schemas/VariableType' additionalProperties: false GlobalVariableAuditPaginatedResponse: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/GlobalVariableAudit' nextToken: type: - string - 'null' hasNextPage: type: boolean additionalProperties: false StorageConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true operation: allOf: - $ref: '#/components/schemas/StorageTaskOperation' key: allOf: - $ref: '#/components/schemas/StraightValueDto' prefix: allOf: - $ref: '#/components/schemas/StraightValueDto' value: allOf: - $ref: '#/components/schemas/ComplexValueDto' ttl: allOf: - $ref: '#/components/schemas/StorageTaskTTL' sensitivity: allOf: - $ref: '#/components/schemas/StorageTaskSensitivity' partialRead: type: - boolean - 'null' withHeaders: type: - boolean - 'null' batchSize: allOf: - $ref: '#/components/schemas/StraightValueDto' startBytePosition: allOf: - $ref: '#/components/schemas/StraightValueDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false Map: type: object properties: mappings: type: - array - 'null' items: $ref: '#/components/schemas/Mapping' loVMaps: type: - array - 'null' items: $ref: '#/components/schemas/LoVMap' loVArrayMaps: type: - array - 'null' items: $ref: '#/components/schemas/LoVArrayMap' additionalProperties: false ConfigurationVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false TaskRetryRuleDto: type: object properties: condition: allOf: - $ref: '#/components/schemas/ConditionDto' definition: allOf: - $ref: '#/components/schemas/TaskRetryDefinitionDto' additionalProperties: false GlobalVariableAuditPaginatedResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GlobalVariableAuditPaginatedResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ForEachTasksConfigV1Dto: type: object properties: tasks: type: - array - 'null' items: $ref: '#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto' startTaskKey: type: - string - 'null' additionalProperties: false StraightValueType: enum: - Pattern type: string TaskCatchDto: type: object properties: routes: type: - array - 'null' items: $ref: '#/components/schemas/TaskCatchRouteDto' default: type: - string - 'null' additionalProperties: false FlowInvokerConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true runMode: allOf: - $ref: '#/components/schemas/FlowInvokerRunMode' flowKey: type: - string - 'null' flowRequest: allOf: - $ref: '#/components/schemas/ComplexValueDto' mapToRequestBody: type: boolean callbackTimeout: type: - string - 'null' additionalProperties: false TransformerConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true input: allOf: - $ref: '#/components/schemas/ComplexValueDto' originalMapMethod: type: - string - 'null' transpiledMapMethod: type: - string - 'null' includeLookups: type: boolean inputSchemaId: type: - string - 'null' outputSchemaId: type: - string - 'null' includedSchemas: type: - array - 'null' items: type: string libraries: type: - array - 'null' items: type: string additionalProperties: false VariableDto: type: object properties: definitionType: allOf: - $ref: '#/components/schemas/VariableDefinitionType' constantVariable: allOf: - $ref: '#/components/schemas/ConstantVariableDto' singleVariable: allOf: - $ref: '#/components/schemas/SingleVariableDto' funcVariable: allOf: - $ref: '#/components/schemas/FuncVariableDto' additionalProperties: false TaskConfigBaseDtoIntegrationTaskDto: required: - key - name type: object properties: name: minLength: 1 type: string key: minLength: 1 type: string next: type: - string - 'null' config: oneOf: - $ref: '#/components/schemas/AiInvokerConfigV1Dto' - $ref: '#/components/schemas/EndConfigV1Dto' - $ref: '#/components/schemas/EventIngressConfigV1Dto' - $ref: '#/components/schemas/FlowInvokerConfigV1Dto' - $ref: '#/components/schemas/ForEachTaskConfigV1Dto' - $ref: '#/components/schemas/HttpInvokerConfigV2Dto' - $ref: '#/components/schemas/InlineTransformerConfigV1Dto' - $ref: '#/components/schemas/InternalApiConfigV1Dto' - $ref: '#/components/schemas/MapperConfigV1Dto' - $ref: '#/components/schemas/ParallelTaskConfigV1Dto' - $ref: '#/components/schemas/ReportTaskConfigV1Dto' - $ref: '#/components/schemas/RouterConfigV1Dto' - $ref: '#/components/schemas/StorageConfigV1Dto' - $ref: '#/components/schemas/SuperGraphConfigV1Dto' - $ref: '#/components/schemas/TransformerConfigV1Dto' - $ref: '#/components/schemas/WaitConfigV1Dto' additionalProperties: false VariableDefinitionFuncType: enum: - JsonPath - Pattern type: string SubmitterDto: allOf: - $ref: '#/components/schemas/ParticipantDto' - type: object additionalProperties: false FormDataPartDto: required: - name - partType type: object properties: name: minLength: 1 type: string partType: allOf: - $ref: '#/components/schemas/FormDataPartType' value: allOf: - $ref: '#/components/schemas/StraightValueDto' fileSource: allOf: - $ref: '#/components/schemas/FileSource' storageKey: allOf: - $ref: '#/components/schemas/StraightValueDto' documentUrl: allOf: - $ref: '#/components/schemas/StraightValueDto' partContentType: type: - string - 'null' filename: allOf: - $ref: '#/components/schemas/StraightValueDto' additionalProperties: false ScheduleUpdateRequestDto: type: object properties: name: type: - string - 'null' description: type: - string - 'null' scheduleExpression: type: - string - 'null' scheduleTimezone: type: - string - 'null' flowKey: type: - string - 'null' flowInput: {} isEnabled: type: boolean additionalProperties: false ExecutionVariables: type: object properties: variables: type: - array - 'null' items: $ref: '#/components/schemas/ExecutionVariable' additionalProperties: false MappingLightDto: type: object properties: id: type: string format: uuid sourceSchemaId: type: - string - 'null' targetSchemaId: type: - string - 'null' name: type: - string - 'null' mappingKey: type: - string - 'null' additionalProperties: false SchemaDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' schemaKey: type: - string - 'null' source: allOf: - $ref: '#/components/schemas/SchemaSource' sourceProperties: allOf: - $ref: '#/components/schemas/SchemaSourcePropertiesDto' schemaEntry: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false MappingUpdateRequestDto: type: object properties: sourceSchemaId: type: - string - 'null' targetSchemaId: type: - string - 'null' name: type: - string - 'null' map: allOf: - $ref: '#/components/schemas/Map' additionalProperties: false TaskConfigBaseDto: required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true catch: allOf: - $ref: '#/components/schemas/TaskCatchDto' retry: allOf: - $ref: '#/components/schemas/TaskRetryDto' additionalProperties: false ConfigurationSchemaVariables: type: object properties: executionVariables: allOf: - $ref: '#/components/schemas/ExecutionVariables' tasksVariables: allOf: - $ref: '#/components/schemas/TasksVariables' additionalProperties: false ConfigurationVersionFlatDto: type: object properties: configurationId: type: string format: uuid name: type: - string - 'null' flowKey: type: - string - 'null' versionNumber: type: integer format: int32 initiatorType: allOf: - $ref: '#/components/schemas/SourceType' versionStatus: allOf: - $ref: '#/components/schemas/VersionStatus' created: type: string format: date-time additionalProperties: false ConfigurationVersionFlatDtoPaginatedResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationVersionFlatDtoPaginatedResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConditionOperator: enum: - Equals - GreaterThan - LowerThan - GreaterThanOrEquals - LowerThanOrEquals - IsNull - StringContains - NotEquals - IsNotNull - StringNotContains - IsTrue - IsFalse type: string SchemaLightDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' schemaKey: type: - string - 'null' additionalProperties: false SchemaCreateRequestDto: type: object properties: name: type: - string - 'null' schemaKey: type: - string - 'null' source: allOf: - $ref: '#/components/schemas/SchemaSource' sourceProperties: allOf: - $ref: '#/components/schemas/SchemaSourcePropertiesDto' schemaEntry: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false ParallelBranchConfigV1Dto: type: object properties: name: type: - string - 'null' input: allOf: - $ref: '#/components/schemas/ComplexValueDto' tasks: type: - array - 'null' items: $ref: '#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto' startTaskKey: type: - string - 'null' additionalProperties: false ApproverDto: allOf: - $ref: '#/components/schemas/ParticipantDto' - type: object properties: isApproved: type: boolean additionalProperties: false ObjectField: type: object properties: name: type: - string - 'null' order: type: integer format: int32 isLoV: type: boolean loVMapName: type: - string - 'null' additionalProperties: false FieldDto: type: object properties: name: type: - string - 'null' friendlyName: type: - string - 'null' type: allOf: - $ref: '#/components/schemas/SchemaFieldType' required: type: boolean description: type: - string - 'null' lookup: type: - string - 'null' reference: type: - string - 'null' collectionType: allOf: - $ref: '#/components/schemas/SchemaFieldType' fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' isExtensible: type: - boolean - 'null' additionalProperties: false HttpInvokerConfigV2Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true url: allOf: - $ref: '#/components/schemas/StraightValueDto' method: type: - string - 'null' contentType: allOf: - $ref: '#/components/schemas/ContentType' customContentType: type: - string - 'null' headers: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/StraightValueDto' queryParams: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/StraightValueDto' body: allOf: - $ref: '#/components/schemas/ComplexValueDto' formValues: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/StraightValueDto' formParts: type: - array - 'null' items: $ref: '#/components/schemas/FormDataPartDto' timeout: type: - string - 'null' isCallback: type: boolean callbackTimeout: type: - string - 'null' largeResponse: type: boolean storageKey: allOf: - $ref: '#/components/schemas/StraightValue' storageTTL: allOf: - $ref: '#/components/schemas/StorageTaskTTL' storageSensitivity: allOf: - $ref: '#/components/schemas/StorageTaskSensitivity' sendStorageFile: type: boolean requestStorageKey: allOf: - $ref: '#/components/schemas/StraightValue' fileSource: allOf: - $ref: '#/components/schemas/FileSource' requestDocumentUrl: allOf: - $ref: '#/components/schemas/StraightValue' additionalProperties: false FuncVariableDto: type: object properties: type: allOf: - $ref: '#/components/schemas/VariableDefinitionFuncType' jsonPath: type: - string - 'null' variable: allOf: - $ref: '#/components/schemas/SingleVariableDto' additionalProperties: false ScheduleDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ScheduleDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExecutionVariable: type: object properties: name: allOf: - $ref: '#/components/schemas/ExecutionVariableName' type: allOf: - $ref: '#/components/schemas/VariableType' additionalProperties: false GlobalVariableDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/GlobalVariableDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationVersionDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' flowKey: type: - string - 'null' startTaskKey: type: - string - 'null' initiator: allOf: - $ref: '#/components/schemas/ObjectInitiatorDto' flowVariables: type: - array - 'null' items: $ref: '#/components/schemas/FlowVariableDto' tasks: type: - array - 'null' items: $ref: '#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto' versionNumber: type: integer format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' created: type: string format: date-time notes: type: - string - 'null' participants: allOf: - $ref: '#/components/schemas/FlowParticipantsDto' flowDependencies: allOf: - $ref: '#/components/schemas/FlowDependenciesDto' importedFromTemplate: allOf: - $ref: '#/components/schemas/TemplateOriginDto' additionalProperties: false SourceProperty: type: object properties: name: allOf: - $ref: '#/components/schemas/SourcePropertyName' type: allOf: - $ref: '#/components/schemas/VariableType' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SourcePropertyName: enum: - journeyId - taskId - userId - id - providerId - type - request - path - contentType - headers - queryParams - body - bodyFormData - bodyRaw - entityId - entityDraftId - suggestionId - searchFields - fieldName - fieldValue - fields - executionTime - scheduleKey - input type: string FlowInvokerRunMode: enum: - FireAndForget - Async type: string ConstantVariable: type: object properties: value: type: - string - 'null' additionalProperties: false MappingLightDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/MappingLightDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigurationFlatDtoPaginatedResponse: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationFlatDto' nextToken: type: - string - 'null' hasNextPage: type: boolean additionalProperties: false SuperGraphQueryFlagsDto: type: object properties: includeStages: type: boolean includeEntity: type: boolean includeEntityDrafts: type: boolean includeRelatedParties: type: boolean includeProductDrafts: type: boolean includeProductAssociations: type: boolean includeJourneys: type: boolean additionalProperties: false ForEachTaskConfigV1Dto: allOf: - $ref: '#/components/schemas/TaskConfigBaseDto' - required: - taskType type: object properties: taskType: allOf: - $ref: '#/components/schemas/TaskType' readOnly: true itemsToProcess: allOf: - $ref: '#/components/schemas/ComplexValueDto' processInput: allOf: - $ref: '#/components/schemas/ComplexValueDto' iterationTasks: allOf: - $ref: '#/components/schemas/ForEachTasksConfigV1Dto' additionalProperties: false ErrorProperties: type: object properties: type: allOf: - $ref: '#/components/schemas/TaskErrorType' properties: type: - array - 'null' items: $ref: '#/components/schemas/ErrorProperty' additionalProperties: false SchemaDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SchemaDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StorageTaskSensitivity: enum: - Sensitive - NotSensitive type: string securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header