List Sub-Catalog Collections

GET 
/catalogs/:subCatalogId/collections

List the collections that belong to a Sub-Catalog

Request

Path Parameters

subCatalogId stringrequired

Identifier (name) of a specific collection

Query Parameters

sortby string

An array of property names, prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. Currently only two properties are supported: datetime and id.

Examples:

order-id

Example: id

order-id-desc

Example: -id

datetime

Example: datetime

datetime-desc

Example: -datetime

orderby string

(Deprecated in favor of sortby) SQL-style ORDER BY clause. The only properties results can be ordered by are "id" and "datetime". You can use ASC and DESC modifiers on each column. If not specified then orderby defaults to "datetime DESC, id ASC".

Examples:

order-id

Example: id

order-id-desc

Example: id DESC

datetime

Example: datetime

datetime-desc

Example: datetime DESC

limit integer
Maximum number of collections to return
Example: 10
page integer
Page number to retrieve. First page is numbered 1.
Example: 2

Responses

200

Return list of collection definitions

Response Headers

• X-Maxar-RequestId any

application/json

Schema

Schema

collections object[]required
Array [
stac_version stringrequired
id stringrequired
title string
description stringrequired
links object[]
Array [
href urlrequired
rel stringrequired
type string
title string
]
]
links object[]
An array of links. Can be used for pagination, e.g. by providing a link with the next relation type.
Array [
href urlrequired
rel stringrequired
type string
title string
]

Example (from schema)

{
  "collections": [
    {
      "stac_version": "1.0.0",
      "id": "wv01",
      "title": "WorldView-1",
      "description": "WorldView-1 Imagery",
      "links": [
        {
          "href": "https://api.maxar.com/discovery/v1/collections/child-catalog.json",
          "rel": "child",
          "type": "application/json",
          "title": "Child Catalog"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "next",
      "href": "https://api.maxar.com/discovery/v1/search?orderby=id&page=3&limit=10"
    }
  ]
}

400

Error in user request

Response Headers

• X-Maxar-RequestId any

application/json

Schema

Schema

message string
request_id string

UUID of web request

Example (from schema)

{
  "message": "string",
  "request_id": "string"
}

500

The request could not be handled by the server.

Response Headers

• X-Maxar-RequestId any

application/json

Schema

Schema

message string
request_id string

UUID of web request

Example (from schema)

{
  "message": "string",
  "request_id": "string"
}

Loading...