Chilkat Online Tools

DataFlex / Cognite API v1 / Filter sequences

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": "velit reprehenderit id deserunt",
    //     "externalIdPrefix": "nostrud incididunt sint aliquip",
    //     "metadata": {},
    //     "assetIds": [
    //       5295434090357810,
    //       2310505827163538
    //     ],
    //     "rootAssetIds": [
    //       6293934114666394,
    //       1520557351372486
    //     ],
    //     "assetSubtreeIds": [
    //       {
    //         "externalId": "aute irure exercitation id officia"
    //       },
    //       {
    //         "id": 2979756892505052
    //       }
    //     ],
    //     "createdTime": {
    //       "max": 67205762,
    //       "min": 42063152
    //     },
    //     "lastUpdatedTime": {
    //       "max": 48288157,
    //       "min": 93771532
    //     },
    //     "dataSetIds": [
    //       {
    //         "id": 4906538857069064
    //       },
    //       {
    //         "externalId": "irure"
    //       }
    //     ]
    //   },
    //   "limit": 100,
    //   "cursor": "laborum non ipsum",
    //   "partition": "magna consectetu"
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "filter.name" "velit reprehenderit id deserunt" To iSuccess
    Get ComUpdateString Of hoJson "filter.externalIdPrefix" "nostrud incididunt sint aliquip" To iSuccess
    Get ComUpdateNewObject Of hoJson "filter.metadata" To iSuccess
    Get ComUpdateInt Of hoJson "filter.assetIds[0]" 5295434090357810 To iSuccess
    Get ComUpdateInt Of hoJson "filter.assetIds[1]" 2310505827163538 To iSuccess
    Get ComUpdateInt Of hoJson "filter.rootAssetIds[0]" 6293934114666394 To iSuccess
    Get ComUpdateInt Of hoJson "filter.rootAssetIds[1]" 1520557351372486 To iSuccess
    Get ComUpdateString Of hoJson "filter.assetSubtreeIds[0].externalId" "aute irure exercitation id officia" To iSuccess
    Get ComUpdateInt Of hoJson "filter.assetSubtreeIds[1].id" 123 To iSuccess
    Get ComUpdateInt Of hoJson "filter.createdTime.max" 67205762 To iSuccess
    Get ComUpdateInt Of hoJson "filter.createdTime.min" 42063152 To iSuccess
    Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.max" 48288157 To iSuccess
    Get ComUpdateInt Of hoJson "filter.lastUpdatedTime.min" 93771532 To iSuccess
    Get ComUpdateInt Of hoJson "filter.dataSetIds[0].id" 123 To iSuccess
    Get ComUpdateString Of hoJson "filter.dataSetIds[1].externalId" "irure" To iSuccess
    Get ComUpdateInt Of hoJson "limit" 100 To iSuccess
    Get ComUpdateString Of hoJson "cursor" "laborum non ipsum" To iSuccess
    Get ComUpdateString Of hoJson "partition" "magna consectetu" 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}}/sequences/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": "velit reprehenderit id deserunt",
        "externalIdPrefix": "nostrud incididunt sint aliquip",
        "metadata": {},
        "assetIds": [
            5295434090357810,
            2310505827163538
        ],
        "rootAssetIds": [
            6293934114666394,
            1520557351372486
        ],
        "assetSubtreeIds": [
            {
                "externalId": "aute irure exercitation id officia"
            },
            {
                "id": 2979756892505052
            }
        ],
        "createdTime": {
            "max": 67205762,
            "min": 42063152
        },
        "lastUpdatedTime": {
            "max": 48288157,
            "min": 93771532
        },
        "dataSetIds": [
            {
                "id": 4906538857069064
            },
            {
                "externalId": "irure"
            }
        ]
    },
    "limit": 100,
    "cursor": "laborum non ipsum",
    "partition": "magna consectetu"
}'
https://domain.com/api/v1/projects/{{project}}/sequences/list

Postman Collection Item JSON

{
  "id": "advancedListSequences",
  "name": "Filter sequences",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "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 sequences matching the given criteria.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"velit reprehenderit id deserunt\",\n        \"externalIdPrefix\": \"nostrud incididunt sint aliquip\",\n        \"metadata\": {},\n        \"assetIds\": [\n            5295434090357810,\n            2310505827163538\n        ],\n        \"rootAssetIds\": [\n            6293934114666394,\n            1520557351372486\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"externalId\": \"aute irure exercitation id officia\"\n            },\n            {\n                \"id\": 2979756892505052\n            }\n        ],\n        \"createdTime\": {\n            \"max\": 67205762,\n            \"min\": 42063152\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 48288157,\n            \"min\": 93771532\n        },\n        \"dataSetIds\": [\n            {\n                \"id\": 4906538857069064\n            },\n            {\n                \"externalId\": \"irure\"\n            }\n        ]\n    },\n    \"limit\": 100,\n    \"cursor\": \"laborum non ipsum\",\n    \"partition\": \"magna consectetu\"\n}"
    }
  }
}