Chilkat Online Tools

Swift3 / Cognite API v1 / Detect annotations in engineering diagrams

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

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

    let json = CkoJsonObject()!
    json.updateInt("items[0].fileId", value: 84773663)
    json.updateBool("items[0].fileExternalId", value: false)
    json.updateInt("items[1].fileId", value: -80000175)
    json.updateInt("items[1].fileExternalId", value: 61369678)
    json.update("searchField", value: "name")
    json.updateBool("partialMatch", value: false)
    json.updateInt("minTokens", value: 2)

    http.setRequestHeader("content-type", value: "application/json")
    http.setRequestHeader("api-key", value: "{{api-key}}")

    var resp: CkoHttpResponse? = http.postJson3("https://domain.com/api/v1/projects/{{project}}/context/diagram/detect", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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