advancedSearch


SoftLayer_Search::advancedSearch

Search for SoftLayer Resources by simple terms.

Overview

This method allows for searching for SoftLayer resources by simple terms and operators. Fields that are used for searching will be available at sldn.softlayer.com. It returns a collection or array of [[SoftLayer_Container_Search_Result (type)|SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found.

The advancedSearch() method recognizes the special _objectType: quantifier in search strings. See the documentation for the [[SoftLayer_Search/search|search()]] method on how to restrict searches using object types.

The advancedSearch() method recognizes [[SoftLayer_Container_Search_ObjectType_Property (type)|object properties]], which can also be used to limit searches. Example:

_objectType:Type_1 propertyA:value

A search string can specify multiple properties, separated with spaces. Example:

_objectType:Type_1 propertyA:value propertyB:value

A collection of available object types and their properties can be retrieved by calling the [[SoftLayer_Search/getObjectTypes|getObjectTypes()]] method.

Parameters

Name Type Description
searchString string A string with search terms.

Required Headers

  • authenticate

Optional Headers

  • SoftLayer_ObjectMask

Return Values

SoftLayer_Container_Search_Result[]


/reference/services/SoftLayer_Search/advancedSearch/