DataFlex / Cognite API v1 / Retrieve data points
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "items": [
// {
// "externalId": "ut culpa Excepteur",
// "start": 0,
// "end": -12222847,
// "limit": 43358925,
// "aggregates": [
// "interpolation",
// "max"
// ],
// "granularity": "a",
// "includeOutsidePoints": false
// },
// {
// "externalId": "aliquip",
// "start": 0,
// "end": -6309638,
// "limit": 57543521,
// "aggregates": [
// "max",
// "min"
// ],
// "granularity": "",
// "includeOutsidePoints": false
// }
// ],
// "start": "velit",
// "end": 50328109,
// "limit": 100,
// "aggregates": [
// "count",
// "max"
// ],
// "granularity": "mollit dolore",
// "includeOutsidePoints": false,
// "ignoreUnknownIds": false
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "items[0].externalId" "ut culpa Excepteur" To iSuccess
Get ComUpdateInt Of hoJson "items[0].start" 0 To iSuccess
Get ComUpdateInt Of hoJson "items[0].end" -12222847 To iSuccess
Get ComUpdateInt Of hoJson "items[0].limit" 43358925 To iSuccess
Get ComUpdateString Of hoJson "items[0].aggregates[0]" "interpolation" To iSuccess
Get ComUpdateString Of hoJson "items[0].aggregates[1]" "max" To iSuccess
Get ComUpdateString Of hoJson "items[0].granularity" "a" To iSuccess
Get ComUpdateBool Of hoJson "items[0].includeOutsidePoints" False To iSuccess
Get ComUpdateString Of hoJson "items[1].externalId" "aliquip" To iSuccess
Get ComUpdateInt Of hoJson "items[1].start" 0 To iSuccess
Get ComUpdateInt Of hoJson "items[1].end" -6309638 To iSuccess
Get ComUpdateInt Of hoJson "items[1].limit" 57543521 To iSuccess
Get ComUpdateString Of hoJson "items[1].aggregates[0]" "max" To iSuccess
Get ComUpdateString Of hoJson "items[1].aggregates[1]" "min" To iSuccess
Get ComUpdateString Of hoJson "items[1].granularity" "" To iSuccess
Get ComUpdateBool Of hoJson "items[1].includeOutsidePoints" False To iSuccess
Get ComUpdateString Of hoJson "start" "velit" To iSuccess
Get ComUpdateInt Of hoJson "end" 50328109 To iSuccess
Get ComUpdateInt Of hoJson "limit" 100 To iSuccess
Get ComUpdateString Of hoJson "aggregates[0]" "count" To iSuccess
Get ComUpdateString Of hoJson "aggregates[1]" "max" To iSuccess
Get ComUpdateString Of hoJson "granularity" "mollit dolore" To iSuccess
Get ComUpdateBool Of hoJson "includeOutsidePoints" False To iSuccess
Get ComUpdateBool Of hoJson "ignoreUnknownIds" False To iSuccess
Send ComSetRequestHeader To hoHttp "content-type" "application/json"
Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/api/v1/projects/{{project}}/timeseries/data/list" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"items": [
{
"externalId": "ut culpa Excepteur",
"start": 0,
"end": -12222847,
"limit": 43358925,
"aggregates": [
"interpolation",
"max"
],
"granularity": "a",
"includeOutsidePoints": false
},
{
"externalId": "aliquip",
"start": 0,
"end": -6309638,
"limit": 57543521,
"aggregates": [
"max",
"min"
],
"granularity": "",
"includeOutsidePoints": false
}
],
"start": "velit",
"end": 50328109,
"limit": 100,
"aggregates": [
"count",
"max"
],
"granularity": "mollit dolore",
"includeOutsidePoints": false,
"ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/data/list
Postman Collection Item JSON
{
"id": "getMultiTimeSeriesDatapoints",
"name": "Retrieve data points",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"timeseries",
"data",
"list"
],
"query": [
],
"variable": [
]
},
"method": "POST",
"header": [
{
"key": "api-key",
"value": "{{api-key}}",
"description": "An admin can create API keys in the Cognite console."
},
{
"key": "content-type",
"value": "application/json"
}
],
"description": "Retrieves a list of data points from multiple time series in a project. This operation supports aggregation, but not pagination. A detailed description of how aggregates work can be found at [our concept guide for aggregation](<https://docs.cognite.com/dev/concepts/aggregation/>).",
"body": {
"mode": "raw",
"raw": "{\n \"items\": [\n {\n \"externalId\": \"ut culpa Excepteur\",\n \"start\": 0,\n \"end\": -12222847,\n \"limit\": 43358925,\n \"aggregates\": [\n \"interpolation\",\n \"max\"\n ],\n \"granularity\": \"a\",\n \"includeOutsidePoints\": false\n },\n {\n \"externalId\": \"aliquip\",\n \"start\": 0,\n \"end\": -6309638,\n \"limit\": 57543521,\n \"aggregates\": [\n \"max\",\n \"min\"\n ],\n \"granularity\": \"\",\n \"includeOutsidePoints\": false\n }\n ],\n \"start\": \"velit\",\n \"end\": 50328109,\n \"limit\": 100,\n \"aggregates\": [\n \"count\",\n \"max\"\n ],\n \"granularity\": \"mollit dolore\",\n \"includeOutsidePoints\": false,\n \"ignoreUnknownIds\": false\n}"
}
}
}
