Export

Export collar data and lab certificate result information, and check the status of the export.

---

Export

MX Deposit API

Version: 0.1.0

Starts an export of collar data and returns the export job. Use the operation_uid of the job to check the status of the export and to download the zip file that contains the exported data files.

Servers
https://app.mxdeposit.net

Parameters

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

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

ID of the project.

ID of the activity.

IDs of the activities.

IDs of the collars to export.

Code of the export template.

Identifier, a 24-character hexadecimal string.

The file types to export. Defaults to csv.

Unique id of the export. Generated when it is not sent.

Used in the name of the job. Defaults to export.

include_validation_errorsboolean

{
  "project": "string",
  "activity": "string",
  "activities": [
    "string"
  ],
  "collarIds": [
    "string"
  ],
  "template_code": "string",
  "template_id": "string",
  "destination": [
    "csv"
  ],
  "export_uid": "string",
  "filename": "string",
  "include_validation_errors": true
}

Returns

200

OK

Identifier, a 24-character hexadecimal string.

Name of the job.

Type of the job, Export for an export.

privacy"Private"

Where the job runs.

The request that the job runs.

methodstring

urlstring

The export request, with the fields that identify the job.

is_jobboolean

operation_uidstring

destinationstring[]

Status of the job when it is created.

progress_percentageinteger

errorstring

logstring[]

subscribersarray

Identifier, a 24-character hexadecimal string.

Only for jobs that run in batch.

Creation time, as an object holding the number of milliseconds since the Unix epoch.

$dateint64

Last update time, as an object holding the number of milliseconds since the Unix epoch.

$dateint64

Endpoint

POST

/api/v3/collars/export/

Request

cURL

​

curl -X POST 'https://app.mxdeposit.net/api/v3/collars/export/' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "jobs": [
    {
      "_id": "string",
      "name": "string",
      "type": "string",
      "privacy": "Private",
      "destination": "batch",
      "parameters": {
        "method": "string",
        "url": "string",
        "body": {
          "is_job": true,
          "operation_uid": "string",
          "destination": [
            "string"
          ],
          "additionalProp1": "string",
          "additionalProp2": "number",
          "additionalProp3": "boolean"
        }
      },
      "status": "Submitted",
      "progress_percentage": 0,
      "error": "string",
      "log": [
        "string"
      ],
      "subscribers": [
        null
      ],
      "owner": "string",
      "batch_info": {
        "additionalProp1": "string",
        "additionalProp2": "number",
        "additionalProp3": "boolean"
      },
      "_created_at": {
        "$date": 0
      },
      "_updated_at": {
        "$date": 0
      }
    }
  ]
}

---

Check the status and download the exported file

MX Deposit API

Version: 0.1.0

Returns the status of an export. Once the export is done, the response contains the URL to download the exported file. Use the operation_uid returned by the collar export endpoint, or the export_uid that was sent as part of the body of the lab certificate result export endpoint. The _id of the export is also accepted.

Servers
https://app.mxdeposit.net

Parameters

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

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

Operation uid of the job (or the export_uid of the lab certificate result export).

Returns

200

Contains the status of the export. state can be started, Exporting, or done. Contains an error instead when the uid is not valid.

Identifier, a 24-character hexadecimal string.

The operation_uid of the export.

Returned instead of the status when the uid is not valid.

State of the job. started, Exporting followed by the progress, or done.

Time of the last state change, formatted as MM/DD/YYYY, HH:MM:SS.

URL to download the exported file. Only present when the state is done.

Endpoint

GET

/export-status/{operation_uid}

Request

cURL

​

curl -X GET 'https://app.mxdeposit.net/export-status/{operation_uid}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "_id": "string",
  "error": "string",
  "state": "string",
  "time": "string",
  "url": "string"
}

---

Export Lab Certificate Result Information

MX Deposit API

Version: 0.1.0

Exports Lab Certificate Result Information data to a CSV file in a zip file. The request returns when the export is complete, with the URL to download the file. While it runs, its status can be checked with the export status endpoint, using the export_uid.

Servers
https://app.mxdeposit.net

Parameters

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

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

ID of the project.

ID of the activity.

Optional. Only the results where is_last has this value are exported.

Optional. Unique id of the export, used to check its status.

Optional, inclusive. Formatted as MM/DD/YYYY or MM/DD/YYYY HH:MM:SS. A value in another format is ignored.

Optional, exclusive. Formatted as MM/DD/YYYY or MM/DD/YYYY HH:MM:SS. A value in another format is ignored.

Optional. Encoding of the CSV file. Defaults to utf-8.

{
  "project": "595e867b0dad246f56d9aa76",
  "activity": "595e851c6f23596e75685387",
  "is_last": true,
  "export_uid": "65bab6f010adf2beaacbfe76",
  "imported_date_time_from": "01/11/2018 18:13:44",
  "imported_date_time_to": "02/16/2023 12:00:00"
}

Returns

200

OK

URL to download the exported file.

Endpoint

POST

/api/v1/LabCertResultsView/export

Request

cURL

​

curl -X POST 'https://app.mxdeposit.net/api/v1/LabCertResultsView/export' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "project": "595e867b0dad246f56d9aa76",
  "activity": "595e851c6f23596e75685387",
  "is_last": true,
  "export_uid": "65bab6f010adf2beaacbfe76",
  "imported_date_time_from": "01/11/2018 18:13:44",
  "imported_date_time_to": "02/16/2023 12:00:00"
}'

Response

{
  "url": "https://mxdeposit-export.amazonaws.com/3dc33bc4-8469-45e4-a2"
}