API DocsRESTExport service

ExportData

Export data.

POST
/api/v1/export

Request Body

application/jsonRequired

timeRangeobject

runsAndTimeRangeobject

assetsAndTimeRangeobject

channelIdsarray<string>

calculatedChannelConfigsarray<object>

outputFormat
Required
string

Default: "EXPORT_OUTPUT_FORMAT_UNSPECIFIED"Value in: "EXPORT_OUTPUT_FORMAT_UNSPECIFIED" | "EXPORT_OUTPUT_FORMAT_CSV" | "EXPORT_OUTPUT_FORMAT_SUN"

exportOptions
Required
object

curl -X POST "<API_URL>/api/v1/export" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "timeRange": {
      "startTime": "2019-08-24T14:15:22Z",
      "stopTime": "2019-08-24T14:15:22Z"
    },
    "runsAndTimeRange": {
      "runIds": [
        "string"
      ],
      "startTime": "2019-08-24T14:15:22Z",
      "stopTime": "2019-08-24T14:15:22Z"
    },
    "assetsAndTimeRange": {
      "assetIds": [
        "string"
      ],
      "startTime": "2019-08-24T14:15:22Z",
      "stopTime": "2019-08-24T14:15:22Z"
    },
    "channelIds": [
      "string"
    ],
    "calculatedChannelConfigs": [
      {
        "name": "string",
        "expression": "string",
        "channelReferences": [
          {
            "channelReference": "string",
            "channelIdentifier": "string"
          }
        ],
        "units": "string"
      }
    ],
    "outputFormat": "EXPORT_OUTPUT_FORMAT_UNSPECIFIED",
    "exportOptions": {
      "useLegacyFormat": true,
      "simplifyChannelNames": true,
      "combineRuns": true,
      "splitExportByAsset": true,
      "splitExportByRun": true
    }
  }'

A successful response.

{
  "presignedUrl": "string"
}