Chilkat Online Tools

Java / Cognite API v1 / Filter extraction pipeline runs

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean 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": {
    //     "externalId": "eu voluptate aute adipisicing",
    //     "statuses": [
    //     ],
    //     "createdTime": {
    //       "max": 18784792,
    //       "min": 33299084
    //     },
    //     "message": {
    //       "substring": "Lorem irure re"
    //     }
    //   },
    //   "limit": 100,
    //   "cursor": "Excepteur"
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateString("filter.externalId","eu voluptate aute adipisicing");
    json.UpdateNewArray("filter.statuses");
    json.UpdateInt("filter.createdTime.max",18784792);
    json.UpdateInt("filter.createdTime.min",33299084);
    json.UpdateString("filter.message.substring","Lorem irure re");
    json.UpdateInt("limit",100);
    json.UpdateString("cursor","Excepteur");

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

    CkHttpResponse resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/extpipes/runs/list","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    System.out.println(resp.get_StatusCode());
    System.out.println(resp.bodyStr());
  }
}

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "externalId": "eu voluptate aute adipisicing",
        "statuses": [],
        "createdTime": {
            "max": 18784792,
            "min": 33299084
        },
        "message": {
            "substring": "Lorem irure re"
        }
    },
    "limit": 100,
    "cursor": "Excepteur"
}'
https://domain.com/api/v1/projects/{{project}}/extpipes/runs/list

Postman Collection Item JSON

{
  "id": "filterRuns",
  "name": "Filter extraction pipeline runs",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "extpipes",
        "runs",
        "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": "Use advanced filtering options to find extraction pipeline runs. Sorted by createdTime value with descendant order.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"externalId\": \"eu voluptate aute adipisicing\",\n        \"statuses\": [],\n        \"createdTime\": {\n            \"max\": 18784792,\n            \"min\": 33299084\n        },\n        \"message\": {\n            \"substring\": \"Lorem irure re\"\n        }\n    },\n    \"limit\": 100,\n    \"cursor\": \"Excepteur\"\n}"
    }
  }
}