Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
To retrieve the aggregated set of workflow associations, workflows, workflow tasks, and other related information for a document, the protocol client sends the following SOAP message:
-
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetWorkflowDataForItem xmlns="http://schemas.microsoft.com/sharepoint/soap/workflow/"> <item>http://server/Documents/Document.docx</item> </GetWorkflowDataForItem> </soap:Body> </soap:Envelope>
The protocol server finds the appropriate set of data for the document and responds with 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> <GetWorkflowDataForItemResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/workflow/"> <GetWorkflowDataForItemResult> <WorkflowData> <ToDoData> <xml xmlns:s="uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882" xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882" xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:z="#RowsetSchema"> <rs:data ItemCount="2"> <z:row ows_ContentTypeId="0x01080100C9C9515DE4E24001905074F980F93160003CB2AB313AE62048BEE174C9F41ECC7C" ows_Title="Please approve Document" ows_Priority="(2) Normal" ows_Status="Not Started" ows_AssignedTo="1;#User" ows_Body="Please approve Document" ows_StartDate="2008-02-06 10:18:13" ows_WorkflowLink="http://server/Documents/Document.docx, Document" ows_WorkflowName="Approval" ows_TaskType="1" ows_FormURN="urn:schemas-microsoft-com:office:infopath:workflow:ReviewRouting-Review:$Subst:LCID;" ows_HasCustomEmailBody="0" ows_SendEmailNotification="1" ows_Completed="0" ows_WorkflowListId="{5F2F1E89-06D7-44F5-886B-3EE11FF2D5B3}" ows_WorkflowItemId="6" ows_AllowChangeRequests="True" ows_AllowDelegation="True" ows_BodyText="Please approve Document" ows_ContentType="Office SharePoint Server Workflow Task" ows_ID="13" ows_WorkflowFormURL="" ows_FormData="" ows_Modified="2008-02-06 10:18:13" ows_Created="2008-02-06 10:18:13" ows_Author="1;#User" ows_Editor="1073741823;#System Account" ows_owshiddenversion="1" ows_WorkflowVersion="1" ows__UIVersion="512" ows__UIVersionString="1.0" ows_Attachments="0" ows__ModerationStatus="0" ows_LinkTitleNoMenu="Please approve Document" ows_LinkTitle="Please approve Document" ows_SelectTitle="13" ows_Order="1300.00000000000" ows_GUID="{C72C44AB-3DD7-4947-8E60-BAF09E56E9BF}" ows_WorkflowInstanceID="{3EFDE9D9-C8DE-463B-8FE6-F13E15419C79}" ows_FileRef="13;#Lists/Tasks/13_.000" ows_FileDirRef="13;#Lists/Tasks" ows_Last_x0020_Modified="13;#2008-02-06 10:18:13" ows_Created_x0020_Date="13;#2008-02-06 10:18:13" ows_FSObjType="13;#0" ows_PermMask="0x7fffffffffffffff" ows_FileLeafRef="13;#13_.000" ows_UniqueId="13;#{0B46AE7B-EB5E-4C2A-9B0A-3FE29BE2078C}" ows_ProgId="13;#" ows_ScopeId="13;#{349A0AFD-F2F8-4564-A1D4-CCFF4880C19C}" ows__EditMenuTableStart="13_.000" ows__EditMenuTableEnd="13" ows_LinkFilenameNoMenu="13_.000" ows_LinkFilename="13_.000" ows_ServerUrl="/Lists/Tasks/13_.000" ows_EncodedAbsUrl="http://server/Lists/Tasks/13_.000" ows_BaseName="13_" ows__Level="1" ows__IsCurrentVersion="1" ows_MetaInfo_vti_versionhistory="4c620c8dbfe64857a29e5b628ebb9ddb:1" ows_MetaInfo_WorkflowCreationPath="94218b95-47d3-4fa3-8e3f-f44f6d234acd;" ows_TaskListId="4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" ows_EditFormURL="http://server/_layouts/WrkTaskIP.aspx?ID=13&List=4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" /> <z:row ows_ContentTypeId="0x01080100C9C9515DE4E24001905074F980F93160003CB2AB313AE62048BEE174C9F41ECC7C" ows_Title="Please approve Document" ows_Priority="(2) Normal" ows_Status="Not Started" ows_AssignedTo="1;#User" ows_Body="asdf" ows_StartDate="2008-02-13 13:28:52" ows_WorkflowLink="http://server/Documents/Document.docx, Document" ows_WorkflowName="app" ows_TaskType="1" ows_FormURN="urn:schemas-microsoft-com:office:infopath:workflow:ReviewRouting-Review:$Subst:LCID;" ows_HasCustomEmailBody="0" ows_SendEmailNotification="1" ows_Completed="0" ows_WorkflowListId="{5F2F1E89-06D7-44F5-886B-3EE11FF2D5B3}" ows_WorkflowItemId="6" ows_AllowChangeRequests="True" ows_AllowDelegation="True" ows_BodyText="asdf" ows_ContentType="Office SharePoint Server Workflow Task" ows_ID="21" ows_Modified="2008-02-13 13:28:52" ows_Created="2008-02-13 13:28:52" ows_Author="1;#User" ows_Editor="1073741823;#System Account" ows_owshiddenversion="1" ows_WorkflowVersion="1" ows__UIVersion="512" ows__UIVersionString="1.0" ows_Attachments="0" ows__ModerationStatus="0" ows_LinkTitleNoMenu="Please approve Document" ows_LinkTitle="Please approve Document" ows_SelectTitle="21" ows_Order="2100.00000000000" ows_GUID="{F390F9F9-4942-482C-A238-3002A332BF4D}" ows_WorkflowInstanceID="{874E77FB-144F-4E4E-9500-25C9D1FC53E4}" ows_FileRef="21;#Lists/Tasks/21_.000" ows_FileDirRef="21;#Lists/Tasks" ows_Last_x0020_Modified="21;#2008-02-13 13:28:53" ows_Created_x0020_Date="21;#2008-02-13 13:28:53" ows_FSObjType="21;#0" ows_PermMask="0x7fffffffffffffff" ows_FileLeafRef="21;#21_.000" ows_UniqueId="21;#{21C0167B-0810-456B-BC87-2490301830C1}" ows_ProgId="21;#" ows_ScopeId="21;#{349A0AFD-F2F8-4564-A1D4-CCFF4880C19C}" ows__EditMenuTableStart="21_.000" ows__EditMenuTableEnd="21" ows_LinkFilenameNoMenu="21_.000" ows_LinkFilename="21_.000" ows_ServerUrl="/Lists/Tasks/21_.000" ows_EncodedAbsUrl="http://server/Lists/Tasks/21_.000" ows_BaseName="21_" ows__Level="1" ows__IsCurrentVersion="1" ows_MetaInfo_vti_versionhistory="4c620c8dbfe64857a29e5b628ebb9ddb:1" ows_MetaInfo_WorkflowCreationPath="ab6d93ed-0fc1-49ca-8259-b02533f51859;" ows_TaskListId="4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" ows_EditFormURL="http://server/_layouts/WrkTaskIP.aspx?ID=21&List=4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" /> </rs:data> </xml> </ToDoData> <TemplateData> <Web Title="Home" Url="http://server" /> <List Title="Documents" Url="http://server/Documents" /> <WorkflowTemplates> <WorkflowTemplate Name="app" 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/_layouts/IniWrkflIP.aspx?List=5f2f1e89-06d7-44f5-886b-3ee11ff2d5b3&ID=6&TemplateID={ab6d93ed-0fc1-49ca-8259-b02533f51859}"> <WorkflowTemplateIdSet TemplateId="ab6d93ed-0fc1-49ca-8259-b02533f51859" BaseId="c6964bff-bf8d-41ac-ad5e-b61ec111731c" /> <AssociationData> <string><my:myFields xml:lang="en-us" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:my="http://schemas.microsoft.com/office/infopath/2003/myXSD"> <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> <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/_layouts/IniWrkflIP.aspx?List=5f2f1e89-06d7-44f5-886b-3ee11ff2d5b3&ID=6&TemplateID={b03dba1a-b247-451f-9ea2-117d7e366cdb}"> <WorkflowTemplateIdSet TemplateId="b03dba1a-b247-451f-9ea2-117d7e366cdb" 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 Microsoft Office document. This workflow can be started only from within an Office client."> <WorkflowTemplateIdSet TemplateId="5b8d2cf1-3ef0-46ee-ae87-61c595a34fb7" 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/_layouts/IniWrkflIP.aspx?List=5f2f1e89-06d7-44f5-886b-3ee11ff2d5b3&ID=6&TemplateID={94218b95-47d3-4fa3-8e3f-f44f6d234acd}"> <WorkflowTemplateIdSet TemplateId="94218b95-47d3-4fa3-8e3f-f44f6d234acd" 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> <ActiveWorkflowsData> <Workflows> <Workflow StatusPageUrl="http://server/_layouts/WrkStat.aspx?List=%7B5F2F1E89%2D06D7%2D44F5%2D886B%2D3EE11FF2D5B3%7D&WorkflowInstanceID=%7B874e77fb%2D144f%2D4e4e%2D9500%2D25c9d1fc53e4%7D" Id="874e77fb-144f-4e4e-9500-25c9d1fc53e4" TemplateId="ab6d93ed-0fc1-49ca-8259-b02533f51859" ListId="5f2f1e89-06d7-44f5-886b-3ee11ff2d5b3" SiteId="4ca76181-d8d6-4535-86c7-2eb7fcf91c0e" WebId="598b4ef0-3ec0-4282-aac9-ed6d114f2b7f" ItemId="6" ItemGUID="7522c63c-a7b4-4bff-bf34-3c274b2d8ea7" TaskListId="4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" AdminTaskListId="" Author="1" Modified="20080213 21:28:53" Created="20080213 21:28:52" StatusVersion="0" Status1="2" Status2="" Status3="" Status4="" Status5="" Status6="" Status7="" Status8="" Status9="" Status10="" TextStatus1="" TextStatus2="" TextStatus3="" TextStatus4="" TextStatus5="" Modifications="<Mods><Mod><SubId>{5227289E-3495-45C3-94B4-459B80A2D40A}</SubId><Id>{27F914AE-3112-493D-86CF-43DC93870418}</Id><Data>&lt;my:DueDate&gt;&lt;/my:DueDate&gt;&lt;my:Description&gt;asdf&lt;/my:Description&gt;</Data></Mod><Mod><SubId>{7B38EE35-538E-4EF5-B560-631F4B9C367B}</SubId><Id>{B21BCC38-2C23-4B64-8E7D-C32C43AD42CF}</Id><Data></Data></Mod><Mod><SubId>{4235BEB6-C0CA-42DE-9397-9D2E6D47BCA7}</SubId><Id>{AF71F77B-E6C8-483A-ACBF-30B4A84BD209}</Id><Data>&lt;my:NewReviewers&gt;&lt;/my:NewReviewers&gt;&lt;my:DueDate&gt;&lt;/my:DueDate&gt;&lt;my:Description&gt;asdf&lt;/my:Description&gt;&lt;my:Duration xsi:nil=&quot;true&quot;&gt;&lt;/my:Duration&gt;&lt;my:DurType&gt;0&lt;/my:DurType&gt;&lt;my:GroupTasks&gt;false&lt;/my:GroupTasks&gt;&lt;my:ShowDuration&gt;1&lt;/my:ShowDuration&gt;</Data></Mod></Mods>" ActivityDetails="System.Byte[]" InstanceData="" InstanceDataSize="0" InternalState="2" ProcessingId="" /> <Workflow StatusPageUrl="http://server/_layouts/WrkStat.aspx?List=%7B5F2F1E89%2D06D7%2D44F5%2D886B%2D3EE11FF2D5B3%7D&WorkflowInstanceID=%7B3efde9d9%2Dc8de%2D463b%2D8fe6%2Df13e15419c79%7D" Id="3efde9d9-c8de-463b-8fe6-f13e15419c79" TemplateId="94218b95-47d3-4fa3-8e3f-f44f6d234acd" ListId="5f2f1e89-06d7-44f5-886b-3ee11ff2d5b3" SiteId="4ca76181-d8d6-4535-86c7-2eb7fcf91c0e" WebId="598b4ef0-3ec0-4282-aac9-ed6d114f2b7f" ItemId="6" ItemGUID="7522c63c-a7b4-4bff-bf34-3c274b2d8ea7" TaskListId="4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" AdminTaskListId="" Author="1" Modified="20080206 18:18:13" Created="20080206 18:18:12" StatusVersion="0" Status1="2" Status2="" Status3="" Status4="" Status5="" Status6="" Status7="" Status8="" Status9="" Status10="" TextStatus1="" TextStatus2="" TextStatus3="" TextStatus4="" TextStatus5="" Modifications="<Mods><Mod><SubId>{9A3C5C0B-E44F-433B-9F0D-93D36536D443}</SubId><Id>{27F914AE-3112-493D-86CF-43DC93870418}</Id><Data>&lt;my:DueDate&gt;&lt;/my:DueDate&gt;&lt;my:Description&gt;Please approve Document&lt;/my:Description&gt;</Data></Mod><Mod><SubId>{71C77799-E68F-4502-9B72-867A35E4E920}</SubId><Id>{B21BCC38-2C23-4B64-8E7D-C32C43AD42CF}</Id><Data></Data></Mod><Mod><SubId>{94609536-C610-438C-911F-62B60AF55337}</SubId><Id>{AF71F77B-E6C8-483A-ACBF-30B4A84BD209}</Id><Data>&lt;my:NewReviewers&gt;&lt;/my:NewReviewers&gt;&lt;my:DueDate&gt;&lt;/my:DueDate&gt;&lt;my:Description&gt;Please approve Document&lt;/my:Description&gt;&lt;my:Duration xsi:nil=&quot;true&quot;&gt;&lt;/my:Duration&gt;&lt;my:DurType&gt;0&lt;/my:DurType&gt;&lt;my:GroupTasks&gt;false&lt;/my:GroupTasks&gt;&lt;my:ShowDuration&gt;1&lt;/my:ShowDuration&gt;</Data></Mod></Mods>" ActivityDetails="System.Byte[]" InstanceData="" InstanceDataSize="0" InternalState="2" ProcessingId="" /> <Workflow StatusPageUrl="http://server/_layouts/WrkStat.aspx?List=%7B5F2F1E89%2D06D7%2D44F5%2D886B%2D3EE11FF2D5B3%7D&WorkflowInstanceID=%7Bcc2ec83f%2Dab79%2D4e18%2D85eb%2Df90c72427b21%7D" Id="cc2ec83f-ab79-4e18-85eb-f90c72427b21" TemplateId="b03dba1a-b247-451f-9ea2-117d7e366cdb" ListId="5f2f1e89-06d7-44f5-886b-3ee11ff2d5b3" SiteId="4ca76181-d8d6-4535-86c7-2eb7fcf91c0e" WebId="598b4ef0-3ec0-4282-aac9-ed6d114f2b7f" ItemId="6" ItemGUID="7522c63c-a7b4-4bff-bf34-3c274b2d8ea7" TaskListId="4c620c8d-bfe6-4857-a29e-5b628ebb9ddb" AdminTaskListId="" Author="1" Modified="20080213 22:08:29" Created="20080213 21:58:33" StatusVersion="1" Status1="15" Status2="" Status3="" Status4="" Status5="" Status6="" Status7="" Status8="" Status9="" Status10="" TextStatus1="" TextStatus2="" TextStatus3="" TextStatus4="" TextStatus5="" Modifications="" ActivityDetails="System.Byte[]" InstanceData="" InstanceDataSize="0" InternalState="4" ProcessingId="" /> </Workflows> </ActiveWorkflowsData> <DefaultWorkflows> </DefaultWorkflows> </WorkflowData> </GetWorkflowDataForItemResult> </GetWorkflowDataForItemResponse> </soap:Body> </soap:Envelope>