Create Async Data Request

POST 
/api/v1/historical-data/async

This endpoint creates a data request and responds immediately while the data is being processed in the background. The response will contain a status, indicating if the request is running or if it failed, and a requestId field that can be used to check the status of the request using the Get Data Request. The field outputFile indicates the URL to download the output file, when ready.

Request

application/json

Body

Body

signals

object

required

Array of Signal ID's or Search JSON's

oneOf

MOD1

Array of signal ID's

Array [

integer

Possible values: > 0

]

MOD2

Signal search JSON

Array [

workspace stringrequired

Name of the Workspace

Example: Workspace 1

asset stringrequired

Name of the Asset

Example: Asset 1

division stringrequired

Name of the Division

Example: Division 1

unit stringrequired

Name of the Unit

Example: Unit 1

signal stringrequired

Name of the Signal

Example: Signal 1

rename string

Name to give the returned signal. Defaults to the signal ID.

Possible values: <= 127 characters

]

timeWindow

object

required

start stringrequired

Date in ISO format

Example: 2021-09-01T00:00:00.000Z

end string

Date in ISO format

Example: 2021-09-01T00:00:00.000Z
format string
Output file format
Possible values: [parquet, json, csv]
Default value: parquet
notificationUrl uri

URL to notify when the output file is ready, see Async historical data request notification for more info

Responses

200

Success

application/json

Schema

Schema

oneOf

MOD1

Data request is still running

requestId integerrequired

ID of the Request

Possible values: > 0

Example: 1000

status stringrequired

Possible values: [Running]

outputFile urirequired

URL to download the data output file

Example: https://nortech-api-query-euc1.s3.eu-central-1.amazonaws.com/User-10-1713999600/000.parquet

MOD2

Data request is finished

requestId integerrequired

ID of the Request

Possible values: > 0

Example: 1000

status stringrequired

Possible values: [Finished]

outputFile urirequired

URL to download the data output file

Example: https://nortech-api-query-euc1.s3.eu-central-1.amazonaws.com/User-10-1713999600/000.parquet

Example (from schema)

{}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

404

Signals not found

application/json

Schema

Schema

status stringrequired

Possible values: [Signals not found]

signals

object

required

Array of Signal ID's or Search JSON's

oneOf

MOD1

Array of signal ID's

Array [

integer

Possible values: > 0

]

MOD2

Signal search JSON

Array [

workspace stringrequired

Name of the Workspace

Example: Workspace 1

asset stringrequired

Name of the Asset

Example: Asset 1

division stringrequired

Name of the Division

Example: Division 1

unit stringrequired

Name of the Unit

Example: Unit 1

signal stringrequired

Name of the Signal

Example: Signal 1

rename string

Name to give the returned signal. Defaults to the signal ID.

Possible values: <= 127 characters

]

Example (from schema)

{
  "status": "Signals not found",
  "signals": [
    10000,
    10001,
    10002
  ]
}

500

Data Request failed

application/json

Schema

Schema

requestId integerrequired
ID of the Request
Possible values: > 0
Example: 1000
status stringrequired

Possible values: [Failed]

error stringrequired

Possible values: [Data request failed, Request timed out]

Example (from schema)

{
  "requestId": 1000,
  "status": "Failed",
  "error": "Data request failed"
}

Loading...