Pipeline

GET 
/pipelines/:namespace/:name

Gets details about a pipeline. The settings_schema property of the pipeline object describes the settings that control the pipeline's output.

Request

Path Parameters

namespace stringrequired
The namespace the pipeline belongs to.
Example: imagery
name stringrequired
The name of the pipeline.
Example: view-ready-ortho

Responses

200

OK

application/json

Schema

Schema

data objectrequired
date_created string
date_modified string
namespace string
name string
display_name string
product_id number
description string
api_config object
base_url string
headers object
auth_provider string
settings_schema object
The schema of the pipeline's order settings
billing_metric string
tags string[]
contacts string[]
documentation_link string
enabled boolean
orders_cancellable boolean
settings_config object
default_settings object
geometry_fields array
pipeline_links object
self string
post_order string
links objectrequired
request string
request_timestamp stringrequired
response_timestamp stringrequired
request_duration numberrequired

Example (from schema)

{
  "data": {
    "date_created": "2023-02-21T16:34:00Z",
    "date_modified": "2023-03-17T16:28:06Z",
    "namespace": "imagery",
    "name": "analysis-ready",
    "display_name": "analysis-ready",
    "product_id": 94,
    "description": "Pipeline for ordering Analysis-Ready Data imagery",
    "api_config": {
      "base_url": "https://api.maxar.com/ordering/v1/",
      "headers": {},
      "auth_provider": "mgp"
    },
    "settings_schema": {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Schema to validate parameters of ARD order",
      "additionalProperties": false,
      "title": "ARD order parameters",
      "type": "object",
      "properties": {
        "ard_settings": {
          "type": "object",
          "properties": {
            "bundle_adjust": {
              "type": "boolean"
            },
            "cloud_mask": {
              "type": "boolean"
            },
            "pan_analytic": {
              "type": "boolean"
            },
            "water_mask": {
              "type": "boolean"
            },
            "data_mask": {
              "type": "boolean"
            },
            "ms_analytic": {
              "type": "boolean"
            },
            "ms_saturation_mask": {
              "type": "boolean"
            },
            "healthy_vegetation_mask": {
              "type": "boolean"
            },
            "terrain_shadow_mask": {
              "type": "boolean"
            },
            "visual": {
              "type": "boolean"
            },
            "hd": {
              "type": "boolean"
            },
            "pan_flare_mask": {
              "type": "boolean"
            }
          }
        },
        "acquisitions": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "additionalProperties": false,
                "type": "object",
                "properties": {
                  "cell_ids": {
                    "type": "array"
                  },
                  "id": {
                    "type": "string"
                  }
                },
                "required": [
                  "id"
                ]
              },
              {
                "type": "string"
              }
            ]
          }
        },
        "intersects": {
          "type": [
            "string",
            "object"
          ]
        },
        "bbox": {
          "type": "array",
          "items": {
            "minItems": 4,
            "type": "number",
            "maxItems": 4
          }
        }
      },
      "required": [
        "acquisitions"
      ],
      "$id": "https://example.com/example.schema.json"
    },
    "billing_metric": "sqkm",
    "tags": [
      "string"
    ],
    "contacts": [
      "string"
    ],
    "documentation_link": "string",
    "enabled": true,
    "orders_cancellable": false,
    "settings_config": {
      "default_settings": {},
      "geometry_fields": [
        null
      ]
    },
    "pipeline_links": {
      "self": "https://api.maxar.com/ordering/v1/pipelines-integration/imagery/analysis-ready",
      "post_order": "https://api.maxar.com/ordering/v1/pipelines-integration/imagery/analysis-ready/order"
    }
  },
  "links": {
    "request": true
  },
  "request_timestamp": "2022-12-01T23:19:02Z",
  "response_timestamp": "2022-12-01T23:19:06Z",
  "request_duration": 4
}

Loading...