Imago API

Version: 1.3.5

List collections

Servers
https://imago.api.seequent.com/integrate/2

GET

/collection

Searches for a list of matching collections. Each collection is described by its name and dataset id. Either use the datasetName and workspaceName params to filter by dataset/workspace name, or use datasetId to search in a specific dataset.

Request

Query parameters

namestring

Search pattern to match collection names. If no search pattern is supplied then all collections are returned for the dataset.

datasetIdstring

Only returns collections within this dataset.

matchstring

Determines how the search pattern matches the collection name. Wildcards '*' can be used with the 'like' match.

Default value: 'equals'.

Allowed values: 'equals', 'startswith', 'endswith', 'includes', 'like'.

datasetNamestring

Search pattern to match dataset name. Only collections within matching dataset names are returned.

workspaceNamestring

Search pattern to match workspace name. Only collections within matching workspace names are returned.

offsetnumber

Return collections starting at this offset.

limitnumber

Limit how many collections are returned.

Responses

200

Successful response.

Response schema

collectionsobject[]

List of matching collections

idstring

Collection identifier

namestring

Name of collection

datasetIdstring

Identifier of dataset that the collection belongs to

createdOnstring

Date/time when the collection was created.

metapaginationMetaSchema

limitinteger

The maximum number of items to return. Optional.

offsetinteger

The number of items to skip before starting to collect the result set.

Example response

{
  "collections": [
    {
      "id": "054bf4c2-84cc-4d30-b4dc-cc81c77b7f25",
      "name": "RC-01001",
      "datasetId": "71b93d30-8e5f-4b07-9f08-8e6bf5a72a50",
      "createdOn": "2022-05-02T01:14:34.366Z"
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0
  }
}

401

Unauthorized

422

The request could not be completed using the supplied parameters.

500

Internal error occurred during the request.