Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Created_at
string ls_Expires_at
string ls_Invite_type
string ls_Uuid
string ls_Id
string ls_DataId
string ls_V_Type
string ls_DataType
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/user_invitations/:user_invitation_uuid",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "created_at": "<dateTime>",
// "expires_at": "<dateTime>",
// "invite_type": "<string>",
// "uuid": "<string>"
// },
// "id": "<string>",
// "relationships": {
// "user": {
// "data": {
// "id": "<string>",
// "type": "users"
// }
// }
// },
// "type": "user_invitations"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Created_at = loo_JResp.StringOf("data.attributes.created_at")
ls_Expires_at = loo_JResp.StringOf("data.attributes.expires_at")
ls_Invite_type = loo_JResp.StringOf("data.attributes.invite_type")
ls_Uuid = loo_JResp.StringOf("data.attributes.uuid")
ls_Id = loo_JResp.StringOf("data.id")
ls_DataId = loo_JResp.StringOf("data.relationships.user.data.id")
ls_V_Type = loo_JResp.StringOf("data.relationships.user.data.type")
ls_DataType = loo_JResp.StringOf("data.type")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/user_invitations/:user_invitation_uuid
Postman Collection Item JSON
{
"name": "Get a user invitation",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid",
"value": "<string>"
}
]
},
"description": "Returns a single user invitation by its UUID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"expires_at\": \"<dateTime>\",\n \"invite_type\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"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}"
}
]
}