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.core - Scope:
Entity - Achievement - Class:
Entity - Required Privilege Level:
none - Required Rights: none
Description
For internal use only - This flowcode operation awards an achievement to the specified user.
Request Parameters
The addAchievement API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
awardedTo |
xs:string |
Yes | The login id of the user who will be awarded the achievement. |
awardedBy |
xs:string |
Yes | The login id of the user who has awarded the achievement. |
category |
xs:string |
Yes | The category of the achievement. |
title |
xs:string |
Yes | The title of the achievement. |
reason |
xs:string |
Yes | The reason for awarding the achievement. |
updateUserWall |
xs:boolean |
No | Indicates whether or not a post will be written to the user's wall. If not specified, the default is false. |
Response Parameters
| Name | Type | Description |
|---|---|---|
result |
xs:string |
The result of the api call. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Achievement' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.core/Achievement","@method":"addAchievement","params":{"awardedTo":"xs:string","awardedBy":"xs:string","category":"xs:string","title":"xs:string","reason":"xs:string","updateUserWall":false}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("awardedTo", "xs:string")
hornbillAPI.SetParam("awardedBy", "xs:string")
hornbillAPI.SetParam("category", "xs:string")
hornbillAPI.SetParam("title", "xs:string")
hornbillAPI.SetParam("reason", "xs:string")
hornbillAPI.SetParam("updateUserWall", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.core/Achievement", "addAchievement")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Achievement";
const payload = {
"@service": "apps/com.hornbill.core/Achievement",
"@method": "addAchievement",
"params": {
"awardedTo": "xs:string",
"awardedBy": "xs:string",
"category": "xs:string",
"title": "xs:string",
"reason": "xs:string",
"updateUserWall": 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.core/Achievement";
const payload = {
"@service": "apps/com.hornbill.core/Achievement",
"@method": "addAchievement",
"params": {
"awardedTo": "xs:string",
"awardedBy": "xs:string",
"category": "xs:string",
"title": "xs:string",
"reason": "xs:string",
"updateUserWall": 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.core/Achievement";
$payload = (object) [
'@service' => 'apps/com.hornbill.core/Achievement',
'@method' => 'addAchievement',
'params' => (object) [
'awardedTo' => 'xs:string',
'awardedBy' => 'xs:string',
'category' => 'xs:string',
'title' => 'xs:string',
'reason' => 'xs:string',
'updateUserWall' => '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.core/Achievement"
$Body = @{
"@service" = "apps/com.hornbill.core/Achievement"
"@method" = "addAchievement"
params = @{
awardedTo = "xs:string"
awardedBy = "xs:string"
category = "xs:string"
title = "xs:string"
reason = "xs:string"
updateUserWall = "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.core/Achievement"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.core/Achievement",
"@method":"addAchievement",
"params":{
"awardedTo":"xs:string",
"awardedBy":"xs:string",
"category":"xs:string",
"title":"xs:string",
"reason":"xs:string",
"updateUserWall":"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