DataFlex / Cognite API v1 / Filter time series
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.
// {
// "filter": {
// "name": "consectetur reprehenderit",
// "unit": "voluptate occaecat ut dolor ",
// "isString": true,
// "isStep": false,
// "metadata": {},
// "assetIds": [
// 2509118978120224,
// 7226404981552392
// ],
// "assetExternalIds": [
// "est laborum",
// "in in et aliquip"
// ],
// "rootAssetIds": [
// 6708483845679534,
// 3834273847268414
// ],
// "assetSubtreeIds": [
// {
// "id": 4838322974326730
// },
// {
// "externalId": "nisi Excepteur exercitation nulla reprehenderit"
// }
// ],
// "dataSetIds": [
// {
// "externalId": "Ut ex consectetur"
// },
// {
// "id": 8956424920459844
// }
// ],
// "externalIdPrefix": "reprehenderit fugiat pariatur id culpa",
// "createdTime": {
// "max": 82460819,
// "min": 76400255
// },
// "lastUpdatedTime": {
// "max": 24839160,
// "min": 94565958
// }
// },
// "limit": 100,
// "cursor": "pariatur quis eu anim",
// "partition": "do amet consectetur ad f"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "filter.name" "consectetur reprehenderit" To iSuccess
Get ComUpdateString Of hoJson "filter.unit" "voluptate occaecat ut dolor " To iSuccess
Get ComUpdateBool Of hoJson "filter.isString" True To iSuccess
Get ComUpdateBool Of hoJson "filter.isStep" False To iSuccess
Get ComUpdateNewObject Of hoJson "filter.metadata" To iSuccess
Get ComUpdateInt Of hoJson "filter.assetIds[0]" 2509118978120224 To iSuccess
Get ComUpdateInt Of hoJson "filter.assetIds[1]" 7226404981552392 To iSuccess
Get ComUpdateString Of hoJson "filter.assetExternalIds[0]" "est laborum" To iSuccess
Get ComUpdateString Of hoJson "filter.assetExternalIds[1]" "in in et aliquip" To iSuccess
Get ComUpdateInt Of hoJson "filter.rootAssetIds[0]" 6708483845679534 To iSuccess
Get ComUpdateInt Of hoJson "filter.rootAssetIds[1]" 3834273847268414 To iSuccess
Get ComUpdateInt Of hoJson "filter.assetSubtreeIds[0].id" 123 To iSuccess
Get ComUpdateString Of hoJson "filter.assetSubtreeIds[1].externalId" "nisi Excepteur exercitation nulla reprehenderit" To iSuccess
Get ComUpdateString Of hoJson "filter.dataSetIds[0].externalId" "Ut ex consectetur" To iSuccess
Get ComUpdateInt Of hoJson "filter.dataSetIds[1].id" 123 To iSuccess
Get ComUpdateString Of hoJson "filter.externalIdPrefix" "reprehenderit fugiat pariatur id culpa" To iSuccess
Get ComUpdateInt Of hoJson "filter.createdTime.max" 82460819 To iSuccess
Get ComUpdateInt Of hoJson "filter.createdTime.min" 76400255 To iSuccess
Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.max" 24839160 To iSuccess
Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.min" 94565958 To iSuccess
Get ComUpdateInt Of hoJson "limit" 100 To iSuccess
Get ComUpdateString Of hoJson "cursor" "pariatur quis eu anim" To iSuccess
Get ComUpdateString Of hoJson "partition" "do amet consectetur ad f" 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/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 '{
"filter": {
"name": "consectetur reprehenderit",
"unit": "voluptate occaecat ut dolor ",
"isString": true,
"isStep": false,
"metadata": {},
"assetIds": [
2509118978120224,
7226404981552392
],
"assetExternalIds": [
"est laborum",
"in in et aliquip"
],
"rootAssetIds": [
6708483845679534,
3834273847268414
],
"assetSubtreeIds": [
{
"id": 4838322974326730
},
{
"externalId": "nisi Excepteur exercitation nulla reprehenderit"
}
],
"dataSetIds": [
{
"externalId": "Ut ex consectetur"
},
{
"id": 8956424920459844
}
],
"externalIdPrefix": "reprehenderit fugiat pariatur id culpa",
"createdTime": {
"max": 82460819,
"min": 76400255
},
"lastUpdatedTime": {
"max": 24839160,
"min": 94565958
}
},
"limit": 100,
"cursor": "pariatur quis eu anim",
"partition": "do amet consectetur ad f"
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/list
Postman Collection Item JSON
{
"id": "listTimeSeries",
"name": "Filter time series",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"timeseries",
"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 time series matching the specified criteria. This operation supports pagination by cursor. Criteria can be applied to select a subset of time series.",
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"name\": \"consectetur reprehenderit\",\n \"unit\": \"voluptate occaecat ut dolor \",\n \"isString\": true,\n \"isStep\": false,\n \"metadata\": {},\n \"assetIds\": [\n 2509118978120224,\n 7226404981552392\n ],\n \"assetExternalIds\": [\n \"est laborum\",\n \"in in et aliquip\"\n ],\n \"rootAssetIds\": [\n 6708483845679534,\n 3834273847268414\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 4838322974326730\n },\n {\n \"externalId\": \"nisi Excepteur exercitation nulla reprehenderit\"\n }\n ],\n \"dataSetIds\": [\n {\n \"externalId\": \"Ut ex consectetur\"\n },\n {\n \"id\": 8956424920459844\n }\n ],\n \"externalIdPrefix\": \"reprehenderit fugiat pariatur id culpa\",\n \"createdTime\": {\n \"max\": 82460819,\n \"min\": 76400255\n },\n \"lastUpdatedTime\": {\n \"max\": 24839160,\n \"min\": 94565958\n }\n },\n \"limit\": 100,\n \"cursor\": \"pariatur quis eu anim\",\n \"partition\": \"do amet consectetur ad f\"\n}"
}
}
}
