Chilkat Online Tools

unicodeC / Cognite API v1 / Detect annotations in engineering diagrams

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;

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

    http = CkHttpW_Create();

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

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateInt(json,L"items[0].fileId",84773663);
    CkJsonObjectW_UpdateBool(json,L"items[0].fileExternalId",FALSE);
    CkJsonObjectW_UpdateInt(json,L"items[1].fileId",-80000175);
    CkJsonObjectW_UpdateInt(json,L"items[1].fileExternalId",61369678);
    CkJsonObjectW_UpdateString(json,L"searchField",L"name");
    CkJsonObjectW_UpdateBool(json,L"partialMatch",FALSE);
    CkJsonObjectW_UpdateInt(json,L"minTokens",2);

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

    resp = CkHttpW_PostJson3(http,L"https://domain.com/api/v1/projects/{{project}}/context/diagram/detect",L"application/json",json);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);

    }

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