Validate Order

POST 
/pipelines/:namespace/:name/validate

Validate an order request before placing it. This "dry runs" the request to make sure the order configuration is valid.

Request

Path Parameters

namespace stringrequired
REQUIRED. A group of pipelines.
Example: imagery
name stringrequired
REQUIRED. The name of the pipeline.
Example: analysis-ready

application/json

Body

output_configs object[]required
Sets delivery notifications
Array [
oneOf
Amazon S3
type stringrequired
Possible values: [amazon_s3]
bucket stringrequired
prefix stringrequired
role_arn string
Google Cloud Storage
type stringrequired
Possible values: [google_cloud_storage]
bucket stringrequired
prefix stringrequired
service_credentials stringrequired
Azure Blob Storage
type stringrequired
Possible values: [azure_blob_storage]
container stringrequired
prefix stringrequired
sas_url stringrequired
File Download
type stringrequired
Possible values: [download]
format stringrequired
Possible values: [zip, tar]
MGP Order Manager
type stringrequired
Possible values: [mgp_order_manager]
]
notifications object[]
Sets order notifications
Array [
oneOf
HTTP Callback
config object
headers object
internal_auth_provider string
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [http]
Amazon SNS
config object
requires_message_deduplication_id booleanrequired
requires_message_group_id booleanrequired
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [sns]
Email
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [email]
]
settings object

Specifies pipeline specific settings

metadata object

Arbitrary user key-value metadata

Responses

200

OK

application/json

Schema

Schema

data objectrequired
message string
usage undefined[]
Schema to validate pipeline order usage report
Array [
description string
product_id number
quantity numberrequired
units stringrequired
Possible values: [sqkm, request_count, feature_count, byte_count, pixel_count, tile_count, credits]
]
links objectrequired
request string
request_timestamp stringrequired
response_timestamp stringrequired
request_duration numberrequired

Example (from schema)

{
  "data": {
    "message": "Order dry-run validation successful.",
    "usage": [
      {
        "description": "Fresh Archive Imagery < 90 Days",
        "product_id": 242,
        "quantity": 12,
        "units": "sqkm"
      }
    ]
  },
  "links": {
    "request": true
  },
  "request_timestamp": "2022-12-01T23:19:02Z",
  "response_timestamp": "2022-12-01T23:19:06Z",
  "request_duration": 4
}

Loading...