Chilkat Online Tools

Objective-C / Cognite API v1 / Filter sequences

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"filter.name" value: @"velit reprehenderit id deserunt"];
[json UpdateString: @"filter.externalIdPrefix" value: @"nostrud incididunt sint aliquip"];
[json UpdateNewObject: @"filter.metadata"];
[json UpdateInt: @"filter.assetIds[0]" value: [NSNumber numberWithInt: 5295434090357810]];
[json UpdateInt: @"filter.assetIds[1]" value: [NSNumber numberWithInt: 2310505827163538]];
[json UpdateInt: @"filter.rootAssetIds[0]" value: [NSNumber numberWithInt: 6293934114666394]];
[json UpdateInt: @"filter.rootAssetIds[1]" value: [NSNumber numberWithInt: 1520557351372486]];
[json UpdateString: @"filter.assetSubtreeIds[0].externalId" value: @"aute irure exercitation id officia"];
[json UpdateInt: @"filter.assetSubtreeIds[1].id" value: [NSNumber numberWithInt: 123]];
[json UpdateInt: @"filter.createdTime.max" value: [NSNumber numberWithInt: 67205762]];
[json UpdateInt: @"filter.createdTime.min" value: [NSNumber numberWithInt: 42063152]];
[json UpdateInt: @"filter.lastUpdatedTime.max" value: [NSNumber numberWithInt: 48288157]];
[json UpdateInt: @"filter.lastUpdatedTime.min" value: [NSNumber numberWithInt: 93771532]];
[json UpdateInt: @"filter.dataSetIds[0].id" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"filter.dataSetIds[1].externalId" value: @"irure"];
[json UpdateInt: @"limit" value: [NSNumber numberWithInt: 100]];
[json UpdateString: @"cursor" value: @"laborum non ipsum"];
[json UpdateString: @"partition" value: @"magna consectetu"];

[http SetRequestHeader: @"content-type" value: @"application/json"];
[http SetRequestHeader: @"api-key" value: @"{{api-key}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/api/v1/projects/{{project}}/sequences/list" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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}"
    }
  }
}