Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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": {
# "name": "<string>",
# "created_at": "<dateTime>",
# "modified_at": "<dateTime>"
# },
# "relationships": {
# "permissions": {
# "data": [
# {
# "id": "<string>",
# "type": "permissions"
# },
# {
# "id": "<string>",
# "type": "permissions"
# }
# ]
# },
# "users": {
# "data": [
# {
# "id": "<string>",
# "type": "users"
# },
# {
# "id": "<string>",
# "type": "users"
# }
# ]
# }
# },
# "type": "roles"
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("data.attributes.name","<string>")
json.UpdateString("data.attributes.created_at","<dateTime>")
json.UpdateString("data.attributes.modified_at","<dateTime>")
json.UpdateString("data.relationships.permissions.data[0].id","<string>")
json.UpdateString("data.relationships.permissions.data[0].type","permissions")
json.UpdateString("data.relationships.permissions.data[1].id","<string>")
json.UpdateString("data.relationships.permissions.data[1].type","permissions")
json.UpdateString("data.relationships.users.data[0].id","<string>")
json.UpdateString("data.relationships.users.data[0].type","users")
json.UpdateString("data.relationships.users.data[1].id","<string>")
json.UpdateString("data.relationships.users.data[1].type","users")
json.UpdateString("data.type","roles")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/roles","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "type": "roles",
# "attributes": {
# "name": "<string>",
# "created_at": "<dateTime>",
# "modified_at": "<dateTime>"
# },
# "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
v_Type = jResp.stringOf("data.type")
Name = jResp.stringOf("data.attributes.name")
Created_at = jResp.stringOf("data.attributes.created_at")
Modified_at = jResp.stringOf("data.attributes.modified_at")
Id = jResp.stringOf("data.id")
i = 0
count_i = jResp.SizeOfArray("data.relationships.permissions.data")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("data.relationships.permissions.data[i].id")
v_type = jResp.stringOf("data.relationships.permissions.data[i].type")
i = i + 1
end
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"name": "<string>",
"created_at": "<dateTime>",
"modified_at": "<dateTime>"
},
"relationships": {
"permissions": {
"data": [
{
"id": "<string>",
"type": "permissions"
},
{
"id": "<string>",
"type": "permissions"
}
]
},
"users": {
"data": [
{
"id": "<string>",
"type": "users"
},
{
"id": "<string>",
"type": "users"
}
]
}
},
"type": "roles"
}
}'
https://api.app.ddog-gov.com/api/v2/roles
Postman Collection Item JSON
{
"name": "Create role",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\"\n },\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 \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
},
"description": "Create a new role for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"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 \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\"\n },\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 \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\"\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": "POST",
"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 \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\"\n },\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 \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"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": "POST",
"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 \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\"\n },\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 \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "POST",
"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 \"name\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\"\n },\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 \"type\": \"roles\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
]
}
},
"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}"
}
]
}
