Represents API performance and diagnostic information.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/ApiHealthRecords
Response Parameters
clientIp
InetAddress
|
The requestor's IP address.
|
method
String
|
HTTP method used for the request.
|
path
String
|
The path component of the URL for the request.
|
query
String
|
The query string from the request, if any.
|
requestAcceptHeader
String
|
Content of the request Accept header, if present.
|
requestReceivedTime
long
|
The time the request was received, as milliseconds from the Unix epoch.
|
responseSentTime
long
|
The time the response was sent, as milliseconds from the Unix epoch.
|
responseStatus
int
|
|
responseTime
long
|
Total time from received to sent, measured in milliseconds.
|
userAgent
String
|
|
username
String
|
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://localhost/webacs/api/v1/data/ApiHealthRecords/15
<?xml version="1.0" ?>
<queryResponse type="ApiHealthRecords" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/ApiHealthRecords/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="apiHealthRecordsDTO" type="ApiHealthRecords" url="https://localhost/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://localhost/webacs/api/v1/data/ApiHealthRecords/15.json
{
"queryResponse" : {
"@type" : "ApiHealthRecords",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ApiHealthRecords\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "apiHealthRecordsDTO",
"@type" : "ApiHealthRecords",
"@url" : "https : \/\/localhost\/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"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/ApiHealthRecords
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
clientIp
InetAddress
|
The requestor's IP address.
|
method
String
|
HTTP method used for the request.
|
path
String
|
The path component of the URL for the request.
|
query
String
|
The query string from the request, if any.
|
requestAcceptHeader
String
|
Content of the request Accept header, if present.
|
requestReceivedTime
long
|
The time the request was received, as milliseconds from the Unix epoch.
|
responseSentTime
long
|
The time the response was sent, as milliseconds from the Unix epoch.
|
responseStatus
int
|
|
responseTime
long
|
Total time from received to sent, measured in milliseconds.
|
userAgent
String
|
|
username
String
|
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://localhost/webacs/api/v2/data/ApiHealthRecords/15
<?xml version="1.0" ?>
<queryResponse type="ApiHealthRecords" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/ApiHealthRecords/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="apiHealthRecordsDTO" type="ApiHealthRecords" url="https://localhost/webacs/api/v2/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://localhost/webacs/api/v2/data/ApiHealthRecords/15.json
{
"queryResponse" : {
"@type" : "ApiHealthRecords",
"@requestUrl" : "https://localhost/webacs/api/v2/data/ApiHealthRecords/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "apiHealthRecordsDTO",
"@type" : "ApiHealthRecords",
"@url" : "https://localhost/webacs/api/v2/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"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/ApiHealthRecords
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
clientIp
InetAddress
|
The requestor's IP address.
|
method
String
|
HTTP method used for the request.
|
path
String
|
The path component of the URL for the request.
|
query
String
|
The query string from the request, if any.
|
requestAcceptHeader
String
|
Content of the request Accept header, if present.
|
requestReceivedTime
long
|
The time the request was received, as milliseconds from the Unix epoch.
|
responseSentTime
long
|
The time the response was sent, as milliseconds from the Unix epoch.
|
responseStatus
int
|
|
responseTime
long
|
Total time from received to sent, measured in milliseconds.
|
userAgent
String
|
|
username
String
|
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://localhost/webacs/api/v3/data/ApiHealthRecords/15
<?xml version="1.0" ?>
<queryResponse type="ApiHealthRecords" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/ApiHealthRecords/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="apiHealthRecordsDTO" type="ApiHealthRecords" url="https://localhost/webacs/api/v3/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://localhost/webacs/api/v3/data/ApiHealthRecords/15.json
{
"queryResponse" : {
"@type" : "ApiHealthRecords",
"@requestUrl" : "https://localhost/webacs/api/v3/data/ApiHealthRecords/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "apiHealthRecordsDTO",
"@type" : "ApiHealthRecords",
"@url" : "https://localhost/webacs/api/v3/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"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/ApiHealthRecords
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
clientIp
InetAddress
|
The requestor's IP address.
|
method
String
|
HTTP method used for the request.
|
path
String
|
The path component of the URL for the request.
|
query
String
|
The query string from the request, if any.
|
requestAcceptHeader
String
|
Content of the request Accept header, if present.
|
requestReceivedTime
long
|
The time the request was received, as milliseconds from the Unix epoch.
|
responseSentTime
long
|
The time the response was sent, as milliseconds from the Unix epoch.
|
responseStatus
int
|
|
responseTime
long
|
Total time from received to sent, measured in milliseconds.
|
userAgent
String
|
|
username
String
|
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://localhost/webacs/api/v4/data/ApiHealthRecords/15
<?xml version="1.0" ?>
<queryResponse type="ApiHealthRecords" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/ApiHealthRecords/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="apiHealthRecordsDTO" type="ApiHealthRecords" url="https://localhost/webacs/api/v4/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://localhost/webacs/api/v4/data/ApiHealthRecords/15.json
{
"queryResponse" : {
"@type" : "ApiHealthRecords",
"@requestUrl" : "https://localhost/webacs/api/v4/data/ApiHealthRecords/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "apiHealthRecordsDTO",
"@type" : "ApiHealthRecords",
"@url" : "https://localhost/webacs/api/v4/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"
}
} ]
}
}