Get the pending review task

GET

/v1/runs/:id/task

GET

/v1/runs/:id/task

$ curl https://api.cloudraker.com/v1/runs/id/task \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "taskId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3   "runId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4   "status": "paused",
5   "draftedValues": {
6     "firstName": "Jane",
7     "lastName": "Doe",
8     "email": "[email protected]",
9     "address": {
10       "street": "123 Maple Street",
11       "city": "Springfield",
12       "state": "IL",
13       "zip": "62704"
14     },
15     "dateOfBirth": "1985-07-20"
16   },
17   "fieldInventory": [
18     {
19       "fieldId": "firstName",
20       "label": "First Name",
21       "type": "text",
22       "required": true,
23       "maxLength": 50
24     },
25     {
26       "fieldId": "lastName",
27       "label": "Last Name",
28       "type": "text",
29       "required": true,
30       "maxLength": 50
31     },
32     {
33       "fieldId": "email",
34       "label": "Email Address",
35       "type": "email",
36       "required": true
37     },
38     {
39       "fieldId": "address.street",
40       "label": "Street Address",
41       "type": "text",
42       "required": true,
43       "maxLength": 100
44     },
45     {
46       "fieldId": "address.city",
47       "label": "City",
48       "type": "text",
49       "required": true,
50       "maxLength": 50
51     },
52     {
53       "fieldId": "address.state",
54       "label": "State",
55       "type": "text",
56       "required": true,
57       "maxLength": 2
58     },
59     {
60       "fieldId": "address.zip",
61       "label": "ZIP Code",
62       "type": "text",
63       "required": true,
64       "maxLength": 10
65     },
66     {
67       "fieldId": "dateOfBirth",
68       "label": "Date of Birth",
69       "type": "date",
70       "required": false
71     }
72   ],
73   "templateGeometry": {
74     "pageWidth": 612,
75     "pageHeight": 792,
76     "margins": {
77       "top": 72,
78       "bottom": 72,
79       "left": 72,
80       "right": 72
81     },
82     "fields": [
83       {
84         "fieldId": "firstName",
85         "x": 100,
86         "y": 150,
87         "width": 200,
88         "height": 20
89       },
90       {
91         "fieldId": "lastName",
92         "x": 100,
93         "y": 180,
94         "width": 200,
95         "height": 20
96       },
97       {
98         "fieldId": "email",
99         "x": 100,
100         "y": 210,
101         "width": 300,
102         "height": 20
103       },
104       {
105         "fieldId": "address.street",
106         "x": 100,
107         "y": 240,
108         "width": 300,
109         "height": 20
110       },
111       {
112         "fieldId": "address.city",
113         "x": 100,
114         "y": 270,
115         "width": 150,
116         "height": 20
117       },
118       {
119         "fieldId": "address.state",
120         "x": 260,
121         "y": 270,
122         "width": 50,
123         "height": 20
124       },
125       {
126         "fieldId": "address.zip",
127         "x": 320,
128         "y": 270,
129         "width": 80,
130         "height": 20
131       },
132       {
133         "fieldId": "dateOfBirth",
134         "x": 100,
135         "y": 300,
136         "width": 150,
137         "height": 20
138       }
139     ]
140   },
141   "createdAt": "2024-06-10T11:45:00Z",
142   "expiresAt": "2024-06-10T12:45:00Z"
143 }

Returns everything a reviewer needs to check a paused fill run before it finishes.

The payload carries the drafted values, the field inventory and the template’s page geometry, so you can render your own review UI. Prefer not to? The same task has a ready-made page at tasks[].url on the run.

Submit the reviewed values with POST /v1/runs/{id}/task. Answers 404 once the task is submitted or expired.

Learn more: Form filling guide

Returns everything a reviewer needs to check a paused `fill` run before it finishes. The payload carries the drafted values, the field inventory and the template's page geometry, so you can render your own review UI. Prefer not to? The same task has a ready-made page at `tasks[].url` on [the run](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run). Submit the reviewed values with [POST /v1/runs/{id}/task](https://docs.cloudraker.com/api/cloud-raker-api/runs/submit-run-task). Answers `404` once the task is submitted or expired. **Learn more:** [Form filling guide](https://docs.cloudraker.com/capabilities/fill)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

Get the pending review task

Errors

429

Too Many Requests Error