Web Services Operations

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

NEWS & TIPS

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

Workflow and Web Services Operations

When a user making an edit, create, or delete request does not have the role/permission to bypass workflow, it is necessary to include workflow information in the request message.

<complexType name="workflow-configuration"> <sequence> <element maxOccurs="1" minOccurs="1" name="workflowName" type="xsd:string"/> <choice> <element maxOccurs="1" minOccurs="1" name="workflowDefinitionId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="workflowDefinitionPath" type="xsd:string"/> </choice> <element maxOccurs="1" minOccurs="1" name="workflowComments" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="workflowStepConfigurations" type="impl:workflow-step-configurations"/> </sequence> </complexType>

This complex type allows the user to specify what to name the workflow instance and what workflow definition to use when instantiating workflow. Additionally, the user must provide workflow comments explaining the action and any workflow step configuration.

Configuring the workflow steps

<complexType name="workflow-step-configurations"> <sequence> <element maxOccurs="unbounded" name="workflowStepConfiguration" type="impl:workflow-step-configuration"/> </sequence> </complexType>

This complex type is just a list of workflowStepConfiguration elements which correspond to workflow-step-configuration complex types:

<complexType name="workflow-step-configuration"> <sequence> <element maxOccurs="1" minOccurs="1" name="stepIdentifier" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="stepAssignment" type="xsd:string"/> </sequence> </complexType>

This allows the user to re-assign workflow steps with a given identifier (using the stepIdentifier element) to a given user or group (using the stepAssignment element). If no workflow step configurations are supplied, the workflow will be initialized with the default values for each step. If no default values are specified in the workflow definition, the user will receive an error explaining that the workflow's steps must be configured.

Wiki | Edit