Web Services Operations

• Introduction to Web Services Operations
• Authentication
• Create and Edit Operation »
• Read Operation »
• Delete Operation
• Publish Operation
• Batch Operation
• Workflow and Web Services Operations
• Search Operation
• Authenticate Operation

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

Search Operation

The search operation is defined by the following WSDL:

<element name="search"> <complexType> <sequence> <element name="authentication" type="impl:authentication"/> <element name="searchInformation" type="impl:searchInformation"/> </sequence> </complexType> </element>

This  operation contains authentication information and search information. The search information complex type is defined as follows:

<complexType name="searchInformation"> <sequence> <!-- Option to switch between AND/OR search behavior REQUIRED --> <element maxOccurs="1" minOccurs="1" name="matchType" type="impl:search-match-type"/> <!-- Search field to match on an asset's name NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="assetName" type="xsd:string"/> <!-- Search field to match on an asset's content NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="assetContent" type="xsd:string"/> <!-- Search field to match on an asset's metadata NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="assetMetadata" type="xsd:string"/> <!-- Whether or not to search block assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchBlocks" type="xsd:boolean"/> <!-- Whether or not to search file assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchFiles" type="xsd:boolean"/> <!-- Whether or not to search folder assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchFolders" type="xsd:boolean"/> <!-- Whether or not to search page assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchPages" type="xsd:boolean"/> <!-- Whether or not to search stylesheet assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchStylesheets" type="xsd:boolean"/> <!-- Whether or not to search symlink assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchSymlinks" type="xsd:boolean"/> <!-- Whether or not to search template assets NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="searchTemplates" type="xsd:boolean"/> </sequence> </complexType>

This search information complex type contains all the fields that one would find in the Advanced Search screen from within the Cascade Server web interface.

When executing a  search, Cascade Server will return a Search Result object:

<complexType name="searchResult"> <complexContent> <extension base="impl:operationResult"> <sequence> <element maxOccurs="1" minOccurs="1" name="matches" type="impl:search-matches"/> </sequence> </extension> </complexContent> </complexType>

This complex type contains a type called "search-matches", which is an array of identifiers:

<complexType name="search-matches"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="match" type="impl:identifier"/> </sequence> </complexType>

Comments

Wiki | Edit