Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Developer reference
- Overview of the REST API
- Connect to the REST API
- Authentication endpoint service
- Single record APIs
- Record bulk update and collection APIs
- REST API queries
- REST API collection query protocol
- Analytics REST API
- Manage Persons API
- BI Integration API
- Case Exchange REST API
- Encryption domain API
- Comments API
- REST API use-case scenario - import REST API
Single record API
The only API implemented for single records is the Get record by ID API.
The syntax can be in the following formats:
- The tenant ID is directly in the URL:
https://<serverAddress>/rest/<tenant-id>/ems/<entity-type>/<id>?<layout>
- The tenant ID is in a parameter:
https://<serverAddress>/rest/<tenant-id>/ems/<entity-type>/<id>?<layout>&TENANTID=<tenant-id>
- The customer domain has a domain mapping:
https://<customer domain name>/rest/<tenant-id>/ems/<entity-type>/<id>?<layout>
where:
tenant-id represents the tenant ID. To access the tenant ID, right-click the Launch button next to the required product on MyAccount, select Copy link address and paste it into a browser. The tenant ID is the number following TENANTID=.
entity-type represents the logical name of the record to return. Example: incident.
id represents the ID of the record instance.
layout represents a part of the REST query specifications. It specifies the record properties to be returned.
Note
- The layout parameter is mandatory. For more information about the layout parameter, see Layout.
- You can view the available record types (for the entity-type parameter) by going to Administration > Configuration > Records and opening the drop-down list at the upper left. You can view the available properties (for the layout parameter) by selecting the required record type and going to the Fields tab.
Request structure
Enter the following request URI:
https://<serverAddress>/rest/<tenant-id>/ems/Person/10548?layout=Name,Avatar
Alternatively, you can enter the request URI using the parameter format:
https://<serverAddress>/rest/1234/ems/Person/10548?layout=Name,Avatar&TENANTID=1234
If the customer domain has a domain mapping, you can enter the request URI as follows:
https://<customer domain name>.hpe.com/rest/<tenant-id>/ems/Person/10548?layout=Name,Avatar
Return structure
The following is an example of the structure of the returned data in JSON format:
{ "entities": [ { "entity_type": "Person", "properties": { "Name": "Ivey Dillard", "Id": "10548", "LastUpdateTime": 1385656386731 }, "related_properties": {} } ], "meta": { "completion_status": "OK" } }
Related topics