Imago API for Developers

Version: 1.3.1

Create a new imagery

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

POST

/imagery

This will create a new imagery if it does not exist, otherwise it will update an existing imagery.

Request

Body parameters

Required

object[]

Required

List of imageries to create or update.

keysimageryKeysSchema

Required

workspaceNamestring

Name of the workspace containing the imagery. Only optional if updating an existing imagery.

datasetNamestring

Name of the dataset containing the imagery. Only optional if updating an existing imagery.

collectionNamestring

Required

Name of the collection containing the imagery.

imageryTypeNamestring

Required

Name of the imagery type for the imagery.

namestring

Name of imagery. Only optional according to the imagery type's geometry type

startDepthnumber

Start depth of imagery. Only optional according to the imagery type's geometry type.

endDepthnumber

End depth of imagery. Only optional according to the imagery type's geometry type.

xnumber

Longtitude/X coordinate of imagery. Only optional according to the imagery type's geometry type.

ynumber

Latitude/Y coordinate of imagery. Only optional according to the imagery type's geometry type.

znumber

Elevation/Z coordinate of imagery. Only optional according to the imagery type's geometry type.

attributeDefinitionsobject[]

List of attribute definitions to update on the imagery.

namestring

Name of the attribute definition.

attributesobject

Key/value pairs of attributes on the imagery.

featureDefinitionsobject[]

List of feature definitions to update on the imagery

namestring

Name of an existing Feature Definition

featureTypesobject[]

List of feature types linked to the feature definition containing the values to be saved

namestring

Name of an existing Feature Type

imagesobject[]

List of images in the imagery with features, identified by image type

namestring

Name of an Image Type linked to the Imagery Type

featuresobject[]

List of features present in the image

pointsobject[]

A list of points that describe the geometry of the feature on the image

xnumber

The x value for the point as a percentage of the image width, between 0 (left border) and 1 (right border)

ynumber

The y value for the point as a percentage of the image height, between 0 (top border) and 1 (bottom border)

pennumber

Describes the location of this point in relation to the drawing. 0 for the first point, 1 for a middle point, and -1 for the last point.

Example body

[
  {
    "keys": {
      "workspaceName": "Firefly Resource Development",
      "datasetName": "Drilling Chips",
      "collectionName": "RC-01001",
      "imageryTypeName": "Chips",
      "startDepth": 0,
      "endDepth": 10
    },
    "attributeDefinitions": [
      {
        "name": "Core Tray Box Numbers",
        "attributeValues": {
          "StartBox": 1,
          "EndBox": 1
        }
      }
    ],
    "featureDefinitions": [
      {
        "name": "Linearization",
        "featureTypes": [
          {
            "name": "row",
            "images": [
              {
                "name": "Wet Original",
                "features": [
                  {
                    "points": [
                      {
                        "x": 0.007876626215875149,
                        "y": 0.3148634731769562,
                        "pen": 0
                      },
                      {
                        "x": 0.9640294909477234,
                        "y": 0.3148634731769562,
                        "pen": 1
                      },
                      {
                        "x": 0.9640294909477234,
                        "y": 0.7148634731769562,
                        "pen": 1
                      },
                      {
                        "x": 0.00787662621587514,
                        "y": 0.7148634731769562,
                        "pen": -1
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

Responses

200

Successful response.

401

Unauthorized

422

The request could not be completed using the supplied parameters.

500

Internal error occurred during the request.