SOAP API - getWorkItemHeader

The table summarizes the SOAP API - getWorkItemHeader.

Request Uses the getWorkItemheader element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item for which information is required.
  • version: (Optional) If it is omitted, the latest version is used.
Response Returns a getWorkItemHeaderResponse element (from the WorkItemManagementService schema)
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.brm.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:getWorkItemHeader>
         <workItemID id="10" version="0"/>
      </api:getWorkItemHeader>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getWorkItemHeaderResponse xmlns="http://api.brm.n2.tibco.com">
         <workItemHeader distributionStrategy="OFFER" priority="50" xmlns="">
            <name>ServicingMgr</name>
            <description>ServicingMgr</description>
            <flags>
               <scheduleStatus>DURING</scheduleStatus>
            </flags>
            <itemContext>
               <activityID>pvm:001i1m</activityID>
               <activityName>ServicingMgr</activityName>
               <appInstance>pvm:0a124</appInstance>
               <appName>AMXSupervisor</appName>
               <appID>_fQ0ZAHClEeCF3qXLa8gNUw</appID>
               <appInstanceDescription>SrvCall</appInstanceDescription>
            </itemContext>
         </workItemHeader>
      </getWorkItemHeaderResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>