Retry a failed job

POST

Retry a failt job and return the job

Path parameters

jobIdstringRequired

ID of job to return

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Response

This endpoint returns an object.

dataobject

A single unit of work that will execute asynchronously

POST

1 curl -X POST https://api.x.flatfile.com/v1/jobs/:jobId/retry \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>"

200Successful

1 {
2   "data": {
3     "createdAt": "2023-01-01T00:00:00Z",
4     "id": "string",
5     "operation": "string",
6     "source": "string",
7     "type": "file",
8     "updatedAt": "2023-01-01T00:00:00Z",
9     "config": {
10       "filter": "valid",
11       "filterField": "string",
12       "searchValue": "string",
13       "searchField": "string",
14       "q": "string",
15       "sheet": "string",
16       "exceptions": [
17         "string"
18       ],
19       "snapshotLabel": "string"
20     },
21     "destination": "string",
22     "environmentId": "string",
23     "fileId": "string",
24     "finishedAt": "2023-01-01T00:00:00Z",
25     "info": "string",
26     "input": {
27       "string": {}
28     },
29     "managed": true,
30     "metadata": {
31       "string": {}
32     },
33     "mode": "foreground",
34     "outcome": {
35       "string": {}
36     },
37     "outcomeAcknowledgedAt": "2023-01-01T00:00:00Z",
38     "parentId": "string",
39     "part": 0,
40     "partData": {
41       "string": {}
42     },
43     "partExecution": "sequential",
44     "predecessorIds": [
45       "string"
46     ],
47     "progress": 0,
48     "startedAt": "2023-01-01T00:00:00Z",
49     "status": "created",
50     "subject": {
51       "type": "resource",
52       "id": "string"
53     },
54     "trigger": "manual"
55   }
56 }

Built with

1	curl -X POST https://api.x.flatfile.com/v1/jobs/:jobId/retry \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>"

1	{
2	"data": {
3	"createdAt": "2023-01-01T00:00:00Z",
4	"id": "string",
5	"operation": "string",
6	"source": "string",
7	"type": "file",
8	"updatedAt": "2023-01-01T00:00:00Z",
9	"config": {
10	"filter": "valid",
11	"filterField": "string",
12	"searchValue": "string",
13	"searchField": "string",
14	"q": "string",
15	"sheet": "string",
16	"exceptions": [
17	"string"
18	],
19	"snapshotLabel": "string"
20	},
21	"destination": "string",
22	"environmentId": "string",
23	"fileId": "string",
24	"finishedAt": "2023-01-01T00:00:00Z",
25	"info": "string",
26	"input": {
27	"string": {}
28	},
29	"managed": true,
30	"metadata": {
31	"string": {}
32	},
33	"mode": "foreground",
34	"outcome": {
35	"string": {}
36	},
37	"outcomeAcknowledgedAt": "2023-01-01T00:00:00Z",
38	"parentId": "string",
39	"part": 0,
40	"partData": {
41	"string": {}
42	},
43	"partExecution": "sequential",
44	"predecessorIds": [
45	"string"
46	],
47	"progress": 0,
48	"startedAt": "2023-01-01T00:00:00Z",
49	"status": "created",
50	"subject": {
51	"type": "resource",
52	"id": "string"
53	},
54	"trigger": "manual"
55	}
56	}