Chilkat Online Tools

DataFlex / Cognite API v1 / Aggregate time series

Back to Collection Items

Use ChilkatAx-9.5.0-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": "et exercitation s",
    //     "unit": "pariatur esse qui",
    //     "isString": true,
    //     "isStep": false,
    //     "metadata": {},
    //     "assetIds": [
    //       2274246036570026,
    //       8922483798410046
    //     ],
    //     "assetExternalIds": [
    //       "proident Ut consequat in",
    //       "elit incididunt aliqua"
    //     ],
    //     "rootAssetIds": [
    //       7714215516056826,
    //       4275780546438472
    //     ],
    //     "assetSubtreeIds": [
    //       {
    //         "id": 7555548287718054
    //       },
    //       {
    //         "externalId": "re"
    //       }
    //     ],
    //     "dataSetIds": [
    //       {
    //         "id": 5946532482497628
    //       },
    //       {
    //         "externalId": "exercitation nisi elit"
    //       }
    //     ],
    //     "externalIdPrefix": "aute Ut nostrud commodo in",
    //     "createdTime": {
    //       "max": 16041500,
    //       "min": 71538919
    //     },
    //     "lastUpdatedTime": {
    //       "max": 2438620,
    //       "min": 18087967
    //     }
    //   }
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "filter.name" "et exercitation s" To iSuccess
    Get ComUpdateString Of hoJson "filter.unit" "pariatur esse qui" 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]" 2274246036570026 To iSuccess
    Get ComUpdateInt Of hoJson "filter.assetIds[1]" 8922483798410046 To iSuccess
    Get ComUpdateString Of hoJson "filter.assetExternalIds[0]" "proident Ut consequat in" To iSuccess
    Get ComUpdateString Of hoJson "filter.assetExternalIds[1]" "elit incididunt aliqua" To iSuccess
    Get ComUpdateInt Of hoJson "filter.rootAssetIds[0]" 7714215516056826 To iSuccess
    Get ComUpdateInt Of hoJson "filter.rootAssetIds[1]" 4275780546438472 To iSuccess
    Get ComUpdateInt Of hoJson "filter.assetSubtreeIds[0].id" 123 To iSuccess
    Get ComUpdateString Of hoJson "filter.assetSubtreeIds[1].externalId" "re" To iSuccess
    Get ComUpdateInt Of hoJson "filter.dataSetIds[0].id" 123 To iSuccess
    Get ComUpdateString Of hoJson "filter.dataSetIds[1].externalId" "exercitation nisi elit" To iSuccess
    Get ComUpdateString Of hoJson "filter.externalIdPrefix" "aute Ut nostrud commodo in" To iSuccess
    Get ComUpdateInt Of hoJson "filter.createdTime.max" 16041500 To iSuccess
    Get ComUpdateInt Of hoJson "filter.createdTime.min" 71538919 To iSuccess
    Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.max" 2438620 To iSuccess
    Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.min" 18087967 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/aggregate" "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": "et exercitation s",
        "unit": "pariatur esse qui",
        "isString": true,
        "isStep": false,
        "metadata": {},
        "assetIds": [
            2274246036570026,
            8922483798410046
        ],
        "assetExternalIds": [
            "proident Ut consequat in",
            "elit incididunt aliqua"
        ],
        "rootAssetIds": [
            7714215516056826,
            4275780546438472
        ],
        "assetSubtreeIds": [
            {
                "id": 7555548287718054
            },
            {
                "externalId": "re"
            }
        ],
        "dataSetIds": [
            {
                "id": 5946532482497628
            },
            {
                "externalId": "exercitation nisi elit"
            }
        ],
        "externalIdPrefix": "aute Ut nostrud commodo in",
        "createdTime": {
            "max": 16041500,
            "min": 71538919
        },
        "lastUpdatedTime": {
            "max": 2438620,
            "min": 18087967
        }
    }
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/aggregate

Postman Collection Item JSON

{
  "id": "aggregateTimeSeries",
  "name": "Aggregate time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "aggregate"
      ],
      "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": "Count the number of time series that match the given filter",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"et exercitation s\",\n        \"unit\": \"pariatur esse qui\",\n        \"isString\": true,\n        \"isStep\": false,\n        \"metadata\": {},\n        \"assetIds\": [\n            2274246036570026,\n            8922483798410046\n        ],\n        \"assetExternalIds\": [\n            \"proident Ut consequat in\",\n            \"elit incididunt aliqua\"\n        ],\n        \"rootAssetIds\": [\n            7714215516056826,\n            4275780546438472\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 7555548287718054\n            },\n            {\n                \"externalId\": \"re\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"id\": 5946532482497628\n            },\n            {\n                \"externalId\": \"exercitation nisi elit\"\n            }\n        ],\n        \"externalIdPrefix\": \"aute Ut nostrud commodo in\",\n        \"createdTime\": {\n            \"max\": 16041500,\n            \"min\": 71538919\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 2438620,\n            \"min\": 18087967\n        }\n    }\n}"
    }
  }
}