Imago API release notes

Changes

1.4.0

• Added a new endpoint GET image-metadata
  • This endpoint returns a list of image metadata, similar to the embedded images in the GET imagery endpoint.
  • It supports filtering by:
    • parent entities name or ID (workspaceId, imageTypeName etc),
    • images uploaded in the past specified number of days (uploadedSince),
    • images updated in the past specified number of days (updatedSince),
    • whether image is deleted (deleted).
  • This endpoint has been created to better serve image based queries that are currently able to be performed via the GET imagery endpoint such as finding recently uploaded or updated images
• Added a new /dataset/:datasetId endpoint to retrieve a dataset by ID
• Added workspaceId parameter to the GET collection endpoint
• Added the ability to query the GET imagery endpoint by deleted status
• Added the ability to query the GET imagery endpoint by imageryID directly.

1.3.6

• Unique constraint on collection names now enforced case-insensitively for consistency

1.3.5

• Ensured consistency with camelCasing API query parameters across all endpoints.
• Added missing request body schema for Create Dataset endpoint.

1.3.4

• Moved Imago API documentation landing page from /imago-api-for-developers to /imago-api
• Documented parameter imageryId in GET image

1.3.3

• Added 'workspaceFolder' to the workspace output in GET user context
  • This is the immediate parent folder of the workspace, and is only present if folders are in use.

1.3.2

• Reworked the overall structure of the Imago API Docs
  • Rewrote front page to better aid users in understanding the Imago API
  • Rearranged sidebar navigation hierarchy to better reflect the API structure
  • Moved information on how to use the Deep Linking API to the guides section

1.3.1

• Fix errors in the OpenAPI YAML

1.3.0

• The x/y/z search parameters have been removed from GET image as they do not provide the required level of unique targeting for this endpoint.
• Bug fixed around uploading multiple point type images with the same x/y/z attributes.

1.2.0

• Image URLs returned from GET imagery have been changed to Imago URLs rather than direct Azure URLs.
• GET Image endpoint has been updated to return a 302 redirect to download the image directly from the underlying storage where possible.
  • Previously, images were downloaded to the Imago Server to be returned as a 200 response containing the image data. This still occurs if you request to resize the image using the height and/or width parameters.
  • The Content-Type header from the underlying storage contains 'application/octet-stream' instead of the mime type of the image, e.g. 'image/jpeg' or 'image/png'.

1.1.0

• Updated the GET imagery and GET collection endpoints to include pagination information in the response.
  • The response now includes a meta object with limit and offset fields.
  • The limit field specifies the maximum number of items to return. This field is optional and will not be returned if set to 0 or not provided. If a default limit is applied, the value will be returned in this field.
  • The offset field specifies the number of items to skip before starting to collect the result set.

1.0.2

• Added new optional boolean query parameter includeFeatures to GET imagery.
  • Defaults to true if not provided to maintain existing functionality.
  • If set to false, data about features linked to the imageries is not included in the returned payload.
  • Setting this to false is recommended if feature data is not required.

1.0.1

• Added additional field id to the image objects in GET imagery