Example of using the simplified REST API to get person details

The following example demonstrate how to perform the operations by using Postman client.

Before you begin

Make sure that you have a valid authentication token. For more information, see Access-and-authentication-for-the-simplified-REST-API.

To retrieve person details

1. Open the Postman - REST Client.

2. Depending on your goal, set the request URL and method as any of the following:

   Goal	Method	Sample URL
   To retrieve the support group details based on person ID	POST	https://<Innovation Suite server URL>/api/com.bmc.dsm.itsm.itsm-rest-api/foundation/supportGroups
   To retrieve permission details for a logged in user	GET	https://<Innovation Suite server URL>/api/com.bmc.dsm.itsm.itsm-rest-api/person/permission?user=<person ID>&permissiontype=<permission type>
   To retrieve person details based on the person ID	PATCH	https://<Innovation Suite server URL>/api/com.bmc.dsm.itsm.itsm-rest-api/person/<person ID>?fetchSupportGroups=Y

3. Click Headers.

4. Enter the following data as key value pairs in the header:

   Key	Value
   X-Requested-By	XMLHttpRequest
   Content-Type	application/json

5. Perform the following steps only if you want to retrieve the support group details of a person:
   1. On the Body tab, select raw.
   2. From the list, select JSON.

   3. Enter the JSON.
      For example:

      To retrieve the support group details

      {
       "limit": 10,
       "offset": 10,
       "sortBy": [{ "field" : "priority", "order": "desc"}],
       "fields": "['id','status']",
       "criteria": {
         "bindingExpression": "AND",
         "conditions": "{\r\n              \"fieldName\": \"status\",\r\n              \"operation\": \"eq\",\r\n              \"fieldValue\": \"27000\"\r\n          },\r\n          {\r\n              \"fieldName\": \"assignee\",\r\n              \"operation\": \"eq\",\r\n              \"fieldValue\": \"Allen Allbrook\"\r\n          }"
       }
      }
6. Click Send.
   The results are displayed on the response panel.