Description
Search for an array of entities by specifying object properties.
Note: This API method supports read-only API sessions. For more information on
read-only API sessions and a list of API methods that support read-only
API session, refer to Read-only Legacy v1 API sessions.
Parameters
| Name | Description |
|---|---|
| count |
Location: query Type: integer (int32) The maximum number of objects to return. The value must be a positive
value between 1 and 1000.
|
| filters |
Location: query Type: array The list of properties on which the search will be based. The valid
format is Field name=value. Refer to Reference: Supported search object types and fields for
details.
Note: The field name is case-sensitive.
In addition to the fields that are specified in the table, any
user-defined fields will also be supported.
Note: The valid format for
the Date type user-defined field value is
DD-MMM-YYYY. You can also use partial formatting. For
example, 10-Jan-2016, 10-Jan, Jan-2016 or
2016.
|
| includeHA |
Location: query Type: boolean An optional boolean flag for REST calls that sets the level of detail when
retrieving xHA pair server objects. Polling the xHA status of paired servers
during a search can cause delays, or connection timeouts if a server is
unreachable. When the parameter is set to true, the returned
xHA server object will include details for the xHA status of the nodes.
When set to false, the returned xHA server object will include
only basic information without polling xHA status of the servers. The default
value if omitted is true.
|
| options |
Location: query Type: array The list of search options specifying the search behavior. Reserved for
future use.
|
| start |
Location: query Type: integer (int32) Indicates where in the list of returned objects to start returning
objects. The value must be a positive value.
|
| type |
Location: query Type: string The object type that you wish to search. This must be one for the following object types:
|
Responses
| Code | Description |
|---|---|
| 200 |
Type: Array of APIEntity Returns an array of APIEntities matching the specified object properties or returns an empty array. The APIEntity will at least contain Object Type, Object ID, Object Name, and Object Properties.
|