Represents API performance and diagnostic information.
Since Product Version: 2.2
Resource URL
/webacs/api/v1/data/ApiHealthRecordsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
InetAddress |
clientIp |
The requestor's IP address. |
String |
instanceUuid |
This is a uuid for this instance. |
String |
method |
HTTP method used for the request. |
String |
path |
The path component of the URL for the request. |
String |
query |
The query string from the request, if any. |
String |
requestAcceptHeader |
Content of the request Accept header, if present. |
long |
requestReceivedTime |
The time the request was received, as milliseconds from the Unix epoch. |
long |
responseSentTime |
The time the response was sent, as milliseconds from the Unix epoch. |
int |
responseStatus |
HTTP response status. |
long |
responseTime |
Total time from received to sent, measured in milliseconds. |
String |
userAgent |
The user agent reported. |
String |
username |
The username of the requestor. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://172.25.123.114/webacs/api/v1/data/ApiHealthRecords/15
<?xml version="1.0" ?> <queryResponse type="ApiHealthRecords" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/ApiHealthRecords/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="apiHealthRecordsDTO" type="ApiHealthRecords" url="https://172.25.123.114/webacs/api/v1/data/ApiHealthRecords/15"> <apiHealthRecordsDTO displayName="String value" id="15" uuid="String value"> <clientIp> <address>192.168.115.243</address> </clientIp> <method>String value</method> <path>String value</path> <query>String value</query> <requestAcceptHeader>String value</requestAcceptHeader> <requestReceivedTime>2</requestReceivedTime> <responseSentTime>2</responseSentTime> <responseStatus>1</responseStatus> <responseTime>2</responseTime> <userAgent>String value</userAgent> <username>String value</username> </apiHealthRecordsDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/ApiHealthRecords/15.json
{ "queryResponse" : { "@type" : "ApiHealthRecords", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/ApiHealthRecords\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "apiHealthRecordsDTO", "@type" : "ApiHealthRecords", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/ApiHealthRecords\/15", "apiHealthRecordsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "clientIp" : { "address" : "192.168.115.243" }, "method" : "String value", "path" : "String value", "query" : "String value", "requestAcceptHeader" : "String value", "requestReceivedTime" : 2, "responseSentTime" : 2, "responseStatus" : 1, "responseTime" : 2, "userAgent" : "String value", "username" : "String value" } } } }