Chilkat Online Tools

lianja / Cognite API v1 / Detect annotations in engineering diagrams

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loJson = createobject("CkJsonObject")
loJson.UpdateInt("items[0].fileId",84773663)
loJson.UpdateBool("items[0].fileExternalId",.F.)
loJson.UpdateInt("items[1].fileId",-80000175)
loJson.UpdateInt("items[1].fileExternalId",61369678)
loJson.UpdateString("searchField","name")
loJson.UpdateBool("partialMatch",.F.)
loJson.UpdateInt("minTokens",2)

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

loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/context/diagram/detect","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

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