Imagery Product Types

Control which imagery product types to include in tasking and archive order requests.

This guide provides example API requests for submitting tasking requests with imagery product types, updating imagery product types of tasking requests and managing default imagery product types of an organization.

GEO is a system required product type and can not be removed.

Supported Endpoints

Submit Task with Specific Imagery Product Types

POST /task

{
  "contractId": "<contract-id>",
  "type": "Feature",
  "geometry": {
    "coordinates": [<longitude>, <latitude>],
    "type": "Point"
  },
  "properties": {
    "processingConfig": {
      "productTypes": [
        "GEO",
        "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>"
  }
}

Note: when not providing properties.processingConfig.productTypes as part of the request body to POST /task the organization's default imagery product types are used.

Update Imagery Product Types of an Active Task

Please note that editing imagery product types is possible up to 3 hours before expected collection time. The system will reject updates after that time.

PATCH /tasks/{id}

{
  "properties": {
    "processingConfig": {
      "productTypes": [
        "GEC",
        "SLC",
        "GEO"
      ]
    }
  }
}

# Note: GEO must remain included (system required)

Set Organization Default Product Types

Organization Managers can define default product types which are applicable for all new tasking requests.

PUT /organizations/{id}

{
  "defaultProductTypes": [
    {
      "productType": "GEO",
      "required": true      
    },
    {
      "productType": "GEC",
      "required": true      
    },
    {
      "productType": "SLC",
      "required": false     
    }
  ]
}

Explanation: A task submitted by a user of above organization will have the following rules applied:

• GEO is required (can not be removed - system requirement)
• GEC is required (can not be removed - org requirement)
• SLC is not required (can be removed - org requirement)

Order Additional Product Types from Archive ("async order")

You can request imagery product types that does not exist in the archive to be generated by submitting an async order. This will result in the product type to be generated "on-demand" and yield an in-progress order. All assets of the order will become available for download upon completion of the order.

Step 1: Review the Order To Get Cost Estimate

assume GEC does not exist for below collect id

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 for all tasking requests and cannot be removed.
• Optional product types can be changed per task.
• Archive orders allow generating product types not originally requested.
• Changes to tasking product types must be made ≥3 hours before expected collection.
• Org default product types are applicable for all new tasking requests.
• Not providing properties.processingConfig.productTypes as POST /task body sets the organization's default imagery product types.