Chilkat Online Tools

autoit / Datadog API Collection / Update a role

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "data": {
;     "attributes": {
;       "created_at": "<dateTime>",
;       "modified_at": "<dateTime>",
;       "name": "<string>"
;     },
;     "type": "roles",
;     "id": "<string>",
;     "relationships": {
;       "permissions": {
;         "data": [
;           {
;             "id": "<string>",
;             "type": "permissions"
;           },
;           {
;             "id": "<string>",
;             "type": "permissions"
;           }
;         ]
;       },
;       "users": {
;         "data": [
;           {
;             "id": "<string>",
;             "type": "users"
;           },
;           {
;             "id": "<string>",
;             "type": "users"
;           }
;         ]
;       }
;     }
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("data.attributes.created_at","<dateTime>")
$oJson.UpdateString("data.attributes.modified_at","<dateTime>")
$oJson.UpdateString("data.attributes.name","<string>")
$oJson.UpdateString("data.type","roles")
$oJson.UpdateString("data.id","<string>")
$oJson.UpdateString("data.relationships.permissions.data[0].id","<string>")
$oJson.UpdateString("data.relationships.permissions.data[0].type","permissions")
$oJson.UpdateString("data.relationships.permissions.data[1].id","<string>")
$oJson.UpdateString("data.relationships.permissions.data[1].type","permissions")
$oJson.UpdateString("data.relationships.users.data[0].id","<string>")
$oJson.UpdateString("data.relationships.users.data[0].type","users")
$oJson.UpdateString("data.relationships.users.data[1].id","<string>")
$oJson.UpdateString("data.relationships.users.data[1].type","users")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/roles/:role_id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "data": {
;     "type": "roles",
;     "attributes": {
;       "created_at": "<dateTime>",
;       "modified_at": "<dateTime>",
;       "name": "<string>"
;     },
;     "id": "<string>",
;     "relationships": {
;       "permissions": {
;         "data": [
;           {
;             "id": "<string>",
;             "type": "permissions"
;           },
;           {
;             "id": "<string>",
;             "type": "permissions"
;           }
;         ]
;       }
;     }
;   }
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sId
Local $sV_type

Local $sV_Type = $oJResp.StringOf("data.type")
Local $sCreated_at = $oJResp.StringOf("data.attributes.created_at")
Local $sModified_at = $oJResp.StringOf("data.attributes.modified_at")
Local $sName = $oJResp.StringOf("data.attributes.name")
Local $sId = $oJResp.StringOf("data.id")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.relationships.permissions.data")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("data.relationships.permissions.data[i].id")
    $sV_type = $oJResp.StringOf("data.relationships.permissions.data[i].type")
    $i = $i + 1
Wend

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "created_at": "<dateTime>",
      "modified_at": "<dateTime>",
      "name": "<string>"
    },
    "type": "roles",
    "id": "<string>",
    "relationships": {
      "permissions": {
        "data": [
          {
            "id": "<string>",
            "type": "permissions"
          },
          {
            "id": "<string>",
            "type": "permissions"
          }
        ]
      },
      "users": {
        "data": [
          {
            "id": "<string>",
            "type": "users"
          },
          {
            "id": "<string>",
            "type": "users"
          }
        ]
      }
    }
  }
}'
https://api.app.ddog-gov.com/api/v2/roles/:role_id

Postman Collection Item JSON

{
  "name": "Update a role",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/roles/:role_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "roles",
        ":role_id"
      ],
      "variable": [
        {
          "key": "role_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Edit a role. Can only be used with application keys belonging to administrators."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles/:role_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"type\": \"roles\",\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      }\n    }\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles/:role_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Authentication error",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles/:role_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles/:role_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Unprocessable Entity",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles/:role_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
      "code": 422,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<dateTime>\",\n      \"modified_at\": \"<dateTime>\",\n      \"name\": \"<string>\"\n    },\n    \"type\": \"roles\",\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"permissions\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"permissions\"\n          }\n        ]\n      },\n      \"users\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"users\"\n          }\n        ]\n      }\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/roles/:role_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "roles",
            ":role_id"
          ],
          "variable": [
            {
              "key": "role_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}