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)

Batch Operation

The batch operation is a simple way of accomplishing multiple operations while only transmitting a single soap request/response. Here is the WSDL for the "batch" element:

<element name="batch"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" type="impl:authentication"/> <element maxOccurs="unbounded" name="operation" type="impl:operation"/> </sequence> </complexType> </element>

Authentication has already been discussed; what is important here is the ability to specify any number of "operation" elements, each of which map to the "operation" complex type:

<complexType name="operation"> <choice> <element name="create" type="impl:create"/> <element name="delete" type="impl:delete"/> <element name="edit" type="impl:edit"/> <element name="publish" type="impl:publish"/> <element name="read" type="impl:read"/> </choice> </complexType>

The operation complex type is simply an aggregate of all the other operation types available.

Here is a sample batch request:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <m:batch xmlns:m="http://www.hannonhill.com/ws/ns/AssetOperationService"> <m:authentication> <m:password>admin</m:password> <m:username>admin</m:username> </m:authentication> <m:operation> <m:edit> <m:asset> <m:page> <m:name>default</m:name> <m:parentFolderPath>/intranet</m:parentFolderPath> <m:path>/intranet/default</m:path> <m:metadata> <m:author>Zach Bailey</m:author> </m:metadata> <m:metadataSetId>ROOT</m:metadataSetId> <m:shouldBePublished>true</m:shouldBePublished> <m:shouldBeIndexed>true</m:shouldBeIndexed> <m:xhtml><![CDATA[<p>Welcome to my page!</p>]]></m:xhtml> </m:page> </m:asset> </m:create> <m:publish> <m:identifier> <m:path>/intranet/default</m:path> <m:type>page</m:type> </m:identifier> </m:publish> </m:operation> </m:batch> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

This batch request edits the /intranet/default page and then publishes those changes.

Comments

Wiki | Edit