STAC Collection Configuration

Update Collection Queryables

Changed on

Updates a queryable given a queryable definition and corresponding collection id.

put/stac/collections/{collectionId}/queryables/{queryableName}

Request

  • Base URL
    {endpoint}
  • URL
    {endpoint}/stac/collections/{collectionId}/queryables/{queryableName}
  • Auth
    OAuth 2
    Implicit: https://login.microsoftonline.com/common/oauth2/authorize
    Scopes: https://geocatalog.spatio.azure.com/.default

Path parameters

collectionIdstring required

Unique identifier for the STAC collection.

queryableNamestring required

Name of the queryable property to operate on.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

namestring required

Name of the queryable field.

definitionobject required

Metadata for the queryable field.

create_indexboolean

Whether to create a database index for this field.

data_type'string' | 'number' | 'boolean' | 'timestamp' | 'date'

Data type of the queryable field.

Response

The request has succeeded.

namestring required

Name of the queryable field.

definitionobject required

Metadata for the queryable field.

create_indexboolean

Whether to create a database index for this field.

data_type'string' | 'number' | 'boolean' | 'timestamp' | 'date'

Data type of the queryable field.

Changes

  • 2025-04-30-preview28e8cb365289Revision changes
    • breaking

      removed the success response with the status

    • info

      api operation id StacQueryables_CreateOrReplace removed and replaced with StacQueryables_Replace

  • 2025-04-30-preview00cbc3d6d8e0Revision changes
    • info

      api operation id StacQueryables_Replace removed and replaced with StacQueryables_CreateOrReplace

    • info

      added the success response with the status