orchestrator
2020.10
false
  • Getting Started
  • Swagger Definition
  • Orchestrator APIs
UiPath logo, featuring letters U and I in white
OUT OF SUPPORT

Orchestrator API Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Jun 18, 2024

Task Forms Requests

Complete Task

The current user needs to be assigned to that task otherwise the action cannot be performed.

POST

{OrchestratorURL}/forms/TaskForms/CompleteTask

Request headers

Key

Value

Authorization

Bearer

Request body

{
  "taskId": 195,
  "data": {name: "dada", password: "dada", submit: true},
  "action": "submit"
}{
  "taskId": 195,
  "data": {name: "dada", password: "dada", submit: true},
  "action": "submit"
}

Response code

204 No content

Return Task Form

Retrieve the task form based on the taskId. The taskId must be included in the request.

GET

{OrchestratorURL}/forms/TaskForms/GetTaskFormById?taskId=90

Request headers

Key

Value

Authorization

Bearer

Response code

200 OK

Response body

{
  "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
}
  • Complete Task
  • Request headers
  • Request body
  • Response code
  • Return Task Form
  • Request headers
  • Response code
  • Response body

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.