orchestrator
2024.10
true
- Getting Started
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
Task Forms Requests
Orchestrator API Guide
Last updated Nov 11, 2024
Task Forms Requests
The current user needs to be assigned to that task otherwise the action cannot be performed.
POST
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/forms/TaskForms/CompleteTask
{
"taskId": 195,
"data": {name: "dada", password: "dada", submit: true},
"action": "submit"
}
{
"taskId": 195,
"data": {name: "dada", password: "dada", submit: true},
"action": "submit"
}
Retrieve the task form based on the
taskId
. The taskId
must be included in the request.
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/forms/TaskForms/GetTaskFormById?taskId=90
{
"formLayout": {
"components": [
{
"numRows": 2,
"numCols": 6,
"type": "table",
"mask": false,
"customClass": "uipath-button-container",
"tableView": true,
"alwaysEnabled": false,
"input": false,
"key": "key",
"label": "label",
"rows": [
[
{
"components": [
{
"label": "Name",
"showWordCount": false,
"showCharCount": false,
"alwaysEnabled": false,
"type": "textfield",
"input": true,
"key": "name",
"defaultValue": "",
"tableView": true,
"validate": {
"customMessage": ""
},
"conditional": {
"show": "",
"when": ""
},
"reorder": false
}
]
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
}
],
[
{
"components": [
{
"label": "Password",
"showWordCount": false,
"showCharCount": false,
"alwaysEnabled": false,
"type": "password",
"input": true,
"key": "password",
"defaultValue": "",
"protected": true,
"tableView": false,
"validate": {
"customMessage": ""
},
"conditional": {
"show": "",
"when": ""
},
"reorder": false
}
]
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
}
]
],
"header": [],
"customConditional": "",
"logic": [],
"conditional": {
"show": "",
"when": ""
},
"reorder": false
},
{
"type": "button",
"label": "Submit",
"key": "submit",
"disableOnInvalid": true,
"theme": "primary",
"input": true,
"alwaysEnabled": false,
"tableView": true
}
]
},
"actionLabel": "Submit",
"assignedToUserId": 52454,
"assignedToUser": {
"name": "",
"surname": "",
"userName": "admin",
"emailAddress": "",
"id": 52454
},
"status": 2,
"data": {
"name": "admin",
"password": "hardtocrackpassword@1264564&"
},
"action": "submit",
"externalTag": null,
"id": 90
}
{
"formLayout": {
"components": [
{
"numRows": 2,
"numCols": 6,
"type": "table",
"mask": false,
"customClass": "uipath-button-container",
"tableView": true,
"alwaysEnabled": false,
"input": false,
"key": "key",
"label": "label",
"rows": [
[
{
"components": [
{
"label": "Name",
"showWordCount": false,
"showCharCount": false,
"alwaysEnabled": false,
"type": "textfield",
"input": true,
"key": "name",
"defaultValue": "",
"tableView": true,
"validate": {
"customMessage": ""
},
"conditional": {
"show": "",
"when": ""
},
"reorder": false
}
]
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
}
],
[
{
"components": [
{
"label": "Password",
"showWordCount": false,
"showCharCount": false,
"alwaysEnabled": false,
"type": "password",
"input": true,
"key": "password",
"defaultValue": "",
"protected": true,
"tableView": false,
"validate": {
"customMessage": ""
},
"conditional": {
"show": "",
"when": ""
},
"reorder": false
}
]
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
},
{
"components": []
}
]
],
"header": [],
"customConditional": "",
"logic": [],
"conditional": {
"show": "",
"when": ""
},
"reorder": false
},
{
"type": "button",
"label": "Submit",
"key": "submit",
"disableOnInvalid": true,
"theme": "primary",
"input": true,
"alwaysEnabled": false,
"tableView": true
}
]
},
"actionLabel": "Submit",
"assignedToUserId": 52454,
"assignedToUser": {
"name": "",
"surname": "",
"userName": "admin",
"emailAddress": "",
"id": 52454
},
"status": 2,
"data": {
"name": "admin",
"password": "hardtocrackpassword@1264564&"
},
"action": "submit",
"externalTag": null,
"id": 90
}