API DocsRESTData import service

ListDataImports

Lists all data imports.

GET
/api/v2/data-imports

Query Parameters

pageSizeinteger

The maximum number of data imports to return. The service may return fewer than this value. If unspecified, at most 50 data imports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

Format: "int64"

pageTokenstring

A page token, received from a previous ListDataImports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataImports must match the call that provided the page token. Optional.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are data_import_id, source_url, status. For further information about how to use CELs, please refer to this guide.

orderBystring

How to order the retrieved data imports. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and modified_date. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

curl -X GET "<API_URL>/api/v2/data-imports?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "dataImports": [
    {
      "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
              }
            ],
            "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"
      }
    }
  ],
  "nextPageToken": "string"
}

Previous

GetDataImport GET

Next

RetryDataImport POST