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

DetectConfig

Detects the config for a data import.

POST
/api/v2/data-imports:detect-config

Request Body

application/jsonRequired

datastring

Format: "byte"

typestring

Default: "DATA_TYPE_KEY_UNSPECIFIED"Value in: "DATA_TYPE_KEY_UNSPECIFIED" | "DATA_TYPE_KEY_CSV" | "DATA_TYPE_KEY_TDMS" | "DATA_TYPE_KEY_CH10" | "DATA_TYPE_KEY_PARQUET_FLATDATASET"
curl -X POST "<API_URL>/api/v2/data-imports:detect-config" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "data": "string",
    "type": "DATA_TYPE_KEY_UNSPECIFIED"
  }'

A successful response.

{
  "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"
  },
  "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"
  }
}