Maxar Technologies Tasks API

The Tasks API from Maxar Technologies — 2 operation(s) for tasks.

Documentation

Specifications

Other Resources

OpenAPI Specification

maxar-technologies-tasks-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Vantor Hub Account Services Accounts Tasks API
  description: Administrative account-management API for Vantor Hub customers — manage users, roles, organisation entitlements, credit balances and API keys. Profile derived from public Vantor Hub docs (hub.vantor.com/docs/admin) and Maxar Geospatial Platform `account_service` SDK conventions; field shapes should be confirmed against live Hub responses.
  version: 1.0.0
servers:
- url: https://api.maxar.com/admin/v1
  description: Vantor Hub production
security:
- bearerAuth: []
tags:
- name: Tasks
paths:
  /tasks:
    get:
      tags:
      - Tasks
      summary: List Tasking Requests
      operationId: listTasks
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - submitted
          - planned
          - in_progress
          - complete
          - cancelled
          - failed
      - name: limit
        in: query
        schema:
          type: integer
          default: 25
      responses:
        '200':
          description: Tasks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'
    post:
      tags:
      - Tasks
      summary: Submit Tasking Request
      operationId: submitTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskRequest'
      responses:
        '201':
          description: Task submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
  /tasks/{taskId}:
    get:
      tags:
      - Tasks
      summary: Get Task
      operationId: getTask
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
    delete:
      tags:
      - Tasks
      summary: Cancel Task
      operationId: cancelTask
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Cancelled
components:
  schemas:
    Task:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
          - submitted
          - planned
          - in_progress
          - complete
          - cancelled
          - failed
        priority:
          type: string
        created_at:
          type: string
          format: date-time
        windows:
          type: array
          items:
            type: object
            properties:
              start:
                type: string
                format: date-time
              end:
                type: string
                format: date-time
              platform:
                type: string
    TaskRequest:
      type: object
      required:
      - aoi
      - start
      - end
      properties:
        name:
          type: string
        aoi:
          type: object
          description: GeoJSON geometry
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        priority:
          type: string
          enum:
          - Standard
          - Priority
          - Rush
          - Select
        platforms:
          type: array
          items:
            type: string
            enum:
            - WorldView-1
            - WorldView-2
            - WorldView-3
            - GeoEye-1
            - WorldView-Legion
        max_cloud_cover:
          type: number
        max_off_nadir:
          type: number
        gsd:
          type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT