Activities

Retrieve the definition of an activity.

---

Activities

MX Deposit API

Version: 0.1.0

Returns the definition of an activity.

Servers
https://app.mxdeposit.net

Parameters

Your credentials. Use the API key (legacy), or Bearer followed by a Bentley IMS access token.

Client ID, required only when authenticating with an API key.

API version.

ID of the activity.

ID of the project. Required when the API-Version header is sent.

Returns

200

OK

Identifier, a 24-character hexadecimal string.

Name of the activity.

type"point" | "drilling"

Identifier, a 24-character hexadecimal string.

Name of the table view.

indexinteger

For example intervals.

is_viewboolean

allow_gapsboolean

allow_dupesboolean

allow_overlapsboolean

linked_to_lithologyboolean

read_only_offlineboolean

calculated_columnsobject

calculated_fieldsobject

carryoverobject

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

Data type of the column, for example list or numeric.

text_typestring

lengthinteger

precisioninteger

minnumber

maxnumber

requiredboolean

editableboolean

isvalidboolean

is_calculated_columnboolean

calculationobject

ismxboolean

Header field only. Type of the header, for example drilling.

Header field only. For example holetype.

Header field only. field for a header field.

Header field only.

Header field only.

Header field only.

flashErrorobject

A list of values that a column or header field can take.

Identifier, a 24-character hexadecimal string.

namestring

descriptionstring

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

typestring

editableboolean

requiredboolean

lengthinteger

Identifier, a 24-character hexadecimal string.

The values of the row, keyed by column id.

ranknumber

imagestring | null

colorstring | null

isvalidboolean

ismxboolean

publishedboolean

specialstring

null

used_inobject

Identifier, a 24-character hexadecimal string.

namestring

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

calculated_fieldsobject | null

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

Identifier, a 24-character hexadecimal string.

indexinteger

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

Data type of the column, for example list or numeric.

text_typestring

lengthinteger

precisioninteger

minnumber

maxnumber

requiredboolean

editableboolean

isvalidboolean

is_calculated_columnboolean

calculationobject

ismxboolean

Header field only. Type of the header, for example drilling.

Header field only. For example holetype.

Header field only. field for a header field.

Header field only.

Header field only.

Header field only.

flashErrorobject

A list of values that a column or header field can take.

Identifier, a 24-character hexadecimal string.

namestring

descriptionstring

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

typestring

editableboolean

requiredboolean

lengthinteger

Identifier, a 24-character hexadecimal string.

The values of the row, keyed by column id.

ranknumber

imagestring | null

colorstring | null

isvalidboolean

ismxboolean

publishedboolean

specialstring

null

used_inobject

isvalidboolean

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

Data type of the column, for example list or numeric.

text_typestring

lengthinteger

precisioninteger

minnumber

maxnumber

requiredboolean

editableboolean

isvalidboolean

is_calculated_columnboolean

calculationobject

ismxboolean

Header field only. Type of the header, for example drilling.

Header field only. For example holetype.

Header field only. field for a header field.

Header field only.

Header field only.

Header field only.

flashErrorobject

A list of values that a column or header field can take.

Identifier, a 24-character hexadecimal string.

namestring

descriptionstring

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

Identifier, a 24-character hexadecimal string.

namestring

indexinteger

typestring

editableboolean

requiredboolean

lengthinteger

Identifier, a 24-character hexadecimal string.

The values of the row, keyed by column id.

ranknumber

imagestring | null

colorstring | null

isvalidboolean

ismxboolean

publishedboolean

specialstring

null

used_inobject

rowsobject[]

null

default_valuesobject

coordinates_default_valuesobject

table_default_valuesobject

null

null

null

control_typesarray | null

samples_type_specsobject | null

actual_depth_tablesarray | null

default_target_depthnumber | null

auto_create_row_tablesobject | null

single_row_tablesId[]

groupsobject | null

can_create_newboolean

can_exportboolean

strip_log_configobject

auto_increment_nameboolean

collar_number_as_sample_numberboolean

column_associationsobject

Endpoint

GET

/api/v1/activities/{activity_id}

Request

cURL

​

