Sift | Docs
APIReferenceREST (HTTP/JSON)Data import service

GetDataImport

Gets a data import.

GET
/api/v2/data-imports/{dataImportId}

Path Parameters

dataImportId
Required
string

curl -X GET "<API_URL>/api/v2/data-imports/string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "dataImport": {
    "dataImportId": "string",
    "sourceUrl": "string",
    "status": "DATA_IMPORT_STATUS_UNSPECIFIED",
    "errorMessage": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "csvConfig": {
      "assetName": "string",
      "runName": "string",
      "runId": "string",
      "firstDataRow": 0,
      "timeColumn": {
        "columnNumber": 0,
        "format": "TIME_FORMAT_UNSPECIFIED",
        "relativeStartTime": "2019-08-24T14:15:22Z"
      },
      "dataColumns": {
        "property1": {
          "name": "string",
          "units": "string",
          "description": "string",
          "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
          "enumTypes": [
            {
              "name": "string",
              "key": 0,
              "isSigned": true
            }
          ],
          "bitFieldElements": [
            {
              "name": "string",
              "index": 0,
              "bitCount": 0
            }
          ],
          "metadata": [
            {
              "key": {
                "name": "string",
                "type": "METADATA_KEY_TYPE_UNSPECIFIED",
                "archivedDate": "2019-08-24T14:15:22Z"
              },
              "stringValue": "string",
              "numberValue": 0.1,
              "booleanValue": true,
              "archivedDate": "2019-08-24T14:15:22Z"
            }
          ]
        },
        "property2": {
          "name": "string",
          "units": "string",
          "description": "string",
          "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
          "enumTypes": [
            {
              "name": "string",
              "key": 0,
              "isSigned": true
            }
          ],
          "bitFieldElements": [
            {
              "name": "string",
              "index": 0,
              "bitCount": 0
            }
          ],
          "metadata": [
            {
              "key": {
                "name": "string",
                "type": "METADATA_KEY_TYPE_UNSPECIFIED",
                "archivedDate": "2019-08-24T14:15:22Z"
              },
              "stringValue": "string",
              "numberValue": 0.1,
              "booleanValue": true,
              "archivedDate": "2019-08-24T14:15:22Z"
            }
          ]
        }
      },
      "numRows": "string"
    },
    "ch10Config": {
      "assetName": "string",
      "runName": "string",
      "scaleValues": true
    },
    "tdmsConfig": {
      "assetName": "string",
      "runName": "string",
      "startTimeOverride": "2019-08-24T14:15:22Z",
      "fileSize": "string"
    },
    "parquetConfig": {
      "assetName": "string",
      "runName": "string",
      "runId": "string",
      "flatDataset": {
        "timeColumn": {
          "path": "string",
          "format": "TIME_FORMAT_UNSPECIFIED",
          "relativeStartTime": "2019-08-24T14:15:22Z"
        },
        "dataColumns": [
          {
            "path": "string",
            "channelConfig": {
              "name": "string",
              "units": "string",
              "description": "string",
              "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
              "enumTypes": [
                {
                  "name": "string",
                  "key": 0,
                  "isSigned": true
                }
              ],
              "bitFieldElements": [
                {
                  "name": "string",
                  "index": 0,
                  "bitCount": 0
                }
              ],
              "metadata": [
                {
                  "key": {
                    "name": "string",
                    "type": "METADATA_KEY_TYPE_UNSPECIFIED",
                    "archivedDate": "2019-08-24T14:15:22Z"
                  },
                  "stringValue": "string",
                  "numberValue": 0.1,
                  "booleanValue": true,
                  "archivedDate": "2019-08-24T14:15:22Z"
                }
              ]
            }
          }
        ]
      },
      "footerOffset": "string",
      "footerLength": 0,
      "complexTypesImportMode": "PARQUET_COMPLEX_TYPES_IMPORT_MODE_UNSPECIFIED"
    },
    "runId": "string",
    "reportId": "string",
    "assetId": "string",
    "dataStartTime": "2019-08-24T14:15:22Z",
    "dataStopTime": "2019-08-24T14:15:22Z"
  }
}