Create Sync Data Request

POST 
/api/v1/historical-data/sync

This endpoint creates a data request and waits for the data to be processed before responding. The response will contain a status, indicating if the request succeeded or if it failed, and a outputFile or error field indicating the URL of the output file or the error message, respectively.

Request

application/json

Body

Body

signals

object

required

oneOf

MOD1

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

]

MOD2

ID of the Signal

Array [

integer

Possible values: > 0

]

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

Responses

200

Success

application/json

Schema

Schema

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)

{
  "requestId": 1000,
  "status": "Finished",
  "outputFile": "https://nortech-api-query-euc1.s3.eu-central-1.amazonaws.com/User-10-1713999600/000.parquet"
}

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

404

application/json

Schema

Schema

oneOf

MOD1

Signals not found

status stringrequired

Possible values: [Signals not found]

signals

object

required

oneOf

MOD1

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

]

MOD2

ID of the Signal

Array [

integer

Possible values: > 0

]

MOD2

Signal Data not found

status stringrequired

Possible values: [Signal Data not found]

Example (from schema)

{}

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...