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:
user - Required Rights: none
Description
This flowcode operation gets details of the specified supplier contract.
Request Parameters
The getSupplierContract 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 |
|---|---|---|---|
id |
xs:string |
Yes | The supplier contract id. |
returnAuditDetails |
xs:boolean |
No | Return audit information for the specified supplier contract. Default is false. |
returnSupplierAssets |
xs:boolean |
No | Return associated supplier assets for the parent supplier of the specified supplier contract. Default is false. |
Response Parameters
| Name | Type | Description |
|---|---|---|
supplierContract |
JSONDataType |
A JSON string of supplier contract details. |
compliancePercentage |
xs:integer |
The supplier contract compliance percentage based on events against the contract. |
auditDetails |
JSONDataType |
A JSON string of audit details for the specified supplier contract, grouped by audit transaction id. |
supplierAssets |
JSONDataType |
A JSON string of supplier assets for the parent supplier of the specified supplier contract. |
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":"getSupplierContract","params":{"id":"xs:string","returnAuditDetails":false,"returnSupplierAssets":false}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("id", "xs:string")
hornbillAPI.SetParam("returnAuditDetails", "xs:boolean")
hornbillAPI.SetParam("returnSupplierAssets", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/SupplierContracts", "getSupplierContract")
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": "getSupplierContract",
"params": {
"id": "xs:string",
"returnAuditDetails": false,
"returnSupplierAssets": false
}
};
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": "getSupplierContract",
"params": {
"id": "xs:string",
"returnAuditDetails": false,
"returnSupplierAssets": false
}
};
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' => 'getSupplierContract',
'params' => (object) [
'id' => 'xs:string',
'returnAuditDetails' => 'xs:boolean',
'returnSupplierAssets' => 'xs:boolean',
]
];
$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" = "getSupplierContract"
params = @{
id = "xs:string"
returnAuditDetails = "xs:boolean"
returnSupplierAssets = "xs:boolean"
}
}
$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":"getSupplierContract",
"params":{
"id":"xs:string",
"returnAuditDetails":"xs:boolean",
"returnSupplierAssets":"xs:boolean",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document