{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Integration Core Api",
"description": "**Integration Core API**:\n\n
Integration Core BFF API allows to create and access integration flows and its' executions. \n\n",
"version": "1.0"
},
"servers": [
{
"url": "/integrationcore"
}
],
"paths": {
"/api/authConfiguration": {
"get": {
"tags": [
"AuthConfiguration"
],
"summary": "Gets all Auth Configurations",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationAccess",
"operationId": "GetAllAuthConfigurations",
"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/AuthConfigurationDtoIReadOnlyCollectionServiceResponse"
}
}
}
},
"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/authConfiguration/flow/{flowId}": {
"get": {
"tags": [
"AuthConfiguration"
],
"summary": "Gets an Auth Configuration by Integration Flow Id",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationAccess",
"operationId": "GetAuthConfigByFlowId",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Integration Flow Id or Flow Key",
"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/AuthConfigurationDtoServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
},
"put": {
"tags": [
"AuthConfiguration"
],
"summary": "Creates or updates Integration Flow Auth Configuration",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationEdit
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationEdit",
"operationId": "SaveAuthConfiguration",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Integration Flow Id or Flow Key",
"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": "Configuration Details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SaveAuthConfigurationRequestDto"
}
]
}
}
}
},
"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": [
"AuthConfiguration"
],
"summary": "Deletes an existing Integration Flow Auth Configuration",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationEdit
Required permissions:
Following permissions are required: IntegrationFlowsAuthConfigurationEdit",
"operationId": "DeleteAuthConfiguration",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Integration Flow Id or Flow Key",
"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"
},
"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/{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"
}
]
}
}
}
}
}
}
},
"/api/execution/{executionId}": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets a specific execution by its ID.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "GetExecution",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The ID of the execution.",
"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": {
"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/ExecutionDtoServiceResponse"
}
}
}
},
"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/execution/flow/{flowId}": {
"post": {
"tags": [
"Execution"
],
"summary": "Start execution.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowApiTrigger
Required permissions:
Following permissions are required: IntegrationFlowsFlowApiTrigger",
"operationId": "StartExecution",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Either the ID or the Flow Key of the flow 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": "Request.",
"content": {
"application/json": {
"schema": { }
}
}
},
"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"
}
]
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartExecutionResponseDtoServiceResponse"
}
}
}
},
"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/execution/test/flow/{flowId}": {
"post": {
"tags": [
"Execution"
],
"summary": "Start test execution.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowApiTrigger
Required permissions:
Following permissions are required: IntegrationFlowsFlowApiTrigger",
"operationId": "StartTestExecution",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Either the ID or the Flow Key of the flow configuration.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mapToRequestBody",
"in": "query",
"description": "Map Input to Request.Body or full Request",
"schema": {
"type": "boolean",
"default": true
}
},
{
"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": "Request.",
"content": {
"application/json": {
"schema": { }
}
}
},
"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"
}
]
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartExecutionResponseDtoServiceResponse"
}
}
}
},
"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/execution/debug/flow/{flowId}/version/{versionNumber}": {
"post": {
"tags": [
"Execution"
],
"summary": "Start Execution in Debug mode.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsTestExecution
Required permissions:
Following permissions are required: IntegrationFlowsTestExecution",
"operationId": "DebugExecution",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Either the ID or the Flow Key of the flow configuration.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "The flow version number.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "mapToRequestBody",
"in": "query",
"description": "Map Input to Request.Body or full Request",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "newExecutionAttempt",
"in": "query",
"description": "Create New Attempt in existing Execution",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sourceExecutionId",
"in": "query",
"description": "The source/base Execution Id",
"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": "Request.",
"content": {
"application/json": {
"schema": { }
}
}
},
"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"
}
]
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartExecutionResponseDtoServiceResponse"
}
}
}
},
"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/execution/debug/transformer": {
"post": {
"tags": [
"Execution"
],
"summary": "Test Transformer task",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsTestTransformerTask
Required permissions:
Following permissions are required: IntegrationFlowsTestTransformerTask",
"operationId": "DebugTransformerTask",
"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": "Transformer task request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DebugTransformerTaskRequestDto"
}
]
}
}
}
},
"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"
}
]
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugTransformerTaskResponseDtoServiceResponse"
}
}
}
},
"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/execution/callback/{asyncId}": {
"post": {
"tags": [
"Execution"
],
"summary": "Callback the flow execution.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowTaskRetry
Required permissions:
Following permissions are required: IntegrationFlowsFlowTaskRetry",
"operationId": "CallbackExecution",
"parameters": [
{
"name": "asyncId",
"in": "path",
"description": "Flow Execution Async Id",
"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": "Request.",
"content": {
"application/json": {
"schema": { }
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"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/execution/{executionId}/retry": {
"post": {
"tags": [
"Execution"
],
"summary": "Retries specific execution.",
"description": "
Required permissions:
At least one of the following permissions is required: IntegrationFlowsFlowTaskRetry, IntegrationFlowsFlowExecutionRetry
Required permissions:
At least one of the following permissions is required: IntegrationFlowsFlowTaskRetry, IntegrationFlowsFlowExecutionRetry",
"operationId": "RetryExecution",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The Id of the Execution to retry.",
"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"
}
}
}
},
"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/execution/{executionId}/cancel": {
"post": {
"tags": [
"Execution"
],
"summary": "Cancels a specific in-progress or paused execution.",
"description": "
Required permissions:
At least one of the following permissions is required: IntegrationFlowsFlowTaskRetry, IntegrationFlowsFlowExecutionRetry
Required permissions:
At least one of the following permissions is required: IntegrationFlowsFlowTaskRetry, IntegrationFlowsFlowExecutionRetry",
"operationId": "CancelExecution",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The Id of the Execution to cancel.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelExecutionResponseDtoServiceResponse"
}
}
}
},
"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/execution/source/{sourceId}": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets all executions for a specific source ID.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "GetExecutionsBySource",
"parameters": [
{
"name": "sourceId",
"in": "path",
"description": "The source ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"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/ExecutionDtoIEnumerableServiceResponse"
}
}
}
},
"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/execution/{executionId}/attempt/{attemptId}/step-logs/{stepLogId}/data": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets step log data for step log.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionDetailsRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionDetailsRead",
"operationId": "GetStepData",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The ID of the execution.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attemptId",
"in": "path",
"description": "The ID of the execution attempt.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepLogId",
"in": "path",
"description": "The ID of the step log",
"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": {
"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/StepDataDtoServiceResponse"
}
}
}
},
"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/execution/{executionId}/attempt/{attemptId}/step-logs/{stepLogId}/signedurl": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets a signed URL for step log data.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionDetailsRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionDetailsRead",
"operationId": "GetStepDataSignedUrl",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The ID of the execution.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attemptId",
"in": "path",
"description": "The ID of the execution attempt.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepLogId",
"in": "path",
"description": "The ID of the step log",
"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": {
"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/StringServiceResponse"
}
}
}
},
"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/execution/{executionId}/attempt/{attemptId}/step-logs": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets all step logs for an execution attempt.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "GetStepLogsFromExecutionAttempt",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The ID of the execution.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "attemptId",
"in": "path",
"description": "The ID of the execution attempt.",
"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": {
"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/GetStepLogsResponseServiceResponse"
}
}
}
},
"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/execution/{executionId}/step-logs/latest": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets all step logs for latest execution attempt.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "GetStepLogsFromLatestExecutionAttempt",
"parameters": [
{
"name": "executionId",
"in": "path",
"description": "The ID of the execution.",
"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": {
"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/ExecutionStepLogDtoIEnumerableServiceResponse"
}
}
}
},
"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/execution/search": {
"post": {
"tags": [
"Execution"
],
"summary": "Gets all executions for specific filters. All parameters are optional.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "searchExecutionsByFilters",
"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 request containing properties to filter the data.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SearchExecutionsByFilterRequest"
}
]
}
}
}
},
"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/ExecutionFilteredDtoPaginatedResponseServiceResponse"
}
}
}
},
"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/execution/limits": {
"get": {
"tags": [
"Execution"
],
"summary": "Gets executions current limits.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "GetExecutionsLimits",
"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/ComplexityBucketLimitsDtoIEnumerableServiceResponse"
}
}
}
},
"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/execution/metrics": {
"get": {
"tags": [
"Execution"
],
"summary": "Retrieves CloudWatch metric data for the specified parameters.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead
Required permissions:
Following permissions are required: IntegrationFlowsFlowExecutionRead",
"operationId": "GetMetrics",
"parameters": [
{
"name": "MetricBucketName",
"in": "query",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MetricBucketName"
}
]
}
},
{
"name": "StartDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Statistic",
"in": "query",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MetricStatistic"
}
]
}
},
{
"name": "Period",
"in": "query",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MetricPeriod"
}
]
}
},
{
"name": "MetricName",
"in": "query",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MetricName"
}
]
}
},
{
"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/MetricsResultDtoServiceResponse"
}
}
}
},
"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/flowTemplates": {
"get": {
"tags": [
"FlowTemplate"
],
"summary": "Get all available active flow templates (lightweight — no flow definition)",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess",
"operationId": "GetAvailableTemplates",
"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/FlowTemplateLightDtoIEnumerableServiceResponse"
}
}
}
},
"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/flowTemplates/{templateKey}": {
"get": {
"tags": [
"FlowTemplate"
],
"summary": "Get a specific flow template by key including full flow definition",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess",
"operationId": "GetTemplateByKey",
"parameters": [
{
"name": "templateKey",
"in": "path",
"description": "The unique template key",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "Optional specific version number; defaults to latest active",
"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/FlowTemplateDtoServiceResponse"
}
}
}
},
"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/flowTemplates/{templateKey}/import": {
"post": {
"tags": [
"FlowTemplate"
],
"summary": "Import a flow template — creates a new draft flow configuration from the template",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit",
"operationId": "ImportFlowTemplate",
"parameters": [
{
"name": "templateKey",
"in": "path",
"description": "The unique template key to import",
"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": "Import request details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ImportFlowTemplateRequestDto"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportFlowTemplateResponseDtoServiceResponse"
}
}
}
},
"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/flowTemplates/managedFlows/{configurationId}/unlock": {
"put": {
"tags": [
"FlowTemplate"
],
"summary": "Unlocks a managed flow configuration for editing — a one-way, irreversible operation.\nOnce unlocked, the flow is no longer eligible for template version updates.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit",
"operationId": "UnlockManagedFlowForEdit",
"parameters": [
{
"name": "configurationId",
"in": "path",
"description": "The ID of the managed flow configuration to unlock",
"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",
"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/flowTemplates/managedFlows/{configurationId}/updateToTemplateVersion": {
"put": {
"tags": [
"FlowTemplate"
],
"summary": "Updates a managed flow configuration to the latest version of its source template.\nFails if the flow has been unlocked for editing.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit",
"operationId": "UpdateManagedFlowToTemplateVersion",
"parameters": [
{
"name": "configurationId",
"in": "path",
"description": "The ID of the managed flow configuration 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"
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateManagedFlowResponseServiceResponse"
}
}
}
},
"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/storage": {
"post": {
"tags": [
"PersistedStorage"
],
"summary": "Search for persisted storage records based on the provided pager details.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsPersistedStorageAccess
Required permissions:
Following permissions are required: IntegrationFlowsPersistedStorageAccess",
"operationId": "SearchRecords",
"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": "Peristed Storage Pager Details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Pager"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorageObjectDtoPaginatedResponseServiceResponse"
}
}
}
},
"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/storage/upload": {
"post": {
"tags": [
"PersistedStorage"
],
"summary": "Creates a persisted storage metadata record in Processing state and returns a pre-signed upload URL.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsPersistedStorageAccess
Required permissions:
Following permissions are required: IntegrationFlowsPersistedStorageAccess",
"operationId": "UploadDocument",
"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": "Upload request payload",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UploadDocumentRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentResponseServiceResponse"
}
}
}
},
"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/storage/record/{fileKey}": {
"get": {
"tags": [
"PersistedStorage"
],
"summary": "Gets a signed URL for a specific storage record.",
"description": "
Required permissions:
At least one of the following permissions is required: IntegrationFlowsPersistedStorageGet, IntegrationFlowsPersistedStorageGetSensitive
Required permissions:
At least one of the following permissions is required: IntegrationFlowsPersistedStorageGet, IntegrationFlowsPersistedStorageGetSensitive",
"operationId": "GetSignedUrl",
"parameters": [
{
"name": "fileKey",
"in": "path",
"description": "Peristed Storage File Key",
"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/StringServiceResponse"
}
}
}
},
"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": [
"PersistedStorage"
],
"summary": "Deletes an existing persisted storage record",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsPersistedStorageDelete
Required permissions:
Following permissions are required: IntegrationFlowsPersistedStorageDelete",
"operationId": "DeleteRecord",
"parameters": [
{
"name": "fileKey",
"in": "path",
"description": "Peristed Storage File Key",
"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"
},
"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/task/internalApi/endpoints": {
"get": {
"tags": [
"Tasks"
],
"summary": "Gets InternalApi task endpoints",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess",
"operationId": "GetInternalApiEndpointsList",
"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/InternalApiEndpointDtoIEnumerableServiceResponse"
}
}
}
},
"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/task/internalApi/endpoints/{endpoint}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Gets Internal Api Endpoint Sample Request",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess",
"operationId": "GetInternalApiEndpointConfiguration",
"parameters": [
{
"name": "endpoint",
"in": "path",
"description": "The internal API endpoint",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InternalApiEndpoint"
}
]
}
},
{
"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/InternalApiEndpointConfigurationDtoServiceResponse"
}
}
}
},
"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/transformerLibraries/library/{libraryKey}/draft": {
"post": {
"tags": [
"TransformerLibrary"
],
"summary": "Creates a new draft version for an existing transformer library.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationEdit",
"operationId": "CreateTransformerLibraryDraft",
"parameters": [
{
"name": "libraryKey",
"in": "path",
"description": "The library key of the library to create a new draft for.",
"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": "Optional data transfer object containing notes for the new draft version.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateTransformerLibraryDraftDto"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuidServiceResponse"
}
}
}
},
"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/transformerLibraries/library/generate-types": {
"post": {
"tags": [
"TransformerLibrary"
],
"summary": "Generates TypeScript type declarations from an OpenAPI specification using NSwag.",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess",
"operationId": "GenerateTypesFromOpenApi",
"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 OpenAPI spec and generation options.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GenerateTypesFromOpenApiRequestDto"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateTypesFromOpenApiResponseDtoServiceResponse"
}
}
}
},
"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/transformerLibraries/library/fetch-openapi-spec": {
"post": {
"tags": [
"TransformerLibrary"
],
"summary": "Fetches an OpenAPI specification from a remote URL (server-side proxy to avoid CORS).",
"description": "
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess
Required permissions:
Following permissions are required: IntegrationFlowsConfigurationAccess",
"operationId": "FetchOpenApiSpec",
"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 URL to fetch.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FetchOpenApiSpecRequestDto"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchOpenApiSpecResponseDtoServiceResponse"
}
}
}
},
"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": {
"AICodeGenerationRequestDto": {
"required": [
"prompt",
"typeDefinitions"
],
"type": "object",
"properties": {
"prompt": {
"minLength": 1,
"type": "string"
},
"typeDefinitions": {
"minLength": 1,
"type": "string"
},
"currentCode": {
"type": "string",
"nullable": true
},
"taskName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AIGenerationResultDto": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"generatedCode": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AIGenerationResultDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AIGenerationResultDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"AILibraryCodeGenerationRequestDto": {
"required": [
"prompt"
],
"type": "object",
"properties": {
"prompt": {
"minLength": 1,
"type": "string"
},
"typeDefinitions": {
"type": "string",
"nullable": true
},
"currentCode": {
"type": "string",
"nullable": true
},
"libraryKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AITroubleshootingRequestDto": {
"required": [
"attemptId",
"flowExecutionId"
],
"type": "object",
"properties": {
"flowExecutionId": {
"minLength": 1,
"type": "string"
},
"attemptId": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"AITroubleshootingResultDto": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"analysis": {
"allOf": [
{
"$ref": "#/components/schemas/TroubleshootingAnalysisDto"
}
],
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AITroubleshootingResultDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AITroubleshootingResultDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"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"
}
],
"nullable": true
},
"requestType": {
"allOf": [
{
"$ref": "#/components/schemas/AiRequestType"
}
],
"nullable": true
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"providerId": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"apiKey": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"userPrompt": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"systemPrompt": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"entityId": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"searchCriteria": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/StraightValueDto"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"AiModel": {
"enum": [
"GPT5",
"GPT4o",
"O3",
"NovaPremier"
],
"type": "string"
},
"AiRequestType": {
"enum": [
"ExternalDataSearchAndCollect",
"ExternalDataSearchCustomPrompt",
"ExternalDataSearchGetSummary",
"ExternalDataGetSchema"
],
"type": "string"
},
"ApproverDto": {
"allOf": [
{
"$ref": "#/components/schemas/ParticipantDto"
},
{
"type": "object",
"properties": {
"isApproved": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"AttemptDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/AttemptStatus"
}
]
},
"configurationVersion": {
"type": "integer",
"format": "int32"
},
"dateStarted": {
"type": "string",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionError"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"AttemptStatus": {
"enum": [
"InProgress",
"Success",
"Failed",
"Paused"
],
"type": "string"
},
"AuditOperationType": {
"enum": [
"Create",
"Edit",
"Delete"
],
"type": "string"
},
"AuthConfigDetailDto": {
"type": "object",
"properties": {
"authenticationMethod": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticationMethod"
}
]
}
},
"additionalProperties": false
},
"AuthConfigurationDto": {
"type": "object",
"properties": {
"flowId": {
"type": "string",
"format": "uuid"
},
"flowKey": {
"type": "string",
"nullable": true
},
"configurationDetails": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/IpWhitelistingAuthConfigurationDto"
},
{
"$ref": "#/components/schemas/SharedKeyAuthConfigurationDto"
},
{
"$ref": "#/components/schemas/HmacAuthConfigurationDto"
}
]
},
"nullable": true
},
"callbackDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallbackAuthConfigDetailDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"AuthConfigurationDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthConfigurationDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"AuthConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AuthConfigurationDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"AuthenticationMethod": {
"enum": [
"IpWhitelist",
"SharedKey",
"Hmac"
],
"type": "string"
},
"CallbackAuthConfigDetailDto": {
"type": "object",
"properties": {
"asyncKey": {
"type": "string",
"nullable": true
},
"authDetails": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/IpWhitelistingAuthConfigurationDto"
},
{
"$ref": "#/components/schemas/SharedKeyAuthConfigurationDto"
},
{
"$ref": "#/components/schemas/HmacAuthConfigurationDto"
}
]
},
"nullable": true
}
},
"additionalProperties": false
},
"CancelExecutionResponseDto": {
"type": "object",
"properties": {
"executionId": {
"type": "string",
"format": "uuid"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/AttemptStatus"
}
]
},
"isSuccess": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CancelExecutionResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CancelExecutionResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ComplexValueDto": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueType"
}
]
},
"variable": {
"allOf": [
{
"$ref": "#/components/schemas/VariableDto"
}
],
"nullable": true
},
"json": {
"nullable": true
},
"variables": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/VariableDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ComplexValueType": {
"enum": [
"Variable",
"Json"
],
"type": "string"
},
"ComplexityBucketLimitsDto": {
"type": "object",
"properties": {
"bucketName": {
"type": "string",
"nullable": true
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplexityBucketRuleLimitDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ComplexityBucketLimitsDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplexityBucketLimitsDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ComplexityBucketRuleLimitDto": {
"type": "object",
"properties": {
"timeWindow": {
"type": "string",
"format": "date-span"
},
"currentQuota": {
"type": "integer",
"format": "int32"
},
"remainingQuota": {
"type": "integer",
"format": "int32"
},
"limitQuota": {
"type": "integer",
"format": "int32"
},
"expirySeconds": {
"type": "integer",
"format": "int32"
}
},
"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
},
"ConditionOperator": {
"enum": [
"Equals",
"GreaterThan",
"LowerThan",
"GreaterThanOrEquals",
"LowerThanOrEquals",
"IsNull",
"StringContains",
"NotEquals",
"IsNotNull",
"StringNotContains",
"IsTrue",
"IsFalse"
],
"type": "string"
},
"ConfigurationFlatDto": {
"type": "object",
"properties": {
"configurationId": {
"type": "string",
"format": "uuid"
},
"flowKey": {
"type": "string",
"nullable": true
},
"initiatorType": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
},
"created": {
"type": "string",
"format": "date-time"
},
"currentConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationVersionSnapshotDto"
}
],
"nullable": true
},
"latestConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationVersionSnapshotDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationFlatDtoPaginatedResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationFlatDto"
},
"nullable": true
},
"nextToken": {
"type": "string",
"nullable": true
},
"hasNextPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ConfigurationFlatDtoPaginatedResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationFlatDtoPaginatedResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationSchema": {
"type": "object",
"properties": {
"schemaVariables": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationSchemaVariables"
}
],
"nullable": true,
"readOnly": true
},
"schemaSources": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationSchemaSources"
}
],
"nullable": true,
"readOnly": true
},
"schemaErrors": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationSchemaErrors"
}
],
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ConfigurationSchemaDto": {
"type": "object",
"properties": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationSchema"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationSchemaDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationSchemaDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationSchemaErrors": {
"type": "object",
"properties": {
"tasksErrors": {
"allOf": [
{
"$ref": "#/components/schemas/TasksErrors"
}
],
"nullable": true
},
"errorsProperties": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorsProperties"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationSchemaSources": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationSchemaVariables": {
"type": "object",
"properties": {
"executionVariables": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionVariables"
}
],
"nullable": true
},
"tasksVariables": {
"allOf": [
{
"$ref": "#/components/schemas/TasksVariables"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationVersionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"startTaskKey": {
"type": "string",
"nullable": true
},
"initiator": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectInitiatorDto"
}
],
"nullable": true
},
"flowVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowVariableDto"
},
"nullable": true
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto"
},
"nullable": true
},
"versionNumber": {
"type": "integer",
"format": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
]
},
"created": {
"type": "string",
"format": "date-time"
},
"notes": {
"type": "string",
"nullable": true
},
"participants": {
"allOf": [
{
"$ref": "#/components/schemas/FlowParticipantsDto"
}
],
"nullable": true
},
"flowDependencies": {
"allOf": [
{
"$ref": "#/components/schemas/FlowDependenciesDto"
}
],
"nullable": true
},
"importedFromTemplate": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateOriginDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationVersionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationVersionDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationVersionFlatDto": {
"type": "object",
"properties": {
"configurationId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"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
},
"ConfigurationVersionFlatDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationVersionFlatDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationVersionFlatDtoPaginatedResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationVersionFlatDto"
},
"nullable": true
},
"nextToken": {
"type": "string",
"nullable": true
},
"hasNextPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ConfigurationVersionFlatDtoPaginatedResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationVersionFlatDtoPaginatedResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationVersionFlatDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationVersionFlatDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationVersionSnapshotDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
]
}
},
"additionalProperties": false
},
"ConnectRepositoryDto": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/RepositoryProvider"
}
]
},
"url": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"repositoryKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ConstantVariable": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ConstantVariableDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ContentType": {
"enum": [
"None",
"Json",
"Xml",
"Text",
"FormUrlEncoded",
"FormData",
"BinaryFile"
],
"type": "string"
},
"ContributorDto": {
"allOf": [
{
"$ref": "#/components/schemas/ParticipantDto"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"CreateConfigurationDraftDto": {
"type": "object",
"properties": {
"notes": {
"maxLength": 1000,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"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",
"nullable": true
}
},
"additionalProperties": false
},
"CreateRepositoryLibraryRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"filePath": {
"type": "string",
"nullable": true
},
"repositoryKey": {
"type": "string",
"nullable": true
},
"libraryKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CreateTransformerLibraryDraftDto": {
"type": "object",
"properties": {
"notes": {
"maxLength": 1000,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataGroupDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"friendlyName": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DebugTransformerTaskRequestDto": {
"type": "object",
"properties": {
"input": {
"type": "string",
"nullable": true
},
"transpiledCode": {
"type": "string",
"nullable": true
},
"includeLookups": {
"type": "boolean"
},
"libraries": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"useDraftLibraries": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DebugTransformerTaskResponseDto": {
"type": "object",
"properties": {
"isSuccess": {
"type": "boolean"
},
"isTimeOut": {
"type": "boolean"
},
"output": { },
"logs": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"errorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/TransformLambdaResponseError"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"DebugTransformerTaskResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DebugTransformerTaskResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"DependentImportResultDto": {
"type": "object",
"properties": {
"templateKey": {
"type": "string",
"nullable": true
},
"configurationId": {
"type": "string",
"format": "uuid"
},
"flowKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"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"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ErrorProperties": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/TaskErrorType"
}
]
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorProperty"
},
"nullable": true
}
},
"additionalProperties": false
},
"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",
"items": {
"$ref": "#/components/schemas/ErrorProperties"
},
"nullable": true
}
},
"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"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"EventIngressRunMode": {
"enum": [
"FireAndForget",
"Sync",
"Async"
],
"type": "string"
},
"ExecutionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"initiatorType": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
},
"sourceId": {
"type": "string",
"format": "uuid"
},
"parentExecutionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateStarted": {
"type": "string",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"executionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/AttemptStatus"
}
],
"nullable": true
},
"attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttemptDto"
},
"nullable": true
},
"initialRequest": {
"nullable": true
},
"correlationId": {
"type": "string",
"nullable": true
},
"flow": {
"allOf": [
{
"$ref": "#/components/schemas/Flow"
}
],
"nullable": true
},
"scheduleKey": {
"type": "string",
"nullable": true
},
"isDebugMode": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ExecutionDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ExecutionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ExecutionError": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ExecutionFilteredDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateStarted": {
"type": "string",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"attemptsCount": {
"type": "integer",
"format": "int32"
},
"initiatorType": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
},
"sourceId": {
"type": "string",
"format": "uuid"
},
"executionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/AttemptStatus"
}
],
"nullable": true
},
"flow": {
"allOf": [
{
"$ref": "#/components/schemas/Flow"
}
],
"nullable": true
},
"isDebugMode": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ExecutionFilteredDtoPaginatedResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionFilteredDto"
},
"nullable": true
},
"nextToken": {
"type": "string",
"nullable": true
},
"hasNextPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ExecutionFilteredDtoPaginatedResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionFilteredDtoPaginatedResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ExecutionStepLogDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"executionId": {
"type": "string",
"format": "uuid"
},
"attemptId": {
"type": "string",
"format": "uuid"
},
"configurationId": {
"type": "string",
"format": "uuid"
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionStepResult"
}
]
},
"stepName": {
"type": "string",
"nullable": true
},
"stepType": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"isStart": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"parentStepLogId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"instanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"subflowIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ExecutionStepLogDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionStepLogDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ExecutionStepResult": {
"enum": [
"Success",
"Failed",
"InProgress"
],
"type": "string"
},
"ExecutionVariable": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionVariableName"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableType"
}
]
}
},
"additionalProperties": false
},
"ExecutionVariableName": {
"enum": [
"ExecutionId",
"AttemptId",
"SourceId",
"CorrelationId",
"SourceType",
"Metadata",
"Request",
"State",
"AsyncId",
"BranchRequest",
"ForEachRequest"
],
"type": "string"
},
"ExecutionVariables": {
"type": "object",
"properties": {
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionVariable"
},
"nullable": true
}
},
"additionalProperties": false
},
"FetchOpenApiSpecRequestDto": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FetchOpenApiSpecResponseDto": {
"type": "object",
"properties": {
"content": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FetchOpenApiSpecResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FetchOpenApiSpecResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"FieldDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"friendlyName": {
"type": "string",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaFieldType"
}
]
},
"required": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"lookup": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"collectionType": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaFieldType"
}
],
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldDto"
},
"nullable": true
},
"isExtensible": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"FileSource": {
"enum": [
"PersistedStorage",
"FenergoDocument"
],
"type": "string"
},
"Flow": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FlowDependenciesDto": {
"type": "object",
"properties": {
"globalVariables": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"mappings": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"schemas": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"flows": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"schedules": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"transformerLibraries": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"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",
"nullable": true
},
"flowRequest": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"mapToRequestBody": {
"type": "boolean"
},
"callbackTimeout": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"FlowInvokerRunMode": {
"enum": [
"FireAndForget",
"Async"
],
"type": "string"
},
"FlowParticipantsDto": {
"type": "object",
"properties": {
"contributors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorDto"
},
"nullable": true
},
"approver": {
"allOf": [
{
"$ref": "#/components/schemas/ApproverDto"
}
],
"nullable": true
},
"submitter": {
"allOf": [
{
"$ref": "#/components/schemas/SubmitterDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateDependencyDto": {
"type": "object",
"properties": {
"templateKey": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"templateKey": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"category": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateCategory"
}
]
},
"featureFlagName": {
"type": "string",
"nullable": true
},
"versionNumber": {
"type": "integer",
"format": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateStatus"
}
]
},
"flowDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/FlowTemplateFlowDefinitionDto"
}
],
"nullable": true
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowTemplateSchemaSnapshotDto"
},
"nullable": true
},
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowTemplateMappingSnapshotDto"
},
"nullable": true
},
"dependentFlows": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/FlowTemplateDependencyDto"
},
"nullable": true
},
"dependentSchemas": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ResourceTemplateDependencyDto"
},
"nullable": true
},
"dependentMappings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ResourceTemplateDependencyDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FlowTemplateDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateFlowDefinitionDto": {
"type": "object",
"properties": {
"startTaskKey": {
"type": "string",
"nullable": true
},
"initiator": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectInitiatorDto"
}
],
"nullable": true
},
"flowVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowVariableDto"
},
"nullable": true
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateLightDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"templateKey": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"category": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateCategory"
}
]
},
"featureFlagName": {
"type": "string",
"nullable": true
},
"versionNumber": {
"type": "integer",
"format": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateStatus"
}
]
},
"hasDependentFlows": {
"type": "boolean"
},
"hasDependentSchemas": {
"type": "boolean"
},
"hasDependentMappings": {
"type": "boolean"
},
"isManagedOob": {
"type": "boolean"
},
"majorVersion": {
"type": "integer",
"format": "int32"
},
"minorVersion": {
"type": "integer",
"format": "int32"
},
"fixVersion": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FlowTemplateLightDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowTemplateLightDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateMappingSnapshotDto": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FlowTemplateSchemaSnapshotDto": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FlowVariableDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": { },
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableType"
}
]
}
},
"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"
}
],
"nullable": true
},
"processInput": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"iterationTasks": {
"allOf": [
{
"$ref": "#/components/schemas/ForEachTasksConfigV1Dto"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ForEachTasksConfigV1Dto": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto"
},
"nullable": true
},
"startTaskKey": {
"type": "string",
"nullable": true
}
},
"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"
}
],
"nullable": true
},
"fileSource": {
"allOf": [
{
"$ref": "#/components/schemas/FileSource"
}
],
"nullable": true
},
"storageKey": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"documentUrl": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"partContentType": {
"type": "string",
"nullable": true
},
"filename": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FormDataPartType": {
"enum": [
"Text",
"File"
],
"type": "string"
},
"FuncVariable": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableDefinitionFuncType"
}
]
},
"jsonPath": {
"type": "string",
"nullable": true
},
"variable": {
"allOf": [
{
"$ref": "#/components/schemas/SingleVariable"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FuncVariableDto": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableDefinitionFuncType"
}
]
},
"jsonPath": {
"type": "string",
"nullable": true
},
"variable": {
"allOf": [
{
"$ref": "#/components/schemas/SingleVariableDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"GenerateTypesFromOpenApiRequestDto": {
"type": "object",
"properties": {
"openApiSpec": {
"type": "string",
"nullable": true
},
"selectedModels": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"typeStyle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GenerateTypesFromOpenApiResponseDto": {
"type": "object",
"properties": {
"generatedTypes": {
"type": "string",
"nullable": true
},
"availableModels": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"selectedModels": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"openApiVersion": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GenerateTypesFromOpenApiResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GenerateTypesFromOpenApiResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetStepLogsResponse": {
"type": "object",
"properties": {
"stepLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionStepLogDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetStepLogsResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GetStepLogsResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GlobalVariableAudit": {
"type": "object",
"properties": {
"auditId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"operation": {
"allOf": [
{
"$ref": "#/components/schemas/AuditOperationType"
}
]
},
"previousValue": {
"nullable": true
},
"newValue": {
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"updatedBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GlobalVariableAuditPaginatedResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalVariableAudit"
},
"nullable": true
},
"nextToken": {
"type": "string",
"nullable": true
},
"hasNextPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"GlobalVariableAuditPaginatedResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GlobalVariableAuditPaginatedResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GlobalVariableDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableType"
}
]
}
},
"additionalProperties": false
},
"GlobalVariableDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalVariableDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GuidServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "uuid"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"HmacAuthConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/AuthConfigDetailDto"
},
{
"type": "object",
"properties": {
"authenticationMethod": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticationMethod"
}
],
"example": "Hmac"
},
"headerKey": {
"type": "string",
"nullable": true,
"example": "X-Auth-Signature"
},
"secret": {
"type": "string",
"nullable": true
}
},
"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"
}
],
"nullable": true
},
"method": {
"type": "string",
"nullable": true
},
"contentType": {
"allOf": [
{
"$ref": "#/components/schemas/ContentType"
}
]
},
"customContentType": {
"type": "string",
"nullable": true
},
"headers": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/StraightValueDto"
},
"nullable": true
},
"queryParams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/StraightValueDto"
},
"nullable": true
},
"body": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"formValues": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/StraightValueDto"
},
"nullable": true
},
"formParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormDataPartDto"
},
"nullable": true
},
"timeout": {
"type": "string",
"nullable": true
},
"isCallback": {
"type": "boolean"
},
"callbackTimeout": {
"type": "string",
"nullable": true
},
"largeResponse": {
"type": "boolean"
},
"storageKey": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValue"
}
],
"nullable": true
},
"storageTTL": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskTTL"
}
],
"nullable": true
},
"storageSensitivity": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskSensitivity"
}
],
"nullable": true
},
"sendStorageFile": {
"type": "boolean"
},
"requestStorageKey": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValue"
}
],
"nullable": true
},
"fileSource": {
"allOf": [
{
"$ref": "#/components/schemas/FileSource"
}
],
"nullable": true
},
"requestDocumentUrl": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValue"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ImportFlowTemplateRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"flowOverrides": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"schemaOverrides": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"mappingOverrides": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportFlowTemplateResponseDto": {
"type": "object",
"properties": {
"configurationId": {
"type": "string",
"format": "uuid"
},
"dependentImports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentImportResultDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportFlowTemplateResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ImportFlowTemplateResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"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",
"nullable": true
},
"leftOperand": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"rightOperand": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"withHeaders": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"InlineTransformerTaskOperation": {
"enum": [
"JsonMerge",
"JsonFormat",
"ArrayMerge",
"ArrayAppend",
"Compress",
"Uncompress",
"ParseCsv"
],
"type": "string"
},
"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"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"InternalApiEndpoint": {
"enum": [
"GetJourneyInstanceById",
"CreateEntity",
"UpdateEntityDraft",
"LegalEntityIdentifierSearch",
"LegalEntityAdvancedSearch",
"CreateEntityDraft",
"ReopenTask",
"GetSignificanceResult",
"GetInternalEntityIdByExDataSubscriptionId",
"GetDocumentSignedUrl",
"GetDataSources"
],
"type": "string"
},
"InternalApiEndpointConfigurationDto": {
"type": "object",
"properties": {
"sampleRequest": {
"nullable": true
}
},
"additionalProperties": false
},
"InternalApiEndpointConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/InternalApiEndpointConfigurationDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"InternalApiEndpointDto": {
"type": "object",
"properties": {
"endpoint": {
"allOf": [
{
"$ref": "#/components/schemas/InternalApiEndpoint"
}
]
},
"friendlyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InternalApiEndpointDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InternalApiEndpointDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"IpWhitelistingAuthConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/AuthConfigDetailDto"
},
{
"type": "object",
"properties": {
"authenticationMethod": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticationMethod"
}
],
"example": "IpWhitelist"
},
"ips": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"LibrarySource": {
"enum": [
"Manual",
"Repository"
],
"type": "string"
},
"LoVArrayMap": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"map": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"LoVMap": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"map": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"Map": {
"type": "object",
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
},
"nullable": true
},
"loVMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoVMap"
},
"nullable": true
},
"loVArrayMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoVArrayMap"
},
"nullable": true
}
},
"additionalProperties": false
},
"MapperConfigV1Dto": {
"allOf": [
{
"$ref": "#/components/schemas/TaskConfigBaseDto"
},
{
"required": [
"taskType"
],
"type": "object",
"properties": {
"taskType": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
],
"readOnly": true
},
"mappingId": {
"type": "string",
"nullable": true
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"Mapping": {
"type": "object",
"properties": {
"source": {
"type": "string",
"nullable": true
},
"target": {
"type": "string",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/MappingType"
}
]
},
"loVMapName": {
"type": "string",
"nullable": true
},
"toArray": {
"type": "boolean"
},
"displaySource": {
"type": "boolean"
},
"constantValue": {
"type": "string",
"nullable": true
},
"objectToTextProperties": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectToTextProperties"
}
],
"nullable": true
},
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingCreateRequestDto": {
"type": "object",
"properties": {
"sourceSchemaId": {
"type": "string",
"nullable": true
},
"targetSchemaId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"mappingKey": {
"type": "string",
"nullable": true
},
"map": {
"allOf": [
{
"$ref": "#/components/schemas/Map"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"MappingDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"sourceSchemaId": {
"type": "string",
"nullable": true
},
"targetSchemaId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"mappingKey": {
"type": "string",
"nullable": true
},
"map": {
"allOf": [
{
"$ref": "#/components/schemas/Map"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"MappingDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MappingDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingLightDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"sourceSchemaId": {
"type": "string",
"nullable": true
},
"targetSchemaId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"mappingKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MappingLightDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MappingLightDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingType": {
"enum": [
"Text",
"LoV",
"Object",
"LoVArray",
"Constant",
"ObjectCollection",
"ObjectToText",
"ObjectCollectionToText",
"Number",
"Date",
"MultiSelect"
],
"type": "string"
},
"MappingUpdateRequestDto": {
"type": "object",
"properties": {
"sourceSchemaId": {
"type": "string",
"nullable": true
},
"targetSchemaId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"map": {
"allOf": [
{
"$ref": "#/components/schemas/Map"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"MetricBucketName": {
"enum": [
"DebugTransformerTask",
"FlowsExecutions",
"FlowsExecutionTime",
"FlowsTransitions"
],
"type": "string"
},
"MetricDataPointDto": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"MetricName": {
"enum": [
"ConsumedComplexity",
"ThrottledRequests"
],
"type": "string"
},
"MetricPeriod": {
"enum": [
"OneMinute",
"FiveMinutes",
"FifteenMinutes",
"ThirtyMinutes",
"OneHour"
],
"type": "string"
},
"MetricStatistic": {
"enum": [
"Sum",
"Min",
"Max",
"Average"
],
"type": "string"
},
"MetricsResultDto": {
"type": "object",
"properties": {
"pointsTotalCount": {
"type": "integer",
"format": "int32"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricDataPointDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"MetricsResultDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MetricsResultDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ObjectField": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"isLoV": {
"type": "boolean"
},
"loVMapName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectInitiatorDto": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
},
"config": {
"nullable": true
}
},
"additionalProperties": false
},
"ObjectSelector": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ObjectToTextProperties": {
"type": "object",
"properties": {
"separator": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectField"
},
"nullable": true
},
"selector": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectSelector"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"OpenApiSchemaPropertiesDto": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/OpenApiSchemaSource"
}
]
},
"model": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OpenApiSchemaSource": {
"enum": [
"Url",
"File"
],
"type": "string"
},
"OpenApiSourceType": {
"enum": [
"Url",
"FileUpload"
],
"type": "string"
},
"OpenApiTypeSourceInfo": {
"type": "object",
"properties": {
"sourceType": {
"allOf": [
{
"$ref": "#/components/schemas/OpenApiSourceType"
}
]
},
"url": {
"type": "string",
"nullable": true
},
"selectedModels": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"generatedAt": {
"type": "string",
"format": "date-time"
},
"openApiVersion": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Pager": {
"required": [
"first"
],
"type": "object",
"properties": {
"first": {
"type": "integer",
"format": "int32"
},
"after": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParallelBranchConfigV1Dto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto"
},
"nullable": true
},
"startTaskKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParallelTaskConfigV1Dto": {
"allOf": [
{
"$ref": "#/components/schemas/TaskConfigBaseDto"
},
{
"required": [
"taskType"
],
"type": "object",
"properties": {
"taskType": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
],
"readOnly": true
},
"branches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParallelBranchConfigV1Dto"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ParticipantDto": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"PersistedStorageStatus": {
"enum": [
"Processing",
"Uploaded",
"Infected",
"Error"
],
"type": "string"
},
"PolicySchemaPropertiesDto": {
"type": "object",
"properties": {
"jurisdictions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"targetEntity": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RefreshRepositoryAccessTokenRequestDto": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"repositoryKey": {
"type": "string",
"nullable": true
}
},
"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",
"additionalProperties": {
"$ref": "#/components/schemas/StraightValueDto"
},
"nullable": true
},
"reportFileName": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"reportTTL": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskTTL"
}
]
},
"reportSensitivity": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskSensitivity"
}
]
}
},
"additionalProperties": false
}
]
},
"RepositoryConnectionListItemDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"repositoryKey": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/RepositoryProvider"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"RepositoryConnectionListItemDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RepositoryConnectionListItemDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"RepositoryProvider": {
"enum": [
"GitHub"
],
"type": "string"
},
"RequestAIGenerationResponseDto": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"RequestAIGenerationResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/RequestAIGenerationResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"RequestAITroubleshootingResponseDto": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"RequestAITroubleshootingResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/RequestAITroubleshootingResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ResourceTemplateDependencyDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RouteDto": {
"required": [
"condition",
"next"
],
"type": "object",
"properties": {
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionDto"
}
]
},
"next": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"RouterConfigV1Dto": {
"allOf": [
{
"$ref": "#/components/schemas/TaskConfigBaseDto"
},
{
"required": [
"taskType"
],
"type": "object",
"properties": {
"taskType": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
],
"readOnly": true
},
"routes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteDto"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SaveAuthConfigurationRequestDto": {
"type": "object",
"properties": {
"configurationDetails": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/IpWhitelistingAuthConfigurationDto"
},
{
"$ref": "#/components/schemas/SharedKeyAuthConfigurationDto"
},
{
"$ref": "#/components/schemas/HmacAuthConfigurationDto"
}
]
},
"nullable": true
},
"callbackDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallbackAuthConfigDetailDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScheduleCreateRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"scheduleKey": {
"type": "string",
"nullable": true
},
"scheduleExpression": {
"type": "string",
"nullable": true
},
"scheduleTimezone": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"flowInput": { }
},
"additionalProperties": false
},
"ScheduleDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"scheduleKey": {
"type": "string",
"nullable": true
},
"scheduleExpression": {
"type": "string",
"nullable": true
},
"scheduleTimezone": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"flowInput": {
"type": "string",
"nullable": true
},
"isEnabled": {
"type": "boolean"
},
"isSystemDisabled": {
"type": "boolean",
"nullable": true
},
"systemDisabledReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ScheduleDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScheduleDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScheduleLightDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"scheduleKey": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"isEnabled": {
"type": "boolean"
},
"isSystemDisabled": {
"type": "boolean",
"nullable": true
},
"systemDisabledReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ScheduleLightDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleLightDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScheduleUpdateRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"scheduleExpression": {
"type": "string",
"nullable": true
},
"scheduleTimezone": {
"type": "string",
"nullable": true
},
"flowKey": {
"type": "string",
"nullable": true
},
"flowInput": { },
"isEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SchemaCreateRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"schemaKey": {
"type": "string",
"nullable": true
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaSource"
}
]
},
"sourceProperties": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaSourcePropertiesDto"
}
],
"nullable": true
},
"schemaEntry": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SchemaDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"schemaKey": {
"type": "string",
"nullable": true
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaSource"
}
]
},
"sourceProperties": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaSourcePropertiesDto"
}
],
"nullable": true
},
"schemaEntry": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SchemaDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"SchemaEntryDto": {
"type": "object",
"properties": {
"lookups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupDto"
},
"nullable": true
},
"dataGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataGroupDto"
},
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"SchemaFieldType": {
"enum": [
"Select",
"MultiSelect",
"DataGroup",
"MultiDataGroup",
"Text",
"Number",
"Date",
"Boolean",
"Collection"
],
"type": "string"
},
"SchemaLightDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"schemaKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SchemaLightDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaLightDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"SchemaSource": {
"enum": [
"Manual",
"Policy",
"OpenApi"
],
"type": "string"
},
"SchemaSourcePropertiesDto": {
"type": "object",
"properties": {
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/PolicySchemaPropertiesDto"
}
],
"nullable": true
},
"openApi": {
"allOf": [
{
"$ref": "#/components/schemas/OpenApiSchemaPropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SchemaUpdateRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaSource"
}
]
},
"sourceProperties": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaSourcePropertiesDto"
}
],
"nullable": true
},
"schemaEntry": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SearchExecutionsByFilterRequest": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"configurationId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"configurationVersion": {
"type": "integer",
"format": "int32",
"nullable": true
},
"scheduleKey": {
"type": "string",
"nullable": true
},
"pager": {
"allOf": [
{
"$ref": "#/components/schemas/Pager"
}
]
}
},
"additionalProperties": false
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SharedKeyAuthConfigurationDto": {
"allOf": [
{
"$ref": "#/components/schemas/AuthConfigDetailDto"
},
{
"type": "object",
"properties": {
"authenticationMethod": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticationMethod"
}
],
"example": "SharedKey"
},
"sharedKeyLocation": {
"allOf": [
{
"$ref": "#/components/schemas/SharedKeyLocation"
}
]
},
"parameterName": {
"type": "string",
"nullable": true,
"example": "ApiKey"
},
"sharedKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SharedKeyLocation": {
"enum": [
"Header",
"QueryParameter"
],
"type": "string"
},
"SignConfigurationDraftRequest": {
"required": [
"decision"
],
"type": "object",
"properties": {
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SignTransformerLibraryRequestDto": {
"required": [
"decision"
],
"type": "object",
"properties": {
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SingleVariable": {
"type": "object",
"properties": {
"category": {
"allOf": [
{
"$ref": "#/components/schemas/VariableCategory"
}
]
},
"taskName": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SingleVariableDto": {
"type": "object",
"properties": {
"category": {
"allOf": [
{
"$ref": "#/components/schemas/VariableCategory"
}
]
},
"taskName": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Source": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SourceProperty"
},
"nullable": true
}
},
"additionalProperties": false
},
"SourceProperty": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/SourcePropertyName"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableType"
}
]
}
},
"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"
},
"SourceType": {
"enum": [
"Unknown",
"Journey",
"ExternalData",
"Api",
"Policy",
"Scheduler"
],
"type": "string"
},
"StartExecutionResponseDto": {
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"StartExecutionResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/StartExecutionResponseDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"StepDataDto": {
"type": "object",
"properties": {
"parameters": {
"nullable": true
},
"state": { },
"output": {
"nullable": true
}
},
"additionalProperties": false
},
"StepDataDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/StepDataDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"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"
}
],
"nullable": true
},
"prefix": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/ComplexValueDto"
}
],
"nullable": true
},
"ttl": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskTTL"
}
],
"nullable": true
},
"sensitivity": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskSensitivity"
}
],
"nullable": true
},
"partialRead": {
"type": "boolean",
"nullable": true
},
"withHeaders": {
"type": "boolean",
"nullable": true
},
"batchSize": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
},
"startBytePosition": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"StorageObjectDto": {
"type": "object",
"properties": {
"fileIdentifier": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64"
},
"sensitivity": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskSensitivity"
}
]
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"executionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/PersistedStorageStatus"
}
]
}
},
"additionalProperties": false
},
"StorageObjectDtoPaginatedResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StorageObjectDto"
},
"nullable": true
},
"nextToken": {
"type": "string",
"nullable": true
},
"hasNextPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"StorageObjectDtoPaginatedResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/StorageObjectDtoPaginatedResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"StorageTaskOperation": {
"enum": [
"QueryByKey",
"QueryByPrefix",
"PutRecord",
"DeleteRecord"
],
"type": "string"
},
"StorageTaskSensitivity": {
"enum": [
"Sensitive",
"NotSensitive"
],
"type": "string"
},
"StorageTaskTTL": {
"enum": [
"OneWeek",
"OneMonth"
],
"type": "string"
},
"StraightValue": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueType"
}
]
},
"value": {
"type": "string",
"nullable": true
},
"variables": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Variable"
},
"nullable": true
}
},
"additionalProperties": false
},
"StraightValueDto": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueType"
}
]
},
"value": {
"type": "string",
"nullable": true
},
"variables": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/VariableDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"StraightValueType": {
"enum": [
"Pattern"
],
"type": "string"
},
"StringServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"SubmitterDto": {
"allOf": [
{
"$ref": "#/components/schemas/ParticipantDto"
},
{
"type": "object",
"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"
}
],
"nullable": true
},
"queryBy": {
"allOf": [
{
"$ref": "#/components/schemas/SuperGraphQueryBy"
}
]
},
"queryByValue": {
"allOf": [
{
"$ref": "#/components/schemas/StraightValueDto"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SuperGraphQueryBy": {
"enum": [
"JourneyId",
"EntityId"
],
"type": "string"
},
"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
},
"TaskCatchDto": {
"type": "object",
"properties": {
"routes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCatchRouteDto"
},
"nullable": true
},
"default": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TaskCatchRouteDto": {
"type": "object",
"properties": {
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionDto"
}
],
"nullable": true
},
"next": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TaskConfigBaseDto": {
"required": [
"taskType"
],
"type": "object",
"properties": {
"taskType": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
],
"readOnly": true
},
"catch": {
"allOf": [
{
"$ref": "#/components/schemas/TaskCatchDto"
}
],
"nullable": true
},
"retry": {
"allOf": [
{
"$ref": "#/components/schemas/TaskRetryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"TaskConfigBaseDtoIntegrationTaskDto": {
"required": [
"key",
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"key": {
"minLength": 1,
"type": "string"
},
"next": {
"type": "string",
"nullable": true
},
"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"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"TaskErrorProperty": {
"enum": [
"HttpStatusCode",
"HttpResponseBody",
"HttpRawResponse",
"JsErrorCode",
"JsErrorMessage",
"JsUnhandledErrorMessage",
"SuperGraphErrors",
"EventId",
"InternalApiErrorDetails",
"FailedBranches",
"Responses",
"FailedIterations",
"ReportErrorMessage",
"AiInvokerErrorMessage"
],
"type": "string"
},
"TaskErrorSchema": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/TaskErrorType"
}
]
}
},
"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"
},
"TaskErrors": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
]
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskErrorSchema"
},
"nullable": true
}
},
"additionalProperties": false
},
"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
},
"TaskRetryDto": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskRetryRuleDto"
},
"nullable": true
},
"default": {
"allOf": [
{
"$ref": "#/components/schemas/TaskRetryDefinitionDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"TaskRetryRuleDto": {
"type": "object",
"properties": {
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionDto"
}
],
"nullable": true
},
"definition": {
"allOf": [
{
"$ref": "#/components/schemas/TaskRetryDefinitionDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"TaskType": {
"enum": [
"SuperGraphV1",
"TransformerV1",
"EventIngressV1",
"RouterV1",
"MapperV1",
"HttpInvokerV2",
"WaitV1",
"EndV1",
"InternalApiV1",
"FlowInvokerV1",
"StorageV1",
"InlineTransformerV1",
"ParallelTaskV1",
"ForEachTaskV1",
"ReportTaskV1",
"AiInvokerV1"
],
"type": "string"
},
"TaskVariable": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/TaskVariableName"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/VariableType"
}
]
},
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/TaskVariableCondition"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"TaskVariableCondition": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TaskVariableName": {
"enum": [
"ResponseBody",
"RawResponse",
"StatusCode",
"Output",
"FormattedResponse",
"EventId",
"ResponseHeaders",
"CallbackRequest",
"EventResponse",
"OperationOutput",
"StorageRecord",
"RecordsList",
"Responses",
"StorageKey",
"ContentType",
"Error"
],
"type": "string"
},
"TaskVariables": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
]
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskVariable"
},
"nullable": true
}
},
"additionalProperties": false
},
"TasksErrors": {
"type": "object",
"properties": {
"taskTypesErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskErrors"
},
"nullable": true
}
},
"additionalProperties": false
},
"TasksVariables": {
"type": "object",
"properties": {
"tasksTypesVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskVariables"
},
"nullable": true
}
},
"additionalProperties": false
},
"TemplateCategory": {
"enum": [
"ConfigurationTemplates",
"DesignPatterns",
"ScreeningProviderDemo",
"AiTemplates"
],
"type": "string"
},
"TemplateOriginDto": {
"type": "object",
"properties": {
"templateKey": {
"type": "string",
"nullable": true
},
"templateVersion": {
"type": "integer",
"format": "int32"
},
"importedAt": {
"type": "string",
"format": "date-time"
},
"isManaged": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TemplateStatus": {
"enum": [
"Active",
"Deprecated"
],
"type": "string"
},
"TransformLambdaResponseError": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/TransformerErrorType"
}
]
},
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"stack": {
"type": "string",
"nullable": true
}
},
"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"
}
],
"nullable": true
},
"originalMapMethod": {
"type": "string",
"nullable": true
},
"transpiledMapMethod": {
"type": "string",
"nullable": true
},
"includeLookups": {
"type": "boolean"
},
"inputSchemaId": {
"type": "string",
"nullable": true
},
"outputSchemaId": {
"type": "string",
"nullable": true
},
"includedSchemas": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"libraries": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"TransformerErrorType": {
"enum": [
"Unhandled",
"Custom"
],
"type": "string"
},
"TransformerLibraryDto": {
"allOf": [
{
"$ref": "#/components/schemas/TransformerLibraryLightDto"
},
{
"type": "object",
"properties": {
"includedSchemas": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"includeLookups": {
"type": "boolean"
},
"generatedTypes": {
"type": "string",
"nullable": true
},
"openApiTypeSource": {
"allOf": [
{
"$ref": "#/components/schemas/OpenApiTypeSourceInfo"
}
],
"nullable": true
},
"code": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"TransformerLibraryDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/TransformerLibraryDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TransformerLibraryLightDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"libraryKey": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
]
},
"modifiedAt": {
"type": "string",
"format": "date-time"
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/LibrarySource"
}
]
},
"contributors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorDto"
},
"nullable": true
},
"publishedDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TransformerLibraryLightDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TransformerLibraryLightDto"
},
{
"$ref": "#/components/schemas/TransformerLibraryDto"
}
]
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TransformerLibraryRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"libraryKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TroubleshootingAnalysisDto": {
"type": "object",
"properties": {
"rootCause": {
"type": "string",
"nullable": true
},
"errorCategory": {
"type": "string",
"nullable": true
},
"affectedSteps": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"recommendations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TroubleshootingRecommendationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"TroubleshootingRecommendationDto": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"priority": {
"type": "string",
"nullable": true
},
"action": {
"type": "string",
"nullable": true
},
"details": {
"type": "string",
"nullable": true
},
"codeExample": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateConfigurationVersionRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"startTaskKey": {
"type": "string",
"nullable": true
},
"flowVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowVariableDto"
},
"nullable": true
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskConfigBaseDtoIntegrationTaskDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateManagedFlowResponse": {
"type": "object",
"properties": {
"updated": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UpdateManagedFlowResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateManagedFlowResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateRepositoryTransformerLibraryRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"repositoryKey": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateTransformerLibraryRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"codeOriginal": {
"type": "string",
"nullable": true
},
"codeTranspiled": {
"type": "string",
"nullable": true
},
"includedSchemas": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"includeLookups": {
"type": "boolean"
},
"generatedTypes": {
"type": "string",
"nullable": true
},
"openApiTypeSource": {
"allOf": [
{
"$ref": "#/components/schemas/OpenApiTypeSourceInfo"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"UploadDocumentRequest": {
"type": "object",
"properties": {
"fileIdentifier": {
"type": "string",
"nullable": true
},
"sensitivity": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskSensitivity"
}
]
},
"ttl": {
"allOf": [
{
"$ref": "#/components/schemas/StorageTaskTTL"
}
]
},
"fileSize": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"UploadDocumentResponse": {
"type": "object",
"properties": {
"preSignedUrl": {
"type": "string",
"nullable": true
},
"fileIdentifier": {
"type": "string",
"nullable": true
},
"tags": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UploadDocumentResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UploadDocumentResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ValidateRepositoryAccessDto": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ValidateRepositoryAccessDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ValidateRepositoryAccessDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"Variable": {
"type": "object",
"properties": {
"definitionType": {
"allOf": [
{
"$ref": "#/components/schemas/VariableDefinitionType"
}
]
},
"constantVariable": {
"allOf": [
{
"$ref": "#/components/schemas/ConstantVariable"
}
],
"nullable": true
},
"singleVariable": {
"allOf": [
{
"$ref": "#/components/schemas/SingleVariable"
}
],
"nullable": true
},
"funcVariable": {
"allOf": [
{
"$ref": "#/components/schemas/FuncVariable"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"VariableCategory": {
"enum": [
"Global",
"Flow",
"Execution",
"Task"
],
"type": "string"
},
"VariableDefinitionFuncType": {
"enum": [
"JsonPath",
"Pattern"
],
"type": "string"
},
"VariableDefinitionType": {
"enum": [
"Constant",
"Single",
"Func"
],
"type": "string"
},
"VariableDto": {
"type": "object",
"properties": {
"definitionType": {
"allOf": [
{
"$ref": "#/components/schemas/VariableDefinitionType"
}
]
},
"constantVariable": {
"allOf": [
{
"$ref": "#/components/schemas/ConstantVariableDto"
}
],
"nullable": true
},
"singleVariable": {
"allOf": [
{
"$ref": "#/components/schemas/SingleVariableDto"
}
],
"nullable": true
},
"funcVariable": {
"allOf": [
{
"$ref": "#/components/schemas/FuncVariableDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"VariableType": {
"enum": [
"Text",
"Number",
"Json",
"Guid",
"Request",
"Secret",
"TaskError"
],
"type": "string"
},
"VersionStatus": {
"enum": [
"Draft",
"Pending",
"Rejected",
"Published",
"Archived",
"Deleted"
],
"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"
}
],
"nullable": true
},
"callbackTimeout": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"WebhookInfoDto": {
"type": "object",
"properties": {
"webhookUrl": {
"type": "string",
"nullable": true
},
"webhookSecret": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"WebhookInfoDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookInfoDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}