Classic ASP / Cognite API v1 / Detect annotations in engineering diagrams
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
' 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
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.UpdateInt("items[0].fileId",84773663)
success = json.UpdateBool("items[0].fileExternalId",0)
success = json.UpdateInt("items[1].fileId",-80000175)
success = json.UpdateInt("items[1].fileExternalId",61369678)
success = json.UpdateString("searchField","name")
success = json.UpdateBool("partialMatch",0)
success = json.UpdateInt("minTokens",2)
http.SetRequestHeader "content-type","application/json"
http.SetRequestHeader "api-key","{{api-key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/context/diagram/detect","application/json",json)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
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}"
}
}
}
