List Steps

GET

https://host.com/apis/jobs/v2/workspaces/:workspace/jobs/:name/steps

GET

/apis/jobs/v2/workspaces/:workspace/jobs/:name/steps

$ curl https://host.com/apis/jobs/v2/workspaces/workspace/jobs/name/steps \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "id": "step-1234abcd",
5       "job": "job-5678efgh",
6       "attempt_id": "attempt-0001",
7       "fileset": "fileset-20240115",
8       "workspace": "research-team-alpha",
9       "name": "preprocess",
10       "step_spec": {
11         "name": "preprocess",
12         "executor": {
13           "provider": "cpu",
14           "container": {
15             "image": "nemo/preprocess:1.2.0",
16             "entrypoint": [
17               "/bin/sh",
18               "-c"
19             ],
20             "command": [
21               "python preprocess.py --input $DATA_PATH"
22             ]
23           },
24           "profile": "default",
25           "resources": {
26             "requests": {
27               "cpu": "500m",
28               "memory": "1Gi"
29             },
30             "limits": {
31               "cpu": "1",
32               "memory": "2Gi"
33             },
34             "num_nodes": 1,
35             "num_gpus": 0,
36             "shm_size": "1Gi"
37           }
38         },
39         "environment": [
40           {
41             "name": "DATA_PATH",
42             "value": "/mnt/data/input",
43             "from_secret": {
44               "name": "db-password"
45             }
46           }
47         ],
48         "config": {},
49         "lifecycle": {
50           "staleness_timeout_seconds": 300
51         }
52       },
53       "status": "active",
54       "status_details": {},
55       "error_details": {},
56       "auth_context": {
57         "principal_id": "user-7890xyz",
58         "principal_email": "alice@example.com",
59         "principal_groups": [
60           "data-scientists",
61           "ml-engineers"
62         ],
63         "principal_on_behalf_of": "user-1234abc",
64         "principal_on_behalf_of_groups": [
65           "project-managers"
66         ],
67         "principal_on_behalf_of_email": "bob@example.com"
68       },
69       "created_at": "2024-01-15T09:30:00Z",
70       "updated_at": "2024-01-15T10:00:00Z"
71     }
72   ],
73   "pagination": {
74     "page": 1,
75     "page_size": 25,
76     "current_page_size": 1,
77     "total_pages": 1,
78     "total_results": 1
79   },
80   "sort": "created_at",
81   "filter": {}
82 }

List job steps with pagination and filtering.

Path parameters

namestringRequired

workspacestringRequired

Query parameters

pageintegerOptionalDefaults to 1

Page number.

page_sizeintegerOptionalDefaults to 25

Page size.

sortenumOptionalDefaults to created_at

The field to sort by. To sort in decreasing order, use - in front of the field name.

Allowed values:

filterobjectOptional

Filter steps by job, status, and source.

Response

Successful Response

datalist of objects

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

422

Unprocessable Entity Error