Chilkat Online Tools

DataFlex / Cognite API v1 / Legacy update of a project

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Handle hoJson
    Variant vSbRequestBody
    Handle hoSbRequestBody
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "authentication": {
    //     "protocol": "oauth2",
    //     "oAuth2Configuration": {
    //       "loginUrl": "veniam",
    //       "logoutUrl": "anim sit",
    //       "tokenUrl": "laboris enim Ut quis cillum",
    //       "clientId": "Ut",
    //       "clientSecret": "sit do dolore"
    //     },
    //     "validDomains": [
    //     ],
    //     "applicationDomains": [
    //     ]
    //   },
    //   "name": "fugiat do",
    //   "defaultGroupId": 14203386
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "authentication.protocol" "oauth2" To iSuccess
    Get ComUpdateString Of hoJson "authentication.oAuth2Configuration.loginUrl" "veniam" To iSuccess
    Get ComUpdateString Of hoJson "authentication.oAuth2Configuration.logoutUrl" "anim sit" To iSuccess
    Get ComUpdateString Of hoJson "authentication.oAuth2Configuration.tokenUrl" "laboris enim Ut quis cillum" To iSuccess
    Get ComUpdateString Of hoJson "authentication.oAuth2Configuration.clientId" "Ut" To iSuccess
    Get ComUpdateString Of hoJson "authentication.oAuth2Configuration.clientSecret" "sit do dolore" To iSuccess
    Get ComUpdateNewArray Of hoJson "authentication.validDomains" To iSuccess
    Get ComUpdateNewArray Of hoJson "authentication.applicationDomains" To iSuccess
    Get ComUpdateString Of hoJson "name" "fugiat do" To iSuccess
    Get ComUpdateInt Of hoJson "defaultGroupId" 14203386 To iSuccess

    Send ComSetRequestHeader To hoHttp "content-type" "application/json"
    Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
    If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
        Send CreateComObject of hoSbRequestBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComEmitSb Of hoJson vSbRequestBody To iSuccess

    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComPTextSb Of hoHttp "PUT" "https://domain.com/api/v1/projects/{{project}}" vSbRequestBody "utf-8" "application/json" False False To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

Curl Command

curl -X PUT
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "authentication": {
        "protocol": "oauth2",
        "oAuth2Configuration": {
            "loginUrl": "veniam",
            "logoutUrl": "anim sit",
            "tokenUrl": "laboris enim Ut quis cillum",
            "clientId": "Ut",
            "clientSecret": "sit do dolore"
        },
        "validDomains": [],
        "applicationDomains": []
    },
    "name": "fugiat do",
    "defaultGroupId": 14203386
}'
https://domain.com/api/v1/projects/{{project}}

Postman Collection Item JSON

{
  "id": "putProject",
  "name": "Legacy update of a project",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "PUT",
    "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. **Warning:** This endpoint does not support partial updates, so all fields must be set when updating the project, otherwise the existing values will be lost. Ensure you set validDomains and applicationDomains correctly. If you set applicationDomains to be empty,  any domains previously set will be removed, and you may lock yourself out of your project.\n",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"authentication\": {\n        \"protocol\": \"oauth2\",\n        \"oAuth2Configuration\": {\n            \"loginUrl\": \"veniam\",\n            \"logoutUrl\": \"anim sit\",\n            \"tokenUrl\": \"laboris enim Ut quis cillum\",\n            \"clientId\": \"Ut\",\n            \"clientSecret\": \"sit do dolore\"\n        },\n        \"validDomains\": [],\n        \"applicationDomains\": []\n    },\n    \"name\": \"fugiat do\",\n    \"defaultGroupId\": 14203386\n}"
    }
  }
}