{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference async_process batch_v2_process API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "batch_v2_process",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query batch process requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.sentinel-hub.com/batch/v2/process",
            "params": [
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "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.\nFor more records, use *viewtoken* to page through."
              },
              {
                "name": "viewtoken",
                "value": "",
                "type": "query",
                "description": "When the total number of items is larger than *count*, the response contains *viewtoken*.\nThis *viewtoken* can be used in the next request to retrieve the next page of items.\n\nThe next page can be retrieved by repeating the query. However, replace your URL with the\nnext URL in the returned links object.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the batch process requests by given field.\nOmit for default ordering.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Query batch process requests"
        },
        {
          "info": {
            "name": "Submit new batch processing request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/batch/v2/process",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Submit new batch processing request"
        },
        {
          "info": {
            "name": "Retrieve a single batch process task by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.sentinel-hub.com/batch/v2/process/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve a single batch process task by ID"
        },
        {
          "info": {
            "name": "Update a batch process request",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://services.sentinel-hub.com/batch/v2/process/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Only the requests that are not currently being processed nor waiting to be processed can be updated.\n"
        },
        {
          "info": {
            "name": "Request analysis of a batch process request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/batch/v2/process/:taskId/analyse",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Request analysis of a batch process request"
        },
        {
          "info": {
            "name": "Start (confirm) processing of a batch process request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/batch/v2/process/:taskId/start",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Start (confirm) processing of a batch process request"
        },
        {
          "info": {
            "name": "Stop a batch process request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/batch/v2/process/:taskId/stop",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Stop a batch process request"
        }
      ]
    }
  ],
  "bundled": true
}