Summary
Get a client-side dialog controller for a manual task
Description
Get a client-side dialog controller for a manual task
Route
GET /operations-manager/jobs/:jobId/tasks/:taskId/manual-controller
Roles
admin
apiread
engineering
operations
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
jobId |
string |
yes |
The id of the Job containing the task |
taskId |
string |
yes |
The id of the Task containing the dialog controller. |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
The requested dialog controller. |
Copied to Clipboard
{
"message": "Successfully imported 3 of 4 documents",
"data": {
"variables": {
"error": "minim in dolore elit tempor",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~1"
},
{
"type": "encryption",
"pointer": "/~0/cK2w"
}
]
},
"finish_state": "qui esse ad aute",
"TaskController": "amet fugiat cillum nulla"
}
}
Copied to Clipboard
{
"title": "result",
"allOf": [
{
"$ref": "common-api#/definitions/success-response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"variables": {
"type": "object",
"properties": {
"incoming": {
"type": "object"
},
"outgoing": {
"type": "object"
},
"error": {
"type": "string"
},
"decorators": {
"$ref": "common#/definitions/decorators"
}
}
},
"finish_state": {
"type": "string"
},
"TaskController": {
"type": "string",
"description": "A Javascript function named TaskController."
}
}
}
}
}
]
}