Chilkat Online Tools

Java / Cognite API v1 / Detect annotations in engineering diagrams

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.

    // {
    //   "items": [
    //     {
    //       "fileId": 84773663,
    //       "fileExternalId": false
    //     },
    //     {
    //       "fileId": -80000175,
    //       "fileExternalId": 61369678
    //     }
    //   ],
    //   "entities": [
    //     {},
    //     {}
    //   ],
    //   "searchField": "name",
    //   "partialMatch": false,
    //   "minTokens": 2
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateInt("items[0].fileId",84773663);
    json.UpdateBool("items[0].fileExternalId",false);
    json.UpdateInt("items[1].fileId",-80000175);
    json.UpdateInt("items[1].fileExternalId",61369678);
    json.UpdateString("searchField","name");
    json.UpdateBool("partialMatch",false);
    json.UpdateInt("minTokens",2);

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

    CkHttpResponse resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/context/diagram/detect","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 '{
    "items": [
        {
            "fileId": 84773663,
            "fileExternalId": false
        },
        {
            "fileId": -80000175,
            "fileExternalId": 61369678
        }
    ],
    "entities": [
        {},
        {}
    ],
    "searchField": "name",
    "partialMatch": false,
    "minTokens": 2
}'
https://domain.com/api/v1/projects/{{project}}/context/diagram/detect

Postman Collection Item JSON

{
  "id": "diagramDetect",
  "name": "Detect annotations in engineering diagrams",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "context",
        "diagram",
        "detect"
      ],
      "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": "Detect annotations in engineering diagrams. Note: All users in a CDF project with assets read-all and files read-all capabilities can access data sent to this endpoint.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"fileId\": 84773663,\n            \"fileExternalId\": false\n        },\n        {\n            \"fileId\": -80000175,\n            \"fileExternalId\": 61369678\n        }\n    ],\n    \"entities\": [\n        {},\n        {}\n    ],\n    \"searchField\": \"name\",\n    \"partialMatch\": false,\n    \"minTokens\": 2\n}"
    }
  }
}