POST api/list/stats/propertystats
Returns a list of totals for properties with expiring information Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The filters value supplied with the request.
Collection of PmPropertiesListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceLevels |
The collection of service levels. |
Collection of string |
None. |
| MissingCertificateAndLicencesTypes |
The collection of missing certificate and licences types. |
Collection of string |
None. |
| TeamGroupIds |
The unique identifiers of the related team group resources. |
Collection of integer |
None. |
| BranchIds |
The unique identifiers of the related branch resources. |
Collection of integer |
None. |
| IncludeActiveTenancies |
Indicates whether include active tenancies is true. |
boolean |
None. |
| Sort |
The sort classification. |
PmPropertyListSort |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Term |
The term value. |
string |
None. |
| OrderByDescending |
Indicates whether order by descending is true. |
boolean |
None. |
| Name |
The name value. |
string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
[
{
"ServiceLevels": [
"sample string 1",
"sample string 2"
],
"MissingCertificateAndLicencesTypes": [
"sample string 1",
"sample string 2"
],
"TeamGroupIds": [
1,
2
],
"BranchIds": [
1,
2
],
"IncludeActiveTenancies": true,
"Sort": 0,
"PageSize": 1,
"PageNumber": 1,
"Term": "sample string 1",
"OrderByDescending": true,
"Name": "sample string 2"
},
{
"ServiceLevels": [
"sample string 1",
"sample string 2"
],
"MissingCertificateAndLicencesTypes": [
"sample string 1",
"sample string 2"
],
"TeamGroupIds": [
1,
2
],
"BranchIds": [
1,
2
],
"IncludeActiveTenancies": true,
"Sort": 0,
"PageSize": 1,
"PageNumber": 1,
"Term": "sample string 1",
"OrderByDescending": true,
"Name": "sample string 2"
}
]
Response Information
Resource Description
The response returned after the operation completes.
Collection of ListStatsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name value. |
string |
None. |
| Value |
The value represented by this field. |
integer |
None. |
Response Formats
application/json, text/json
[
{
"Name": "sample string 1",
"Value": 2
},
{
"Name": "sample string 1",
"Value": 2
}
]