How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.servicemanager - Scope:
Entity - SupplierContracts - Class:
Entity - Required Privilege Level:
guest - Required Rights: none
Description
This operation return a count of contracts by expiry length].
Request Parameters
The getSupplierContractsListCounts API takes the following input parameters.
Note
When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.
| Name | Type | Required | Description |
|---|---|---|---|
viewType |
xs:string |
Yes | The type of view all/watchList |
filterAssets |
xs:string |
No | The assets to filter the contracts by |
filterExpiry |
xs:string |
No | The expiry length to filter the contracts by |
filterOwner |
xs:string |
No | The owner to filter the contracts by |
filterStatus |
xs:string |
No | The status to filter the contracts by |
filterSupplier |
xs:string |
No | The supplier to filter the contracts by |
Response Parameters
| Name | Type | Description |
|---|---|---|
expiresWithin30DaysCount |
xs:integer |
Count of contracts expiring in next 30 days |
expiresWithin60DaysCount |
xs:integer |
Count of contracts expiring in next 60 days |
expiresWithin90DaysCount |
xs:integer |
Count of contracts expiring in next 90 days |
expiresWithin180DaysCount |
xs:integer |
Count of contracts expiring in next 180 days |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/SupplierContracts' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager/SupplierContracts","@method":"getSupplierContractsListCounts","params":{"viewType":"xs:string","filterAssets":"xs:string","filterExpiry":"xs:string","filterOwner":"xs:string","filterStatus":"xs:string","filterSupplier":"xs:string"}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("viewType", "xs:string")
hornbillAPI.SetParam("filterAssets", "xs:string")
hornbillAPI.SetParam("filterExpiry", "xs:string")
hornbillAPI.SetParam("filterOwner", "xs:string")
hornbillAPI.SetParam("filterStatus", "xs:string")
hornbillAPI.SetParam("filterSupplier", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/SupplierContracts", "getSupplierContractsListCounts")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/SupplierContracts";
const payload = {
"@service": "apps/com.hornbill.servicemanager/SupplierContracts",
"@method": "getSupplierContractsListCounts",
"params": {
"viewType": "xs:string",
"filterAssets": "xs:string",
"filterExpiry": "xs:string",
"filterOwner": "xs:string",
"filterStatus": "xs:string",
"filterSupplier": "xs:string"
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/SupplierContracts";
const payload = {
"@service": "apps/com.hornbill.servicemanager/SupplierContracts",
"@method": "getSupplierContractsListCounts",
"params": {
"viewType": "xs:string",
"filterAssets": "xs:string",
"filterExpiry": "xs:string",
"filterOwner": "xs:string",
"filterStatus": "xs:string",
"filterSupplier": "xs:string"
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/SupplierContracts";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager/SupplierContracts',
'@method' => 'getSupplierContractsListCounts',
'params' => (object) [
'viewType' => 'xs:string',
'filterAssets' => 'xs:string',
'filterExpiry' => 'xs:string',
'filterOwner' => 'xs:string',
'filterStatus' => 'xs:string',
'filterSupplier' => 'xs:string',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/SupplierContracts"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager/SupplierContracts"
"@method" = "getSupplierContractsListCounts"
params = @{
viewType = "xs:string"
filterAssets = "xs:string"
filterExpiry = "xs:string"
filterOwner = "xs:string"
filterStatus = "xs:string"
filterSupplier = "xs:string"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/SupplierContracts"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager/SupplierContracts",
"@method":"getSupplierContractsListCounts",
"params":{
"viewType":"xs:string",
"filterAssets":"xs:string",
"filterExpiry":"xs:string",
"filterOwner":"xs:string",
"filterStatus":"xs:string",
"filterSupplier":"xs:string",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document