Custom Search - BlueCat Address Manager - 8.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.0

Search for an array of entities by specifying object properties.

Output / Response

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.

API call:

APIEntity[] customSearch ( String[] filters, String type, String[] options, int start, int count )
Parameter Description
filters The list of properties on which the search will be based. The valid format is Field name=value. Refer to Supported 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.

For more information on passing a String array through RESTful API calls, refer to Passing String[].

type The object type that you wish to search. The type cannot be null or empty string (""). This must be one for the following object types:
  • IP4Block
  • IP4Network
  • IP4Addr
  • GenericRecord
  • HostRecord
  • Any other objects with user-defined fields
options The list of search options specifying the search behavior. Reserved for future use.

For more information on passing a String array through RESTful API calls, refer to Passing String[].

start Indicates where in the list of returned objects to start returning objects. The value must be a non-negative value and cannot be null or empty.
count The maximum number of objects to return. The value must be a positive value between 1 and 1000. This value cannot be null or empty.

Supported object types and fields

Object type Field name=value
IP4Block
  • inheritDNSRestrictions=Boolean
  • pingBeforeAssign=Boolean
  • reverseZoneSigned=Boolean
  • allowDupHost=Boolean
  • inheritDefaultDomains=Boolean
  • highwatermark=Integer
  • lowwatermark=Integer
IP4Network
  • inheritDNSRestrictions=Boolean
  • pingBeforeAssign=Boolean
  • reverseZoneSigned=Boolean
  • allowDupHost=Boolean
  • inheritDefaultDomains=Boolean
  • portInfo=Text
  • highwatermark=Integer
  • lowwatermark=Integer
IP4Addr
  • routerPortInfo=Text
  • portInfo=Text
  • vlanInfo=Text
GenericRecord
  • comments=Text
  • ttl=Long
  • recordType=Text
  • rdata=Text
HostRecord
  • comments=Text
  • ttl=Long

Java client example

  • If using ProteusAPI_PortType:
    //Define filters array
    String[] filters = new String[] { "udf_Int=10", "udf_Text=textudfvalue", "udf_Date=12-Dec-2016", "udf_Boolean=true", "udf_ea=a@a.com", "udf_url=http://a.com", "udf_long=12354" };
    
    //customSearch API call
    APIEntity[] entityArray = service.customSearch( filters, ObjectTypes.IP4Block, new String[] {}, 0, 1000 );

  • If using ProteusAPI:
    //Define filters array
    StringArray filters = new StringArray();
    //filters.getItem().add( "udf_name=udf_value" );
    filters.getItem().add( "udf_Int=10" );
    filters.getItem().add( "udf_Text=textudfvalue" );
    filters.getItem().add( "udf_Date=12-Dec-2016" );
    filters.getItem().add( "udf_Boolean=true" );
    filters.getItem().add( "udf_ea=a@a.com" );
    filters.getItem().add( "udf_url=http://a.com" );
    filters.getItem().add( "udf_long=12354" );
    
    //customSearch API call
    APIEntityArray entityArray = service.customSearch( filters, ObjectTypes.IP4Block, new StringArray(), 0, 1000 );