Skip to main content

Batch Processing API Reference

API docs by Redocly

API Reference (1.0.0)

Download OpenAPI specification:Download

This page contains the documentation on how to use sentinel hub services through API calls.

Note: This documentation is not complete

Process

Submit new batch processing request

Authorizations:
OAuth2
Request Body schema:
required
object (ProcessRequestForBatchV2)

Batch processing equivalent of the Process request.

required
ProcessInput (object) or ProcessInput (object) (BatchV2ProcessInput)
required
ProcessOutput (object) or ProcessOutput (object) (BatchV2ProcessOutput)
instanceType
string (InstanceType)
Enum: "normal" "large"

Instance type to be used for processing.

description
string

Optional description that can be used to keep track of requests

Responses

Request samples

Content type
{
  • "processRequest": {
    },
  • "input": {
    },
  • "output": {
    },
  • "instanceType": "normal",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "request": {
    },
  • "domainAccountId": "4e1699b2-af74-455a-818d-6f1ec31a6d19",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
  • "status": "CREATED",
  • "error": "string",
  • "userAction": "NONE",
  • "userActionUpdated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "completionPercentage": 0,
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "costPU": 0,
  • "stoppedStatusReason": "OUT_OF_PU"
}

Query batch process requests

Authorizations:
OAuth2
query Parameters
count
integer <int32>

Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through.

viewtoken
string

When the total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items.

The next page can be retrieved by repeating the query. However, replace your URL with the next URL in the returned links object.

sort
string
Enum: "created" "created:desc" "status" "status:desc"

Sort the batch process requests by given field. Omit for default ordering.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {}
}

Retrieve a single batch process task by ID

Authorizations:
OAuth2
path Parameters
taskId
required
string <uuid>

Task ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "request": {
    },
  • "domainAccountId": "4e1699b2-af74-455a-818d-6f1ec31a6d19",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
  • "status": "CREATED",
  • "error": "string",
  • "userAction": "NONE",
  • "userActionUpdated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "completionPercentage": 0,
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "costPU": 0,
  • "stoppedStatusReason": "OUT_OF_PU"
}

Update a batch process request

Only the requests that are not currently being processed nor waiting to be processed can be updated.

Authorizations:
OAuth2
path Parameters
taskId
required
string <uuid>

Task ID

Request Body schema: application/json
description
string

Optional description that can be used to keep track of requests. If omitted, the description will not be changed.

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "processRequest": {
    },
  • "input": {
    },
  • "output": {
    },
  • "instanceType": "normal",
  • "description": "string"
}

Request analysis of a batch process request

Authorizations:
OAuth2
path Parameters
taskId
required
string <uuid>

Task ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Start (confirm) processing of a batch process request

Authorizations:
OAuth2
path Parameters
taskId
required
string <uuid>

Task ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Stop a batch process request

Authorizations:
OAuth2
path Parameters
taskId
required
string <uuid>

Task ID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Tiling grid

Get properties of all supported tiling grids

Authorizations:
OAuth2
query Parameters
count
integer <int32>

Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use viewtoken to page through.

viewtoken
string

When the total number of items is larger than count, the response contains viewtoken. This viewtoken can be used in the next request to retrieve the next page of items.

The next page can be retrieved by repeating the query. However, replace your URL with the next URL in the returned links object.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {}
}

Get properties of a single tiling grid

Authorizations:
OAuth2
path Parameters
id
required
integer <int64>

Tilinggrids ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "properties": {
    }
}
Last updated on