Skip to main content

Retrieve the list of maps in the inventory.

GET 
/map/inventory

This endpoint returns a list of all maps currently available in the inventory. The list provides detailed information about each map, including its metadata, paths, and imaging dates.

Request​

Responses​

Schema

  • Array [

    • error

    object

    nullable

    Represents various types of errors that can occur in the application.

    When serialized, it will be represented in the following format:

    {
    "type": "ErrorType",
    "msg": "ErrorMessage"
    }

    Where:

    • type is the specific error type (e.g., ClientError, InternalServerError).

    • msg is the associated error message (a string).

    oneOf

    msg stringrequired
    type stringrequired

    Possible values: [ClientError]

    fileName stringnullable

    The filename associated with the map, if available. This field includes the name of the file, optionally without its extension. It can be None if the filename is unavailable or unspecified.

    name stringrequired

    Name of the map or the inventory item.

    reqId stringrequired

    Request ID associated with the map inventory.

    availabilityDate date-timenullable

    Optional: The date when the map is made available for use, if applicable.

    beginImagingDate date-timenullable

    Optional: start date of imaging for the map, if applicable.

    endImagingDate date-timenullable

    Optional: end date of imaging for the map, if applicable.

    footprint stringrequired

    Footprint of the map, usually represented as a string.

    paths string[]required

    Paths to the .gpkg and .json files on the filesystem.

  • ]

Loading...