App Tasks requests

Requesting App Tasks

Use the following endpoints to retrieve App Task metadata and status information.

You can request App Tasks using either the ID or the Key returned when creating or listing tasks.

According to App Task ID

Retrieve an App Task using its ID.

Obtenir

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/GetAppTaskById

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 Réussite

Corps de la réponse

{
  "id": 58293,
  "key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
  "title": "Approve Purchase Request",
  "status": "Pending",
  "priority": "Normal",
  "type": "AppTask",
  "appTasksMetadata": {
    "appId": "myapp-12345",
    "appVersion": 3,
    "creationTime": "2024-01-11T10:20:30Z",
    "id": 58293
  }
}

According to App Task key

Retrieve an App Task using its unique key.

Obtenir

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/GetAppTaskByKey

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 Réussite

Corps de la réponse

{
  "id": 58293,
  "key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
  "title": "Approve Purchase Request",
  "status": "Pending",
  "priority": "Normal",
  "type": "AppTask",
  "appTasksMetadata": {
    "appId": "myapp-12345",
    "appVersion": 3,
    "creationTime": "2024-01-11T10:20:30Z",
    "id": 58293
  }
}

Create a new App Task

Use this endpoint to create a new App Task based on a previously-deployed App and Task Definition.

Obtenir

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/CreateAppTask

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

201 Créé

Corps de la requête

{
  "appId": "myapp-12345",
  "appVersion": 3,
  "folderKey": "folder-12345-678910",
  "fpsContext": (),
  "runtime": "Serverless",
  "appType": "Custom",
  "appProcessKey": "key123-4567-8910",
  "isActionableMessageEnabled": false,
  "title": "Approve Purchase Request",
  "type": "AppTask",
  "title": "string",
  "priority": "Normal",
  "data": {
    "Amount": 2450,
    "Requester": "John Doe"
  }
}

Corps de la réponse

{
    "taskDefinitionPropertiesId": null,
    "appTasksMetadata": null,
    "actionLabel": null,
    "status": 0,
    "data": null,
    "action": null,
    "waitJobState": null,
    "organizationUnitFullyQualifiedName": null,
    "tags": [],
    "assignedToUser": null,
    "taskSlaDetails": null,
    "completedByUser": null,
    "taskAssignmentCriteria": "SingleUser",
    "taskAssignees": null,
    "isCurrentUserInAllUserAssignedGroup": null,
    "taskSource": null,
    "processingTime": null,
    "title": "string",
    "type": "AppTask",
    "priority": "Low",
    "assignedToUserId": null,
    "assignedToUserKey": null,
    "organizationUnitId": 1,
    "organizationUnitKey": "key-12345",
    "externalTag": null,
    "creatorJobKey": "00000000-0000-0000-0000-000000000000",
    "waitJobKey": null,
    "lastAssignedTime": null,
    "completionTime": null,
    "parentOperationId": null,
    "key": "f1ac-12345",
    "isDeleted": false,
    "deleterUserId": null,
    "deletionTime": null,
    "lastModificationTime": null,
    "lastModifierUserId": null,
    "creationTime": "2025-12-11T09:23:05.9915069Z",
    "creatorUserId": "user-12345",
    "id": 12345
}