Imago API for Developers

Version: 1.3.1

Create a new collection

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

POST

/collection

Adds a new collection to a dataset. If the new collection already exists in the dataset then no action is taken.

Request

Body parameters

Required

workspaceNamestring

Required

Name of workspace for the new collection.

datasetNamestring

Required

Name of dataset for the new collection.

namestring

Required

Name of new collection.

Example body

{
  "workspaceName": "Firefly Resource Development",
  "datasetName": "Drilling Chips",
  "name": "RC-01001"
}

Responses

200

Successful response.

Response schema

idstring

New collection identifier.

namestring

Name of new collection.

datasetIdstring

Identifier of dataset that the collection belongs to.

createdOnstring

Date/time when the collection was created.

Example response

{
  "id": "054bf4c2-84cc-4d30-b4dc-cc81c77b7f25",
  "name": "RC-01001",
  "datasetId": "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.