The failed status400 BAD_REQUEST can be returned if the app name contains invalid characters (acceptable app name characters are only alphanumeric [a-Z0-9] and the underscore character '_').
Example
{
"name": [
"Invalid app name. App name must contain only alphanumeric characters and the underscore character."
]
}
This request compiles the Orchestrator App, creates a relative DiaManT App (if there is none), uploads a DiaManT App configuration, makes the deployment and starts the application.
Any moved node on canvas is considered a change.
Click to see the details
URL Parameters
Name
Type
Description
Example
app_id
uuid
The app's id.
"9b399774-3a0a-40c1-8a1c-4a124170b6f3"
Query Parameters
Name
Type
Description
Example
all
boolean
If this parameter set to true, then the application is re-deployed.
true
async
boolean
If this parameter set to true, then the asynchronous deployment is activated.
Please note that this feature is not available to all environments yet.
The failed status400 BAD_REQUEST can be returned if something went wrong with the app deployment. Usually, there was a canvas warning.
Example
{
"detail": "Your App can not be deployed because it contains problems: Multiple roots found on the graph.",
"errors": [
{
"canvas_id": "1ebbcc51-19a2-47cb-bba9-0bc6164a94cb",
"node_errors": [
{
"node_id": "1",
"errors": [
{
"type": "WARNING",
"code": "MULTIPLE_ROOTS_FOUND",
"message": "Multiple roots found on the graph.",
}
]
},
{
"node_id": "2",
"errors": [
{
"type": "WARNING",
"code": "MULTIPLE_ROOTS_FOUND",
"message": "Multiple roots found on the graph.",
}
]
}
]
}
]
}
A legacy Application is an older application that was created before OCP. It is a group of manually made and zipped DiaManT XML files that are sent directly to DiaManT without any checks or processing by Orchestrator.
The purpose of deploying legacy Applications is to bring previously developed Applications into the OCP system. Additionally, when a user creates a legacy type Application in Orchestrator, a DiaManT App is generated, and deploying a legacy App involves changing its configuration.
Click to see the details
URL Parameters
Name
Type
Description
Example
app_id
uuid
The app's id.
"9b499774-3a0a-60c1-8a1c-4a124170v6f3"
Query Parameters
Name
Type
Description
Example
all
boolean
If this parameter set to true, then the application is re-deployed.
true
async
boolean
If this parameter set to true, then the asynchronous deployment is activated.
Please note that this feature is not available to all environments yet.
true
Response (Success)
HTTP/1.1 200 OK
The deployment results.
Example
Please note that asynchronous deployment is not available to all environments yet.
The failed status400 BAD_REQUEST can be returned if something went wrong with the app deployment. Usually, there was a canvas warning.
Example
{
"detail": "Your App can not be deployed because it contains problems: Multiple roots found on the graph.",
"errors": [
{
"canvas_id": "1ebbcc51-19a2-47cb-bba9-0bc6164a94cb",
"node_errors": [
{
"node_id": "1",
"errors": [
{
"type": "WARNING",
"code": "MULTIPLE_ROOTS_FOUND",
"message": "Multiple roots found on the graph.",
}
]
},
{
"node_id": "2",
"errors": [
{
"type": "WARNING",
"code": "MULTIPLE_ROOTS_FOUND",
"message": "Multiple roots found on the graph.",
}
]
}
]
}
]
}
Get Async Deployment Status
GET
{{baseUrl}}/orchestrator/api/results/<result_id>/
Returns the status of asynchronous deployment by result_id.
Please note that this feature is not available to all environments yet.
Click to see the details
URL Parameters
Name
Type
Description
Example
result_id
uuid
The result id.
"7b7382bc-be7b-4b2f-829c-825a93ebac3c"
The result_id can be retrieved from . The results of the asynchronous deployment are saved for 24 hours and can be retrieved within this time.
Response (Success)
HTTP/1.1 200 OK
The deployment results.
Example
{{baseUrl}}/orchestrator/api/results/<result_id>/
{
"task_id": "392ad79d-c43a-4bb4-bfa9-0874335e65ee",
"async_result": "App ek_local_uswest_1 has been deployed successfully."
}
Response (Failed)
HTTP/1.1 404 NOT_FOUND
Example
{
"detail": "Task result 7b7382bc-be7b-4b2f-829c-825a93ebac3c not found."
}
Get Web Chat Info
Help start a chat simulation with an App by providing useful web chat related info.
The failed status400 BAD_REQUEST can be returned if there was a cycle reference inside the app (probably by some flows).
Example
{
"detail": "Found cycle use of a Flow in the application (use trace: ['test_user_id.my_app.Flows.orc.group', 'test_user_id.my_flow_lvl_1.Flows.orc.group', 'test_user_id.my_flow_lvl_2.Flows.orc.group'] -> test_user_id.my_flow_lvl_1.Flows.orc.group)."
}
