Chilkat Online Tools

PureBasic / Cognite API v1 / Update 3D models

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": [
    ;     {
    ;       "id": 8036837436751006,
    ;       "update": {
    ;         "name": {
    ;           "set": "incididunt"
    ;         },
    ;         "dataSetId": {
    ;           "set": 5769907882653108
    ;         },
    ;         "metadata": {
    ;           "add": {},
    ;           "remove": [
    ;           ]
    ;         }
    ;       }
    ;     },
    ;     {
    ;       "id": 8312050959938894,
    ;       "update": {
    ;         "name": {
    ;           "set": "id amet mollit dolor"
    ;         },
    ;         "dataSetId": {
    ;           "setNull": false
    ;         },
    ;         "metadata": {
    ;           "add": {},
    ;           "remove": [
    ;           ]
    ;         }
    ;       }
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"items[0].id",123)
    CkJsonObject::ckUpdateString(json,"items[0].update.name.set","incididunt")
    CkJsonObject::ckUpdateInt(json,"items[0].update.dataSetId.set",123)
    CkJsonObject::ckUpdateNewObject(json,"items[0].update.metadata.add")
    CkJsonObject::ckUpdateNewArray(json,"items[0].update.metadata.remove")
    CkJsonObject::ckUpdateInt(json,"items[1].id",123)
    CkJsonObject::ckUpdateString(json,"items[1].update.name.set","id amet mollit dolor")
    CkJsonObject::ckUpdateBool(json,"items[1].update.dataSetId.setNull",0)
    CkJsonObject::ckUpdateNewObject(json,"items[1].update.metadata.add")
    CkJsonObject::ckUpdateNewArray(json,"items[1].update.metadata.remove")

    CkHttp::ckSetRequestHeader(http,"content-type","application/json")
    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/3d/models/update","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "id": 8036837436751006,
            "update": {
                "name": {
                    "set": "incididunt"
                },
                "dataSetId": {
                    "set": 5769907882653108
                },
                "metadata": {
                    "add": {},
                    "remove": []
                }
            }
        },
        {
            "id": 8312050959938894,
            "update": {
                "name": {
                    "set": "id amet mollit dolor"
                },
                "dataSetId": {
                    "setNull": false
                },
                "metadata": {
                    "add": {},
                    "remove": []
                }
            }
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/3d/models/update

Postman Collection Item JSON

{
  "id": "update3DModels",
  "name": "Update 3D models",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "3d",
        "models",
        "update"
      ],
      "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"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 8036837436751006,\n            \"update\": {\n                \"name\": {\n                    \"set\": \"incididunt\"\n                },\n                \"dataSetId\": {\n                    \"set\": 5769907882653108\n                },\n                \"metadata\": {\n                    \"add\": {},\n                    \"remove\": []\n                }\n            }\n        },\n        {\n            \"id\": 8312050959938894,\n            \"update\": {\n                \"name\": {\n                    \"set\": \"id amet mollit dolor\"\n                },\n                \"dataSetId\": {\n                    \"setNull\": false\n                },\n                \"metadata\": {\n                    \"add\": {},\n                    \"remove\": []\n                }\n            }\n        }\n    ]\n}"
    }
  }
}