Get Aliases by Hint - BlueCat Address Manager - 9.0.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.0.0

Returns an array of CNAMEs with linked record name.

Output / Response

Returns an array of Alias APIEntity objects.

API call:

APIEntity[] getAliasesByHint ( int start, int count, String options )
Parameter Description
start indicates where in the list of objects to start returning objects. The list begins at an index of 0.
count indicates the maximum of child objects that this method will return. The value must be less than or equal to 10.
options a string containing options. The supported options are hintand retrieveFields. Multiple options can be separated by a | (pipe) character. For example:
hint=^abc|retrieveFields=false
If the hint option is not specified in the string, searching criteria will be based on the same as zone alias. The following wildcards are supported in the hint option.
  • ^—matches the beginning of a string. For example: ^ex matches example but not text.
  • $—matches the end of a string. For example: ple$ matches example but not please.
  • ^ $—matches the exact characters between the two wildcards. For example: ^example$ only matches example.
  • ?—matches any one character. For example: ex?t matches exit.
  • *—matches one or more characters within a string. For example: ex*t matches exit and excellent.
The default value for the retrieveFields option is set to false. If the option is set to true, user-defined field will be returned. If the options string does not contain retrieveFields, user-defined field will not be returned.