Get Job

GET

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

GET

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

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

1 {
2   "id": "job-12345",
3   "attempt_id": "attempt-67890",
4   "name": "data-preprocessing-job",
5   "workspace": "research-team-alpha",
6   "source": "git@github.com:nemo-org/ml-pipeline.git",
7   "platform_spec": {
8     "steps": [
9       {
10         "name": "preprocess",
11         "executor": {
12           "provider": "cpu",
13           "container": {
14             "image": "nemoorg/data-preprocess:1.2.0",
15             "entrypoint": [
16               "/bin/sh",
17               "-c"
18             ],
19             "command": [
20               "python preprocess.py --input $DATA_PATH --output /mnt/data/processed"
21             ]
22           },
23           "profile": "default",
24           "resources": {
25             "requests": {
26               "cpu": "500m",
27               "memory": "1Gi"
28             },
29             "limits": {
30               "cpu": "1",
31               "memory": "2Gi"
32             },
33             "num_nodes": 1,
34             "num_gpus": 0,
35             "shm_size": "1Gi"
36           }
37         },
38         "environment": [
39           {
40             "name": "DATA_PATH",
41             "value": "/mnt/data/raw",
42             "from_secret": {
43               "name": "db_password"
44             }
45           }
46         ],
47         "config": {},
48         "lifecycle": {
49           "staleness_timeout_seconds": 300
50         }
51       }
52     ]
53   },
54   "fileset": "fileset-98765",
55   "status": "created",
56   "project": "urn:nemo:project:ml-pipeline",
57   "description": "Job to preprocess raw data for model training",
58   "spec": {},
59   "status_details": {},
60   "error_details": {},
61   "created_at": "2024-01-15T09:30:00Z",
62   "updated_at": "2024-01-15T09:30:00Z",
63   "ownership": {},
64   "custom_fields": {}
65 }

Get a platform job by name.

Path parameters

namestringRequired

workspacestringRequired

Response

Successful Response

idstring

attempt_idstring

namestring

workspacestring

Workspace identifier

sourcestring

platform_specobject

Specification for a platform job, containing steps and secrets.

filesetstring

Fileset ID for storing job artifacts

statusenum

Enumeration of possible job statuses. This enum represents the various states a job can be in during its lifecycle, from creation to a terminal state.

projectstring

Project URN

descriptionstring

specmap from strings to any

Job Spec

status_detailsmap from strings to any

Details about the job status

error_detailsmap from strings to any

created_atdatetime

updated_atdatetime

ownershipmap from strings to any

custom_fieldsmap from strings to any

Custom Fields

Errors

404

Not Found Error

422

Unprocessable Entity Error