Get a workflow task prompt

get/workflowTasks/{taskId}/prompts/{promptId}

Returns a specific prompt that is associated with a workflow user task. The prompts are part of the workflow definition.

Request Samples

1

Response Samples

1{
2  "id": "string",
3  "name": "string",
4  "variableType": "string",
5  "variableName": "string",
6  "values": [
7    {
8      "id": "string",
9      "name": "string",
10      "value": "string"
11    }
12  ],
13  "required": "string",
14  "defaultValueId": "string",
15  "actualValue": "string",
16  "version": -2147483648,
17  "links": [
18    {
19      "method": "string",
20      "rel": "string",
21      "uri": "string",
22      "href": "string",
23      "title": "string",
24      "type": "string",
25      "itemType": "string",
26      "responseType": "string",
27      "responseItemType": "string"
28    }
29  ]
30}

Path Parameters

NameTypeRequiredDescription
promptId
string
true

The ID of a prompt from the prompts collection.

taskId
string
true

The ID of a task from the tasks collection.

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

The request was invalid.

Schema
404Not Found

No task or prompt with the specified ID exists at the requested path.

Schema