2.3 GetWorkItemInfo

GET method to get the properties for a work item using the work item identifier.

2.3.1 Request Parameters

Include the following parameters in the request URL as needed.

Parameter	Description
sessionID userName password hostName portNumber	All web service calls require BSL authentication and may optionally identify a Workflow Automation Server. For more information about authentication and identification, see Authentication and Identification.
workItemID	Workflow Automation Work item identifier.

2.3.2 Response Data

The GET response data contains the following elements.

Parameter	Description
WorkItemState	Current work item state. Possible values are Running, Suspended, Completed, Terminated, Terminating, Error, Suspending, or Resuming.
WorkItemStateNative	Numeric value corresponding to the work item state. Possible values are 1, 2, 4, 8, 16, 32, 64, or 128.
Description	Description text.
EndTime	Date and time at which the work item ended. NOTE:Date and time values are returned as UTC. The client program is responsible for converting UTC values to an appropriate locale.
ID	Work item identifier.
InputPendingActivitiesCount	Number of activities in the work item that are in a input pending condition.
ProcessName	Process name.
ProcessRevisionPath	Workflow Automation namespace path to the process revision used to create the work item.
StartTime	Date and time at which the work item started. NOTE:Date and time values are returned as UTC. The client program is responsible for converting UTC values to an appropriate locale.
Subject	Subject text.
TriggerType	Trigger type. Possible values are Triggered or Manual
TriggerTypeNative	Numeric value corresponding to the trigger type. Possible values are 0 or 1.
Type	Type. For example, incident or change.
WorkflowID	Workflow identifier to which work item belongs. NOTE:This parameter is provided for informational purposes.
WorkflowRevisionMajorVersion	Major version number.
WorkflowRevisionMinorVersion	Minor revision number.

Sample XML Response Body

The following is a sample XML reponse body.

<WorkItemInfo xmlns="http://www.attachmate.com/Aegis/">
  <WorkItemState>Running</WorkItemState>
  <WorkItemStateNative>255</WorkItemStateNative>
  <Description>String content</Description>
  <EndTime>1999-05-31T11:20:00</EndTime>
  <ID>4294967295</ID>
  <InputPendingActivitiesCount>4294967295</InputPendingActivitiesCount>
  <ProcessName>String content</ProcessName>
  <ProcessRevisionPath>String content</ProcessRevisionPath>
  <StartTime>1999-05-31T11:20:00</StartTime>
  <Subject>String content</Subject>
  <TriggerType>Triggered</TriggerType>
  <TriggerTypeNative>255</TriggerTypeNative>
  <Type>String content</Type>
  <WorkflowID>String content</WorkflowID>
  <WorkflowRevisionMajorVersion>4294967295</WorkflowRevisionMajorVersion>
  <WorkflowRevisionMinorVersion>4294967295</WorkflowRevisionMinorVersion>
</WorkItemInfo>

Sample Json Response Body

The following is a sample Json response body.

{
  "WorkItemState":0,
  "WorkItemStateNative":255,
  "Description":"String content",
  "EndTime":"\/Date(928167600000-0500)\/",
  "ID":4294967295,
  "InputPendingActivitiesCount":4294967295,
  "ProcessName":"String content",
  "ProcessRevisionPath":"String content",
  "StartTime":"\/Date(928167600000-0500)\/",
  "Subject":"String content",
  "TriggerType":0,
  "TriggerTypeNative":255,
  "Type":"String content",
  "WorkflowID":"String content",
  "WorkflowRevisionMajorVersion":4294967295,
  "WorkflowRevisionMinorVersion":4294967295
}

Response XML Schema

The following is the response XML schema.

<xs:schema xmlns:tns="http://www.attachmate.com/Aegis/" elementFormDefault="qualified" targetNamespace="http://www.attachmate.com/Aegis/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
  <xs:complexType name="WorkItemInfo">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:WorkItemStateInfo">
        <xs:sequence>
          <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="EndTime" type="xs:dateTime" />
          <xs:element minOccurs="0" name="ID" type="xs:unsignedInt" />
          <xs:element minOccurs="0" name="InputPendingActivitiesCount" type="xs:unsignedInt" />
          <xs:element minOccurs="0" name="ProcessName" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="ProcessRevisionPath" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="StartTime" type="xs:dateTime" />
          <xs:element minOccurs="0" name="Subject" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="TriggerType" type="tns:WorkflowTriggerType" />
          <xs:element minOccurs="0" name="TriggerTypeNative" type="xs:unsignedByte" />
          <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="WorkflowID" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="WorkflowRevisionMajorVersion" type="xs:unsignedInt" />
          <xs:element minOccurs="0" name="WorkflowRevisionMinorVersion" type="xs:unsignedInt" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="WorkItemInfo" nillable="true" type="tns:WorkItemInfo" />
  <xs:complexType name="WorkItemStateInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="WorkItemState" type="tns:WorkItemState" />
      <xs:element minOccurs="0" name="WorkItemStateNative" type="xs:unsignedByte" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="WorkItemStateInfo" nillable="true" type="tns:WorkItemStateInfo" />
  <xs:simpleType name="WorkItemState">
    <xs:annotation>
      <xs:appinfo>
        <ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
      </xs:appinfo>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:enumeration value="Running">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Suspended">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Completed">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Terminated">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Terminating">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">16</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Error">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">32</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Suspending">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">64</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Resuming">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">128</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="WorkItemState" nillable="true" type="tns:WorkItemState" />
  <xs:simpleType name="WorkflowTriggerType">
    <xs:annotation>
      <xs:appinfo>
        <ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
      </xs:appinfo>
    </xs:annotation>
    <xs:restriction base="xs:string">
      <xs:enumeration value="Triggered" />
      <xs:enumeration value="Manual" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="WorkflowTriggerType" nillable="true" type="tns:WorkflowTriggerType" />
</xs:schema>

Additional Response XML Schemas

The following is an additional response XML schema.

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

The following is an additional response XML schema.

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>