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.projectmanager - Scope:
Global - Class:
Application - Required Privilege Level:
user - Required Rights: Group E - canViewAllProjects
Description
This flowcode operation gets details of users that have access to the Hornbill Project Manager application based on the search criteria provided.
Request Parameters
The getProjectManagerUsers 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 |
|---|---|---|---|
searchFilter |
xs:string |
No | Search criteria for project manager users. |
filterByTeam |
xs:string |
No | Filters the results by a valid team id |
rowStart |
xs:integer |
Yes | Row Start for Paging. |
rowLimit |
xs:integer |
Yes | Page Size. |
startDatePeriod1 |
xs:date |
No | The start date of the time period - used for calculation capacity % |
endDatePeriod1 |
xs:date |
No | The end date of the time period - used for calculation capacity % |
startDatePeriod2 |
xs:date |
No | The start date of the time period - used for calculation capacity % |
endDatePeriod2 |
xs:date |
No | The end date of the time period - used for calculation capacity % |
Response Parameters
| Name | Type | Description |
|---|---|---|
outcome |
xs:string |
The outcome of the flowcode operation. |
totalRecordCount |
xs:integer |
The total number of project manager users that match the search criteria provided. |
projectManagerUsers |
xs:string |
A JSON string of all project manager users that match the search criteria provided. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.projectmanager","@method":"getProjectManagerUsers","params":{"searchFilter":"xs:string","filterByTeam":"xs:string","rowStart":1,"rowLimit":1,"startDatePeriod1":"xs:date","endDatePeriod1":"xs:date","startDatePeriod2":"xs:date","endDatePeriod2":"xs:date"}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("searchFilter", "xs:string")
hornbillAPI.SetParam("filterByTeam", "xs:string")
hornbillAPI.SetParam("rowStart", "xs:integer")
hornbillAPI.SetParam("rowLimit", "xs:integer")
hornbillAPI.SetParam("startDatePeriod1", "xs:date")
hornbillAPI.SetParam("endDatePeriod1", "xs:date")
hornbillAPI.SetParam("startDatePeriod2", "xs:date")
hornbillAPI.SetParam("endDatePeriod2", "xs:date")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.projectmanager", "getProjectManagerUsers")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager";
const payload = {
"@service": "apps/com.hornbill.projectmanager",
"@method": "getProjectManagerUsers",
"params": {
"searchFilter": "xs:string",
"filterByTeam": "xs:string",
"rowStart": 1,
"rowLimit": 1,
"startDatePeriod1": "xs:date",
"endDatePeriod1": "xs:date",
"startDatePeriod2": "xs:date",
"endDatePeriod2": "xs:date"
}
};
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.projectmanager";
const payload = {
"@service": "apps/com.hornbill.projectmanager",
"@method": "getProjectManagerUsers",
"params": {
"searchFilter": "xs:string",
"filterByTeam": "xs:string",
"rowStart": 1,
"rowLimit": 1,
"startDatePeriod1": "xs:date",
"endDatePeriod1": "xs:date",
"startDatePeriod2": "xs:date",
"endDatePeriod2": "xs:date"
}
};
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.projectmanager";
$payload = (object) [
'@service' => 'apps/com.hornbill.projectmanager',
'@method' => 'getProjectManagerUsers',
'params' => (object) [
'searchFilter' => 'xs:string',
'filterByTeam' => 'xs:string',
'rowStart' => 'xs:integer',
'rowLimit' => 'xs:integer',
'startDatePeriod1' => 'xs:date',
'endDatePeriod1' => 'xs:date',
'startDatePeriod2' => 'xs:date',
'endDatePeriod2' => 'xs:date',
]
];
$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.projectmanager"
$Body = @{
"@service" = "apps/com.hornbill.projectmanager"
"@method" = "getProjectManagerUsers"
params = @{
searchFilter = "xs:string"
filterByTeam = "xs:string"
rowStart = "xs:integer"
rowLimit = "xs:integer"
startDatePeriod1 = "xs:date"
endDatePeriod1 = "xs:date"
startDatePeriod2 = "xs:date"
endDatePeriod2 = "xs:date"
}
}
$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.projectmanager"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.projectmanager",
"@method":"getProjectManagerUsers",
"params":{
"searchFilter":"xs:string",
"filterByTeam":"xs:string",
"rowStart":"xs:integer",
"rowLimit":"xs:integer",
"startDatePeriod1":"xs:date",
"endDatePeriod1":"xs:date",
"startDatePeriod2":"xs:date",
"endDatePeriod2":"xs:date",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document