See jobs
To see a list of jobs from a specific project, call the /projects/{project_id}/jobs endpoint with your project ID as a path parameter.
Request
GET /projects/{project_id}/jobs HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
Response
See response example
{
"error": null,
"data": [
{
"id": "0479cdb8-99d0-4de1-b0e2-6ff6b69d0f68",
"displayId": "0479cdb8",
"createdAt": "2021-09-28T12:08:45.377339Z",
"updatedAt": "2021-09-28T12:08:45.377339Z",
"createdBy": {
"id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
"type": "USER"
},
"updatedBy": {
"id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
"type": "USER"
},
"status": "SUCCEEDED",
"name": "Convert from DIMAP to GEOTIFF",
"startedAt": "2020-11-11T11:55:07.465884Z",
"finishedAt": "2020-11-12T11:55:07.465884Z",
"inputs": {
"data-conversion-dimap:1": {
"ms": true,
"pan": false,
"bbox": [0],
"contains": {
"type": "Polygon",
"coordinates": [
[
[77.259584, 28.622331],
[77.287879, 28.622632],
[77.287621, 28.594794],
[77.259389, 28.594983],
[77.259584, 28.622331]
]
]
},
"intersects": {},
"clip_to_aoi": true
},
"oneatlas-pleiades-fullscene:1": {
"ids": ["string"],
"time": "2018-01-01T00:00:00+00:00/2021-12-31T23:59:59+00:00",
"limit": 1,
"contains": {
"type": "Polygon",
"coordinates": [
[
[77.259584, 28.622331],
[77.287879, 28.622632],
[77.287621, 28.594794],
[77.259389, 28.594983],
[77.259584, 28.622331]
]
]
},
"asset_ids": ["string"],
"time_series": ["string"],
"max_cloud_cover": 20
}
},
"mode": "DEFAULT",
"workflowId": "5ad07b37-f6a1-4830-dd74-f4e50528b0ed",
"workflowName": "Convert from DIMAP to GEOTIFF"
}
]
}
Parameter | Overview |
---|---|
data.id | string The job ID. |
data.displayID | string The display ID of the job. |
data.createdAt | string The timestamp when the job was created. |
data.updatedAt | string The timestamp when the job was last updated. |
data.createdBy | object Information about the user who performed the action. |
data.createdBy.id | string The ID of the user who performed the action. |
data.createdBy.type | string The type of the user who performed the action. |
data.updatedBy | object Information about the user who performed the action. |
data.updatedBy.id | string The ID of the user who performed the action. |
data.updatedBy.type | string The type of the user who performed the action. |
data.status | string The status of the job:
|
data.name | string The name of the job. |
data.startedAt | string The timestamp when the job started. |
data.finishedAt | string The timestamp when the job finished. |
data.inputs | object The configured job task parameters. |
data.mode | string The mode used to run the job:
|
data.workflowId | string The workflow ID. |
data.workflowName | string The name of the workflow. |
See a job
To see a specific job from a project, call the /projects/{project_id}/jobs/{job_id} endpoint with your project ID and job ID as path parameters.
Request
GET /projects/{project_id}/jobs/{job_id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
Response
The response is an object from the /projects/{project_id}/jobs data
array.
See response example
{
"error": null,
"data": {
"id": "0479cdb8-99d0-4de1-b0e2-6ff6b69d0f68",
"displayId": "0479cdb8",
"createdAt": "2021-09-28T12:08:45.377339Z",
"updatedAt": "2021-09-28T12:08:45.377339Z",
"createdBy": {
"id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
"type": "USER"
},
"updatedBy": {
"id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
"type": "USER"
},
"status": "SUCCEEDED",
"name": "Convert from DIMAP to GEOTIFF",
"startedAt": "2020-11-11T11:55:07.465884Z",
"finishedAt": "2020-11-12T11:55:07.465884Z",
"inputs": {
"data-conversion-dimap:1": {
"ms": true,
"pan": false,
"bbox": [0],
"contains": {
"type": "Polygon",
"coordinates": [
[
[77.259584, 28.622331],
[77.287879, 28.622632],
[77.287621, 28.594794],
[77.259389, 28.594983],
[77.259584, 28.622331]
]
]
},
"intersects": {},
"clip_to_aoi": true
}
},
"mode": "DEFAULT",
"workflowId": "5ad07b37-f6a1-4830-dd74-f4e50528b0ed",
"workflowName": "Convert from DIMAP to GEOTIFF"
}
}
See job tasks
Job tasks are unique configurations of workflow tasks in a job. To see detailed information about the job tasks from a specific job, call the /projects/{project_id}/jobs/{job_id}/tasks endpoint with your project ID and job ID as path parameters.
Request
GET /projects/{project_id}/jobs/{job_id}/tasks HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
Response
See response example
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayId": "96da3750",
"createdAt": "2022-09-20T12:24:14.47152Z",
"updatedAt": "2022-09-20T12:24:58.471141Z",
"createdBy": null,
"updatedBy": null,
"name": "oneatlas-pleiades-fullscene:1",
"status": "SUCCEEDED",
"parentsIds": [],
"startedAt": "2022-09-20T12:24:28Z",
"finishedAt": "2022-09-20T12:24:56Z",
"blockId": "defb134b-ca00-4e16-afa0-639c6dc0c5fe",
"blockVersion": "2.5.10",
"block": {
"id": "defb134b-ca00-4e16-afa0-639c6dc0c5fe",
"displayId": null,
"createdAt": null,
"updatedAt": null,
"createdBy": null,
"updatedBy": null,
"name": "oneatlas-pleiades-fullscene",
"displayName": null,
"description": null,
"containerUrl": null,
"inputCapabilities": null,
"outputCapabilities": null,
"provider": null,
"providerWebsite": null,
"providerLogoUrl": null,
"tags": null,
"isPublic": null,
"isPublicVersion": null,
"isValid": null,
"isRestricted": null,
"isAccessGranted": null,
"isCreditPurchaseRequired": null,
"isLimitStreamingDataAccess": null,
"parameters": null,
"type": "DATA",
"isDryRunSupported": null,
"version": "2.5.10",
"metadata": null,
"machineName": null,
"manifestVersion": 0,
"capabilities": null
},
"exitCode": 3,
"isDownloadable": true
}
],
"error": null
}
Parameter | Overview |
---|---|
data.id | string The job task ID. |
data.displayId | string The display ID of the job task. |
data.createdAt | string The timestamp when the job task was created. |
data.updatedAt | string The timestamp when the job task was last updated. |
data.createdBy | string Information about the user who performed the action. |
data.updatedBy | string Information about the user who performed the action. |
data.name | string The job task name. |
data.status | string The status of the job task:
|
data.startedAt | string The timestamp when the job task started. |
data.finishedAt | string The timestamp when the job task finished. |
data.blockId | string The ID of the block used to perform the job task. |
data.blockVersion | string The version of the block used to perform the job task. |
data.block | object Detailed information about the block. |
data.workflowName | string The name of the workflow. |
data.exitCode | integer The exit code of the job task. |
data.isDownloadable | boolean Whether the job task output is downloadable. |
Rename a job
To update a job's name, call the /projects/{project_id}/workflows/{workflow_id}/jobs/{job_id} endpoint with your project ID, workflow ID, and job ID as path parameters.
Request
PUT /projects/{project_id}/workflows/{workflow_id}/jobs/{job_id} HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}
Parameter | Overview |
---|---|
name | string A new name for the job. |
See request example
{
"name": "My newly renamed job"
}
Response
The response is the updated object from the /projects/{project_id}/jobs data
array.
See response example
{
"error": null,
"data": {
"id": "0479cdb8-99d0-4de1-b0e2-6ff6b69d0f68",
"displayId": "0479cdb8",
"createdAt": "2021-09-28T12:08:45.377339Z",
"updatedAt": "2021-09-28T12:08:45.377339Z",
"createdBy": {
"id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
"type": "USER"
},
"updatedBy": {
"id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
"type": "USER"
},
"status": "SUCCEEDED",
"name": "Convert from DIMAP to GEOTIFF",
"startedAt": "2020-11-11T11:55:07.465884Z",
"finishedAt": "2020-11-12T11:55:07.465884Z",
"inputs": {
"data-conversion-dimap:1": {
"ms": true,
"pan": false,
"bbox": [0],
"contains": {
"type": "Polygon",
"coordinates": [
[
[77.259584, 28.622331],
[77.287879, 28.622632],
[77.287621, 28.594794],
[77.259389, 28.594983],
[77.259584, 28.622331]
]
]
},
"intersects": {},
"clip_to_aoi": true
}
},
"mode": "DEFAULT",
"workflowId": "5ad07b37-f6a1-4830-dd74-f4e50528b0ed",
"workflowName": "Convert from DIMAP to GEOTIFF"
}
}
Cancel a job
To cancel a running job, call the /projects/{project_id}/jobs/{job_id}/cancel endpoint with your project ID and job ID as path parameters.
Request
POST /projects/{project_id}/jobs/{job_id}/cancel HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}
Response
If a job is cancelled successfully, there will be no response body.