delphiAx / Datadog API Collection / Send shared dashboard invitation email
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_Email: WideString;
v_type: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// 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": {
// "email": "test@datadoghq.com"
// },
// "type": "public_dashboard_invitation"
// }
// ]
// }
json := TChilkatJsonObject.Create(Self);
json.UpdateString('data[0].attributes.email','test@datadoghq.com');
json.UpdateString('data[0].type','public_dashboard_invitation');
http.SetRequestHeader('Content-Type','application/json');
http.SetRequestHeader('Accept','application/json');
resp := http.PostJson3('https://api.app.ddog-gov.com/api/v1/dashboard/public/:token/invitation','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "attributes": {
// "email": "test@datadoghq.com"
// },
// "type": "public_dashboard_invitation"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i := 0;
count_i := jResp.SizeOfArray('data');
while i < count_i do
begin
jResp.I := i;
v_Email := jResp.StringOf('data[i].attributes.email');
v_type := jResp.StringOf('data[i].type');
i := i + 1;
end;
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": [
{
"attributes": {
"email": "test@datadoghq.com"
},
"type": "public_dashboard_invitation"
}
]
}'
https://api.app.ddog-gov.com/api/v1/dashboard/public/:token/invitation
Postman Collection Item JSON
{
"name": "Send shared dashboard invitation email",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token",
"value": "tempor Ut sed velit"
}
]
},
"description": "Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list."
},
"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 {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\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 {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"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 {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Not Found",
"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 {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\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 {\n \"attributes\": {\n \"email\": \"test@datadoghq.com\"\n },\n \"type\": \"public_dashboard_invitation\"\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token",
"invitation"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}