curl -X GET 'https://app.mxdeposit.net/api/v1/activities/{activity_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "Activity": {
    "table_views": [
      {
        "calculated_columns": {},
        "name": "RC Alteration",
        "interval_type": "intervals",
        "allow_gaps": false,
        "linked_to_lithology": false,
        "allow_dupes": false,
        "read_only_offline": false,
        "_id": "58bd78ebad800944a310dee9",
        "tables": [
          {
            "index": 0,
            "name": "RC Alteration",
            "_id": "58bd78ebad800944a310dee9",
            "columns": [
              {
                "text_type": "single",
                "type": "list",
                "length": 32,
                "required": false,
                "max": 1e+308,
                "list": {
                  "used_in": {
                    "drilling_tables": {
                      "5a7b54a1ad8009223dcee54a": {
                        "5a7b54c4ad8009223dcee54c": true
                      }
                    }
                  },
                  "category": "55a7d30e811a142edd3408c9",
                  "rows": [
                    {
                      "_id": "5993445cad800905fd19b2c8",
                      "values": {
                        "55a7d686811a142edd3408df": true,
                        "55a7d686811a142edd3408e0": "new one"
                      },
                      "rank": 29,
                      "image": null,
                      "color": null
                    }
                  ],
                  "primary_column": "55a7d686811a142edd3408e0",
                  "isvalid": true,
                  "name": "Alteration Type",
                  "_id": "55a7d686811a142edd3408e3",
                  "description": "The major types of alteration.",
                  "columns": [
                    {
                      "name": "In use",
                      "index": 0,
                      "type": "inuse",
                      "_id": "55a7d686811a142edd3408df",
                      "editable": false
                    },
                    {
                      "required": true,
                      "name": "Value",
                      "_id": "55a7d686811a142edd3408e0",
                      "editable": false,
                      "length": 16,
                      "index": 1,
                      "type": "primary"
                    },
                    {
                      "required": false,
                      "name": "Description",
                      "_id": "55a7d686811a142edd3408e1",
                      "editable": false,
                      "length": 255,
                      "index": 2,
                      "type": "text"
                    }
                  ],
                  "inuse_column": "55a7d686811a142edd3408df",
                  "ismx": true,
                  "published": true
                },
                "precision": 0,
                "_id": "55a7e6a2811a142edd34093d",
                "isvalid": true,
                "name": "Type",
                "index": 0,
                "editable": true,
                "min": -1e+308
              }
            ]
          }
        ],
        "is_view": false,
        "index": -1,
        "allow_overlaps": false
      }
    ],
    "groups": null,
    "coordinates_default_values": {},
    "actual_depth_tables": [
      "55a001298283de28fc74059d"
    ],
    "single_row_tables": [],
    "auto_create_row_tables": {},
    "control_types": [
      "5719366b21f98432a83c0276",
      "571935e421f98432a83c0275"
    ],
    "table_default_values": {},
    "can_create_new": true,
    "samples": null,
    "lithology": "55a001298283de28fc74059d",
    "name": "Geotechnical Drilling",
    "type": "drilling",
    "default_values": {},
    "default_target_depth": null,
    "strip_log_config": {},
    "_id": "58a5e42bad800944a3411a72",
    "header": {
      "sections": [
        {
          "name": "__DEFAULT__",
          "_id": "560d832e8283de1328cbe211",
          "fields": [
            {
              "field": {
                "precision": 10,
                "type": "list",
                "ismx": true,
                "header_type": "drilling",
                "length": 32,
                "list": {
                  "used_in": {
                    "point_headers": {
                      "587d20628ff4520477962b5c": {
                        "587d20628ff4520477962b54": true,
                        "55ea54548283de3f546d0e33": true
                      },
                      "587d20b68ff4520477962b65": {
                        "55ea54548283de3f546d0e33": true
                      }
                    }
                  },
                  "inuse_column": "559ff74a8283de224ae31813",
                  "rows": [
                    {
                      "_id": "55a6afd5811a142eddf75284",
                      "values": {
                        "559ff74a8283de224ae3180f": "DD",
                        "559ff74a8283de224ae31813": true,
                        "559ff74a8283de224ae31810": "Diamond Drill",
                        "559ff74a8283de224ae3180e": true
                      },
                      "rank": 0,
                      "image": null,
                      "color": null
                    }
                  ],
                  "primary_column": "559ff74a8283de224ae3180f",
                  "isvalid": true,
                  "name": "Hole Type",
                  "_id": "559ff74a8283de224ae31817",
                  "special": "holetype",
                  "description": "The type of a drill hole",
                  "columns": [
                    {
                      "name": "In use",
                      "_id": "559ff74a8283de224ae3180e",
                      "type": "inuse",
                      "index": 0,
                      "editable": false
                    },
                    {
                      "required": true,
                      "name": "Value",
                      "_id": "559ff74a8283de224ae3180f",
                      "editable": false,
                      "length": 16,
                      "index": 1,
                      "type": "primary"
                    },
                    {
                      "required": false,
                      "name": "Description",
                      "_id": "559ff74a8283de224ae31810",
                      "editable": false,
                      "length": 255,
                      "index": 2,
                      "type": "text"
                    }
                  ],
                  "category": "55a7e983811a142edd340961",
                  "ismx": true,
                  "published": true
                },
                "is_default_drilling": true,
                "required": true,
                "name": "Hole type",
                "_id": "55ea54548283de3f546d0e33",
                "max": 1e+301,
                "special_type": "holetype",
                "min": 0,
                "isvalid": true,
                "columnOrField": "field"
              },
              "_id": "560d832e8283de1328cbe20d",
              "index": 0
            },
            {
              "field": {
                "precision": 3,
                "type": "numeric",
                "length": 32,
                "max": 90,
                "required": false,
                "name": "Dip",
                "_id": "58b97be9ad800944a35ba624",
                "editable": true,
                "ismx": false,
                "min": -90,
                "isvalid": true,
                "columnOrField": "field"
              },
              "_id": "59e50c0aad8009115bc89703",
              "index": 5
            },
            {
              "field": {
                "precision": 0,
                "type": "checkbox",
                "max": 1.7976931348623157e+308,
                "length": 32,
                "is_default_drilling": false,
                "is_default_point": false,
                "flashError": {
                  "0": {},
                  "length": 1
                },
                "required": false,
                "name": "test111",
                "_id": "5acbb4d5ad8009223d52726d",
                "is_default_dispatch": false,
                "editable": true,
                "ismx": false,
                "min": -1.7976931348623157e+308,
                "isvalid": true,
                "columnOrField": "field"
              },
              "_id": "5acbb4d5ad8009223d52726e",
              "index": 6
            }
          ],
          "index": -1
        }
      ],
      "name": "DD Header",
      "_id": "560d832e8283de1328cbe213",
      "target_depth_field": "560d832e8283de1328cbe210",
      "actual_depth_field": "560d832e8283de1328cbe20f",
      "coordinates_table": {
        "isvalid": true,
        "columns": [
          {
            "required": false,
            "name": "Type",
            "_id": "5908c68a16b37a4ed1032d66",
            "isvalid": true,
            "index": 0,
            "list": {
              "category": "55a7fa06811a142edd3409cb",
              "used_in": {
                "point_headers": {
                  "587d20628ff4520477962b5c": {
                    "5908c68a16b37a4ed1032d66": true
                  },
                  "587d20b68ff4520477962b65": {
                    "5908c68a16b37a4ed1032d66": true
                  }
                }
              },
              "inuse_column": "5908c49716b37a4dadc803d6",
              "primary_column": "5908c49716b37a4dadc803d7",
              "isvalid": true,
              "name": "Coordinate Type",
              "_id": "5908c49716b37a4dadc803d5",
              "description": "List of coordinate types",
              "columns": [
                {
                  "name": "In use",
                  "index": 0,
                  "type": "inuse",
                  "_id": "5908c49716b37a4dadc803d6",
                  "editable": false
                }
              ],
              "rows": [
                {
                  "values": {
                    "5908c49716b37a4dadc803d8": "Planned",
                    "5908c49716b37a4dadc803d6": true,
                    "5908c49716b37a4dadc803d7": "Planned"
                  },
                  "rank": 0,
                  "color": null,
                  "image": null,
                  "_id": "5908c49716b37a4dadc803d9"
                }
              ],
              "ismx": true,
              "published": true,
              "parent_list": null
            },
            "type": "list"
          },
          {
            "required": false,
            "precision": 9,
            "_id": "55f19ae08283de4df4d578ac",
            "name": "Easting",
            "isvalid": true,
            "index": 2,
            "type": "numeric"
          }
        ],
        "rows": []
      }
    },
    "survey": "55a7f9b4811a142edd3409cc",
    "samples_type_specs": {
      "ad8f309c31584d08947b9e2c": {
        "child_sample_types": {
          "5d6f891209944bd29353fd48": {
            "child_sample_types": {
              "58e4f0d1ad800944a3c5c883": {
                "name": "Check",
                "_id": "58e4f0d1ad800944a3c5c883"
              },
              "832720db2e35424ab0533f64": {
                "name": "Pulp",
                "_id": "832720db2e35424ab0533f64"
              }
            },
            "name": "FieldDup",
            "_id": "5d6f891209944bd29353fd48"
          }
        },
        "name": "Original",
        "_id": "ad8f309c31584d08947b9e2c"
      }
    }
  }
}