STAC Layers

Overview

This RESTful API designed for searching the STAC layers. The API is secured and requires appropriate permissions for access. The API is secured and need API-Key to access them.

Please refer to the slide gIQ-Authentication for detailed instructions on how to generate the API key.

---

1. Retrieve STAC Layers

Overview

This API allows users to search and retrieve layers from the STAC based on various search parameters. It returns a paginated result of StacItem objects representing the search results.

---

Endpoint

• URL: https://giq.ae/public/file/stac
• Method: POST
• Produces: application/json

Description

This API retrieves layers from the STAC by applying the given search filters and returning paginated results.

Permissions Required

This API requires appropriate permissions based on the user's role and the layer being searched.

Request Body

Field	Type	Required	Description
intersects	Geometry	No	The geographical area to search within. Should be in Well-Known Text (WKT) format.
minCreationDate	Date	No	Minimum creation date for filtering layers.
maxCreationDate	Date	No	Maximum creation date for filtering layers.
search	String	No	Search term to filter layers.

Example Request Body

{
  "intersects": "POLYGON((30 10, 40 40, 20 40, 10 20, 30 10))",
  "minCreationDate": "2024-01-01T00:00:00Z",
  "maxCreationDate": "2024-12-31T23:59:59Z",
  "search": "forest"
}

Response

The response contains a paginated list of StacItem objects with details about the layers matching the search criteria.

Response Fields for StacItem

Field	Type	Description
stac_version	String	Version of the STAC specification.
stac_extensions	Set<String>	List of STAC extensions applied.
id	String	Unique identifier of the STAC item.
bbox	ArrayList<BigDecimal>	Bounding box of the STAC item.
geometry	Geometry	Geometry of the STAC item in Well-Known Text (WKT) format.
type	TypeEnum	Type of the STAC item. Typically "Feature".
properties	Object	Additional properties related to the STAC item.
links	Set<StacLink>	Links related to the STAC item.
assets	Map<String, StacAsset>	Assets available for the STAC item.

Error Handling

Status Code	Error Message	Description
400 Bad Request	Bad Request	Indicates that the request was malformed or missing required parameters.
500 Internal Server Error	Internal Server Error	Indicates a server error occurred while processing the request.