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 - Suppliers - Class:
Entity - Required Privilege Level:
user - Required Rights: none
Description
This flowcode operation gets details of the specified supplier.
Request Parameters
The getSupplier 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 |
|---|---|---|---|
supplierId |
xs:integer |
Yes | The supplier id. |
returnBpmDetails |
xs:boolean |
No | Determines if related business process details are returned. Default is false. |
returnAuditDetails |
xs:boolean |
No | Return audit information for the specified supplier. Default is false. |
Response Parameters
| Name | Type | Description |
|---|---|---|
supplier |
JSONDataType |
A JSON string of supplier details. |
bpmDetails |
JSONDataType |
A JSON string of business process details. |
auditDetails |
JSONDataType |
A JSON string of audit details for the specified supplier, grouped by audit transaction id. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager/Suppliers","@method":"getSupplier","params":{"supplierId":1,"returnBpmDetails":false,"returnAuditDetails":false}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("supplierId", "xs:integer")
hornbillAPI.SetParam("returnBpmDetails", "xs:boolean")
hornbillAPI.SetParam("returnAuditDetails", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Suppliers", "getSupplier")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Suppliers",
"@method": "getSupplier",
"params": {
"supplierId": 1,
"returnBpmDetails": false,
"returnAuditDetails": 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/Suppliers";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Suppliers",
"@method": "getSupplier",
"params": {
"supplierId": 1,
"returnBpmDetails": false,
"returnAuditDetails": 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/Suppliers";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager/Suppliers',
'@method' => 'getSupplier',
'params' => (object) [
'supplierId' => 'xs:integer',
'returnBpmDetails' => 'xs:boolean',
'returnAuditDetails' => '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/Suppliers"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager/Suppliers"
"@method" = "getSupplier"
params = @{
supplierId = "xs:integer"
returnBpmDetails = "xs:boolean"
returnAuditDetails = "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/Suppliers"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager/Suppliers",
"@method":"getSupplier",
"params":{
"supplierId":"xs:integer",
"returnBpmDetails":"xs:boolean",
"returnAuditDetails":"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