Share via


4.1.1 Retrieve Available Workflow Associations

To retrieve the set of workflow associations for a list known as Documents (given its URL), the protocol client sends the following SOAP message as follows:

 <?xml version="1.0" encoding="utf-8"?>
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
       <GetTemplatesForItem xmlns="http://schemas.microsoft.com/sharepoint/soap/workflow/">
          <item>http://server/Documents/</item>
       </GetTemplatesForItem>
    </soap:Body>
 </soap:Envelope>
 

The protocol server finds the appropriate set of workflow associations for the list known as Documents (given its URL) and returns the set in the form of the following SOAP message:

 <?xml version="1.0" encoding="utf-8"?>
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
       <GetTemplatesForItemResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/workflow/">
          <GetTemplatesForItemResult>
             <TemplateData>
                <Web Title="Site" Url="http://server" />
                <List Title="Documents" Url="http://server/Documents" />
                <WorkflowTemplates>
                   <WorkflowTemplate Name="Collect Feedback" Description="Routes a document for review. Reviewers can provide feedback, which is compiled and sent to the document owner when the workflow has completed." InstantiationUrl="http://server/documents/_layouts/IniWrkflIP.aspx?List=6dc0f376-503e-4a7b-b74f-b4b148a42772&ID=1&TemplateID={092dd5a9-78da-4ab5-b00f-320090113b81}">
                   <WorkflowTemplateIdSet TemplateId="092dd5a9-78da-4ab5-b00f-320090113b81" BaseId="46c389a4-6e18-476c-aa17-289b0c79fb8f" />
                   <AssociationData>
                      <string>
                         <my:myFields xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:my="http://schemas.microsoft.com/office/infopath/2003/myXSD" xml:lang="en-us">
                         <my:Reviewers>
                         </my:Reviewers>
                         <my:CC>
                         </my:CC>
                         <my:DueDate xsi:nil="true">
                         </my:DueDate>
                         <my:Description>
                         </my:Description>
                         <my:Title>
                         </my:Title>
                         <my:DefaultTaskType>0</my:DefaultTaskType>
                         <my:CreateTasksInSerial>false</my:CreateTasksInSerial>
                         <my:AllowDelegation>true</my:AllowDelegation>
                         <my:AllowChangeRequests>true</my:AllowChangeRequests>
                         <my:StopOnAnyReject xsi:nil="true">
                         </my:StopOnAnyReject>
                         <my:WantedTasks xsi:nil="true">
                         </my:WantedTasks>
                         <my:SetMetadataOnSuccess>false</my:SetMetadataOnSuccess>
                         <my:MetadataSuccessField>
                         </my:MetadataSuccessField>
                         <my:MetadataSuccessValue>
                         </my:MetadataSuccessValue>
                         <my:ApproveWhenComplete>false</my:ApproveWhenComplete>
                         <my:TimePerTaskVal xsi:nil="true">
                         </my:TimePerTaskVal>
                         <my:TimePerTaskType xsi:nil="true">
                         </my:TimePerTaskType>
                         <my:Voting>false</my:Voting>
                         <my:MetadataTriggerField>
                         </my:MetadataTriggerField>
                         <my:MetadataTriggerValue>
                         </my:MetadataTriggerValue>
                         <my:InitLock>false</my:InitLock>
                         <my:MetadataStop>false</my:MetadataStop>
                         <my:ItemChangeStop>false</my:ItemChangeStop>
                         <my:GroupTasks>false</my:GroupTasks>
                         </my:myFields>
                      </string>
                   </AssociationData>
                   <Metadata>
                      <Instantiation_FormURN>
                         <string>urn:schemas-microsoft-com:office:infopath:workflow:ReviewRouting-Init:$Subst:LCID;</string>
                      </Instantiation_FormURN>
                   </Metadata>
                </WorkflowTemplate>
                <WorkflowTemplate Name="Collect Signatures" Description="Gathers signatures needed to complete a document. This workflow can be started only from within a client.">
                 <WorkflowTemplateIdSet TemplateId="fd7a5c57-fd96-4656-a07e-712b485201e0" BaseId="2f213931-3b93-4f81-b021-3022434a3114" />
                    <Metadata>
                      <InitiationCategories>
                         <string>SigClientRequired</string>
                      </InitiationCategories>
                      <Instantiation_FormURN>
                         <string>urn:schemas-microsoft-com:office:infopath:workflow:CollectSignatures-Init:$Subst:LCID;</string>
                      </Instantiation_FormURN>
                   </Metadata>
                </WorkflowTemplate>
                <WorkflowTemplate Name="Approval" Description="Routes a document for approval. Approvers can approve or reject the document, reassign the approval task, or request changes to the document." InstantiationUrl="http://server/Documents/_layouts/IniWrkflIP.aspx?List=6dc0f376-503e-4a7b-b74f-b4b148a42772&ID=1&TemplateID={f002dd2c-cdba-4e9a-b9ff-cad76df6e4e7}">
                   <WorkflowTemplateIdSet TemplateId="f002dd2c-cdba-4e9a-b9ff-cad76df6e4e7" BaseId="c6964bff-bf8d-41ac-ad5e-b61ec111731c" />
                      <AssociationData>
                         <string>
                            <my:myFields xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:my="http://schemas.microsoft.com/office/infopath/2003/myXSD" xml:lang="en-us">
                            <my:Reviewers>
                            </my:Reviewers>
                            <my:CC>
                            </my:CC>
                            <my:DueDate xsi:nil="true">
                            </my:DueDate>
                            <my:Description>
                            </my:Description>
                            <my:Title>
                            </my:Title>
                            <my:DefaultTaskType>1</my:DefaultTaskType>
                            <my:CreateTasksInSerial>true</my:CreateTasksInSerial>
                            <my:AllowDelegation>true</my:AllowDelegation>
                            <my:AllowChangeRequests>true</my:AllowChangeRequests>
                            <my:StopOnAnyReject xsi:nil="true">
                            </my:StopOnAnyReject>
                            <my:WantedTasks xsi:nil="true">
                            </my:WantedTasks>
                            <my:SetMetadataOnSuccess>false</my:SetMetadataOnSuccess>
                            <my:MetadataSuccessField>
                            </my:MetadataSuccessField>
                            <my:MetadataSuccessValue>
                            </my:MetadataSuccessValue>
                            <my:ApproveWhenComplete>false</my:ApproveWhenComplete>
                            <my:TimePerTaskVal xsi:nil="true">
                            </my:TimePerTaskVal>
                            <my:TimePerTaskType xsi:nil="true">
                            </my:TimePerTaskType>
                            <my:Voting>false</my:Voting>
                            <my:MetadataTriggerField>
                            </my:MetadataTriggerField>
                            <my:MetadataTriggerValue>
                            </my:MetadataTriggerValue>
                            <my:InitLock>false</my:InitLock>
                            <my:MetadataStop>false</my:MetadataStop>
                            <my:ItemChangeStop>false</my:ItemChangeStop>
                            <my:GroupTasks>false</my:GroupTasks>
                            </my:myFields>
                         </string>
                      </AssociationData>
                      <Metadata>
                         <Instantiation_FormURN>
                            <string>urn:schemas-microsoft-com:office:infopath:workflow:ReviewRouting-Init:$Subst:LCID;</string>
                         </Instantiation_FormURN>
                      </Metadata>
                   </WorkflowTemplate>
                </WorkflowTemplates>
             </TemplateData>
          </GetTemplatesForItemResult>
       </GetTemplatesForItemResponse>
    </soap:Body>
 </soap:Envelope>