Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
Scenes

Create a satellite data ingestion job.

put/scenes/satellite/ingest-data/{jobId}

Path parameters

jobIdstring required

JobId provided by user.

Query parameters

api-versionstring required

The requested API version

Request body

partyIdstring required

Party Id.

startDateTimestring date-time

Start Date.

endDateTimestring date-time

End Date.

provider'SentinelHub'

Provider of satellite data. Available Value: SentinelHub.

collectionstring required

Collection of satellite data. Available Value: sentinel-2-l2a, sentinel-2-l1c.

itemIdstring

Item Id used to get scenes from sentinel hub.

idstring

Unique job id.

statusstring

Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

durationInSecondsnumber double

Duration of the job in seconds.

messagestring

Status message to capture more details of the job.

errorCodestring

Error Code when job failed.

createdDateTimestring date-time

Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.

lastActionDateTimestring date-time

Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.

startTimestring date-time

Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.

endTimestring date-time

Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

Example request

{
  "data": {
    "imageNames": [
      "NDVI"
    ],
    "imageFormats": [
      "TIF"
    ],
    "imageResolutions": [
      10
    ]
  },
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Response

Accepted

partyIdstring required

Party Id.

startDateTimestring date-time

Start Date.

endDateTimestring date-time

End Date.

provider'SentinelHub'

Provider of satellite data. Available Value: SentinelHub.

collectionstring required

Collection of satellite data. Available Value: sentinel-2-l2a, sentinel-2-l1c.

itemIdstring

Item Id used to get scenes from sentinel hub.

idstring

Unique job id.

statusstring

Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

durationInSecondsnumber double

Duration of the job in seconds.

messagestring

Status message to capture more details of the job.

errorCodestring

Error Code when job failed.

createdDateTimestring date-time

Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.

lastActionDateTimestring date-time

Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.

startTimestring date-time

Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.

endTimestring date-time

Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

Example response

{
  "data": {
    "imageNames": [
      "NDVI"
    ],
    "imageFormats": [
      "TIF"
    ],
    "imageResolutions": [
      10
    ]
  },
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}