Chilkat Online Tools

.NET Core C# / Cognite API v1 / Retrieve extraction pipelines

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
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.

// {
//   "items": [
//     {
//       "externalId": "voluptate consequat"
//     },
//     {
//       "externalId": "culpa"
//     }
//   ],
//   "ignoreUnknownIds": false
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("items[0].externalId","voluptate consequat");
json.UpdateString("items[1].externalId","culpa");
json.UpdateBool("ignoreUnknownIds",false);

http.SetRequestHeader("content-type","application/json");
http.SetRequestHeader("api-key","{{api-key}}");

Chilkat.HttpResponse resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/extpipes/byids","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "voluptate consequat"
        },
        {
            "externalId": "culpa"
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/extpipes/byids

Postman Collection Item JSON

{
  "id": "byidsExtPipes",
  "name": "Retrieve extraction pipelines",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "extpipes",
        "byids"
      ],
      "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 information about multiple extraction pipelines in the same project. All ids and externalIds must be unique.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"voluptate consequat\"\n        },\n        {\n            \"externalId\": \"culpa\"\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}