Imagery Product Types API Guide

Control which imagery product types are included in tasking and archive requests.
This guide provides example API requests for submitting, updating, and managing imagery product types.

GEO is always required in tasking and cannot be removed.

## Supported Endpoints

| Action | Endpoint | Method |
|--------|----------|--------|
| Submit new task | `/task` | `POST` |
| Update task imagery product types | `/tasks/{id}` | `PATCH` |
| Set org defaults | `/organizations/{id}` | `PUT` |
| Review archive order | `/orders/review` | `POST` |
| Submit archive order | `/orders/` | `POST` |

Submit Task with Imagery Product Types

http
POST /task
{
  "contractId": "<contract-id>",
  "type": "Feature",
  "geometry": {
    "coordinates": [<longitude>, <latitude>],
    "type": "Point"
  },
  "properties": {
    "processingConfig": {
      "productTypes": [
        "GEO",   // Required
        "SICD",
        "GEC",
        "SLC"
      ]
    },
    "taskingrequestName": "<name>",
    "taskingrequestDescription": "<description>",
    "windowOpen": "<windowOpen>",
    "windowClose": "<windowClose>",
    "collectionTier": "<collectionTier>",
    "collectionType": "<collectionType>",
    "collectConstraints": {
      "localTime": "<localTime>",
      "offNadirMin": <offNadirMin>,
      "offNadirMax": <offNadirMax>,
      "polarization": "<polarization>",
      "azimuthAngleMin": <azimuthAngleMin>,
      "azimuthAngleMax": <azimuthAngleMax>
    },
    "archiveHoldback": "<archiveHoldback>"
  }
}

Update Imagery Product Types on Existing Task

You can modify imagery product types until 3 hours before the expected collection time.

PATCH /tasks/{id}

{
  "properties": {
    "processingConfig": {
      "productTypes": [
        "GEC",
        "SLC",
        "GEO",   // Must remain included
        "SICD"
      ]
    }
  }
}

Set Organization Default Product Types

Org Managers can define default and required product types for all new tasking requests.

PUT /organizations/{id}

{
  "defaultProductTypes": [
    {
      "productType": "GEO",
      "required": true      // Always included and locked
    },
    {
      "productType": "SLC",
      "required": false     // Optional, can be removed or modified by users
    }
  ]
}

Order Additional Product Types from Archive

Request alternate formats for previously collected imagery.

Step 1: Review the Order

POST /orders/review

{
  "items": [
    {
      "productType": "GEC",
      "collectIds": [
        "798ffc87-5b7b-4786-8611-42c23fc2a95f"
      ]
    }
  ]
}

Step 2: Submit the Order

POST /orders/

{
  "items": [
    {
      "productType": "GEC",
      "collectIds": [
        "798ffc87-5b7b-4786-8611-42c23fc2a95f"
      ]
    }
  ]
}

Notes & Best Practices

GEO is mandatory in all tasking requests and cannot be removed.
Optional product types can be changed per task.
Users cannot select product types marked as "unavailable" by their Org Manager.
Archive orders allow generating product types not originally requested.
Changes to tasking product types must be made ≥3 hours before expected collection.