Chilkat Online Tools

PureBasic / Cognite API v1 / Update a project

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.

    ; {
    ;   "update": {
    ;     "name": {
    ;       "set": "irur"
    ;     },
    ;     "defaultGroupId": {
    ;       "setNull": false
    ;     },
    ;     "validDomains": {
    ;       "add": [
    ;       ],
    ;       "remove": [
    ;       ]
    ;     },
    ;     "applicationDomains": {
    ;       "add": [
    ;       ],
    ;       "remove": [
    ;       ]
    ;     },
    ;     "authenticationProtocol": {
    ;       "set": "pariatur Lorem veniam"
    ;     },
    ;     "azureADConfiguration": {
    ;       "set": {
    ;         "appId": "",
    ;         "appSecret": "sit exercitation e",
    ;         "tenantId": "qui",
    ;         "appResourceId": "deserunt nulla commodo aute"
    ;       }
    ;     },
    ;     "oAuth2Configuration": {
    ;       "setNull": false
    ;     },
    ;     "oidcConfiguration": {
    ;       "setNull": false
    ;     }
    ;   }
    ; }

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

    CkJsonObject::ckUpdateString(json,"update.name.set","irur")
    CkJsonObject::ckUpdateBool(json,"update.defaultGroupId.setNull",0)
    CkJsonObject::ckUpdateNewArray(json,"update.validDomains.add")
    CkJsonObject::ckUpdateNewArray(json,"update.validDomains.remove")
    CkJsonObject::ckUpdateNewArray(json,"update.applicationDomains.add")
    CkJsonObject::ckUpdateNewArray(json,"update.applicationDomains.remove")
    CkJsonObject::ckUpdateString(json,"update.authenticationProtocol.set","pariatur Lorem veniam")
    CkJsonObject::ckUpdateString(json,"update.azureADConfiguration.set.appId","")
    CkJsonObject::ckUpdateString(json,"update.azureADConfiguration.set.appSecret","sit exercitation e")
    CkJsonObject::ckUpdateString(json,"update.azureADConfiguration.set.tenantId","qui")
    CkJsonObject::ckUpdateString(json,"update.azureADConfiguration.set.appResourceId","deserunt nulla commodo aute")
    CkJsonObject::ckUpdateBool(json,"update.oAuth2Configuration.setNull",0)
    CkJsonObject::ckUpdateBool(json,"update.oidcConfiguration.setNull",0)

    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}}/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 '{
    "update": {
        "name": {
            "set": "irur"
        },
        "defaultGroupId": {
            "setNull": false
        },
        "validDomains": {
            "add": [],
            "remove": []
        },
        "applicationDomains": {
            "add": [],
            "remove": []
        },
        "authenticationProtocol": {
            "set": "pariatur Lorem veniam"
        },
        "azureADConfiguration": {
            "set": {
                "appId": "",
                "appSecret": "sit exercitation e",
                "tenantId": "qui",
                "appResourceId": "deserunt nulla commodo aute"
            }
        },
        "oAuth2Configuration": {
            "setNull": false
        },
        "oidcConfiguration": {
            "setNull": false
        }
    }
}'
https://domain.com/api/v1/projects/{{project}}/update

Postman Collection Item JSON

{
  "id": "updateProject",
  "name": "Update a project",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "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"
      }
    ],
    "description": "Updates the project configuration.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"update\": {\n        \"name\": {\n            \"set\": \"irur\"\n        },\n        \"defaultGroupId\": {\n            \"setNull\": false\n        },\n        \"validDomains\": {\n            \"add\": [],\n            \"remove\": []\n        },\n        \"applicationDomains\": {\n            \"add\": [],\n            \"remove\": []\n        },\n        \"authenticationProtocol\": {\n            \"set\": \"pariatur Lorem veniam\"\n        },\n        \"azureADConfiguration\": {\n            \"set\": {\n                \"appId\": \"\",\n                \"appSecret\": \"sit exercitation e\",\n                \"tenantId\": \"qui\",\n                \"appResourceId\": \"deserunt nulla commodo aute\"\n            }\n        },\n        \"oAuth2Configuration\": {\n            \"setNull\": false\n        },\n        \"oidcConfiguration\": {\n            \"setNull\": false\n        }\n    }\n}"
    }
  }
}