Imago API

List datasets

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

GET

/dataset

Searches for a list of matching datasets. Each dataset is described by its name and id.

Request

Query parameters

namestring

Search pattern to match dataset names

matchstring

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

Default value: 'equals'.

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

workspaceidstring

Only search within this workspace.

workspacenamestring

Only search within this workspace.

offsetnumber

Return datasets starting at this offset.

limitnumber

Limit how many datasets are returned.

Responses

200

Successful response.

Response schema

idstring

Dataset identifier.

namestring

Name of the dataset.

workspaceIdstring

Identifier of the workspace that the dataset belongs to.

createdOnstring

Date/time when the dataset was created.

Example response

[
  {
    "id": "054bf4c2-84cc-4d30-b4dc-cc81c77b7f25",
    "name": "Dataset-001",
    "workspaceId": "71b93d30-8e5f-4b07-9f08-8e6bf5a72a50",
    "createdOn": "2022-05-02T01:14:34.366Z"
  }
]

401

Unauthorized

422

The request could not be completed using the supplied parameters.

500

Internal error occurred during the request.