Chilkat Online Tools

autoit / 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.

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

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

$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateInt("items[0].fileId",84773663)
$oJson.UpdateBool("items[0].fileExternalId",False)
$oJson.UpdateInt("items[1].fileId",-80000175)
$oJson.UpdateInt("items[1].fileExternalId",61369678)
$oJson.UpdateString("searchField","name")
$oJson.UpdateBool("partialMatch",False)
$oJson.UpdateInt("minTokens",2)

$oHttp.SetRequestHeader "content-type","application/json"
$oHttp.SetRequestHeader "api-key","{{api-key}}"

Local $oResp = $oHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/context/diagram/detect","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

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