API DocsRESTData import service

CreateDataImportFromUrl

Creates a data import from a url.

POST
/api/v2/data-imports:url

Request Body

application/jsonRequired

url
Required
string

The url to import. HTTP and S3 urls are supported. If you need to import non-public S3 objects, please contact Sift to set that up.

csvConfigobject

ch10Configobject

tdmsConfigobject

curl -X POST "<API_URL>/api/v2/data-imports:url" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "string",
    "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
            }
          ],
          "bitFieldElements": [
            {
              "name": "string",
              "index": 0,
              "bitCount": 0
            }
          ]
        },
        "property2": {
          "name": "string",
          "units": "string",
          "description": "string",
          "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
          "enumTypes": [
            {
              "name": "string",
              "key": 0
            }
          ],
          "bitFieldElements": [
            {
              "name": "string",
              "index": 0,
              "bitCount": 0
            }
          ]
        }
      }
    },
    "ch10Config": {
      "assetName": "string",
      "runName": "string",
      "scaleValues": true
    },
    "tdmsConfig": {
      "assetName": "string",
      "runName": "string",
      "startTimeOverride": "2019-08-24T14:15:22Z",
      "fileSize": "string"
    }
  }'

A successful response.

{
  "dataImportId": "string"
}

Previous

CreateDataImportFromUpload POST

Next

DetectConfig POST