Generic methods for searching and retrieving entities.
- Custom Search
- Search by Category
- Search by Object Types
- Get Entities by Name
- Get Entities by Name Using Options
- Get MAC Address
Searching for objects using the API returns the search term (keyword) found within common fields, such as the name of the entity itself, and metadata fields. Performing a search using the API is equivalent to performing a search through the Address Manager User Interface with the Search Type set to All Fields.
Note: If you are searching for resource records, the API searched based on the record name
and not the FQDN.
Supported wildcards in the search string:
You can use the following wildcards when invoking a search method. These wildcards
are supported only in the String parameter:
- ^—matches the beginning of a string. For example, ^ex matches example but not text.
- $—matches the end of string. For example: ple$ matches example but not please.
- *—matches zero or more characters within a string. For example: ex*t matches exit and excellent.
Note: You cannot use the following characters in the search string:
- , (comma)
- ‘ (single quotation mark)
- ( ) (parentheses)
- [ ] (square brackets)
- { } (braces)
- % (percent)
- ? (question mark)
- + (addition/plus sign)