In order to test the API in the API Business Hub, you need to login. Click the Login icon at the top of the page to do so.
When you look at the API Documentation again for the
GET /User method, you will see that the value field has become an editable field. You can test different query parameters by providing a value in the input of the specified data type for that parameter.
GET /User method will return a list of users from Success Factors. That could be a long list, so set the
$top parameter to 5. The top parameter tells the query to retrieve only the top n results once all the other filtering is done. In the
$select parameter, using the control key for Windows or command key for Macs, select
jobTitle. This will limit the data set returned to this 3 fields for the matching results. If you don’t need to see all a users data, only select data points, you can use the
$select parameter to pick the data you want. This will help reduce the size of the resulting data set if performance is an issue.
Once your parameters are all set, click the Try it out button at the bottom of the documentation for that method.
If there aren’t any issues, you will see the resulting request URL and the response body (in
JSON) on your page.
Feel free to keep playing around in the SAP API Business Hub to better understand the methods available in the User Information API.