2.1 GetInProductionProcessRevisionAttributes

POST method to get the attributes for a process revision that is in production. The attributes include the process name, description, and revision information.

2.1.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.

2.1.2 POST Request Data

Include the following element in the POST request data.

Element

Description

Path

REQUIRED. The process revision object path in the Workflow Automation namespace.

HINT:You can get this path from the process display name and the GetProcessPathsFromProcessDisplayName method.

Sample POST XML Request Body

The following is a sample POST XML request body.

<PathInfo xmlns="http://www.attachmate.com/Aegis/">
  <Path>String content</Path>
</PathInfo>

Sample POST Json Request Body

The following is a sample POST Json request body.

{
  "Path":"String content"
}

POST Request XML Schema

The following is the POST request 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:complexType name="PathInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="Path" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="PathInfo" nillable="true" type="tns:PathInfo" />
</xs:schema>

Additional POST Request XML Schemas

The following is an additional POST request 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 POST request 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>

2.1.3 Response Data

The POST response data contains the following elements.

Element

Description

CreationTime

Date and time when the original process was created.

Description

Process description.

HasManualTrigger

If true, the process can be triggered manually.

IsInProduction

If true, the process is in production.

MajorVersion

Process revision major version number.

MinorVersion

Process revision minor version number.

GlobalID

Globally unique process identifier.

ProcessPath

Workflow Automation namespace path for the original process.

RevisionID

Globally unique process revision identifier.

RevisionNumber

Process revision number incrementing from the original process number 1.

RevisionPath

Workflow Automation namespace path for the process revision.

TimeLastModified

Date and time the process revision was last modified.

WorkItemDescription

Work item description.

WorkItemSubject

Work item subject.

WorkItemType

Work item type.

Sample XML Response Body

The following is a sample XML response body.

<ProcessRevisionInfo xmlns="http://www.attachmate.com/Aegis/">
  <CreationTime>1999-05-31T11:20:00</CreationTime>
  <Description>String content</Description>
  <HasManualTrigger>true</HasManualTrigger>
  <IsInProduction>true</IsInProduction>
  <MajorVersion>4294967295</MajorVersion>
  <MinorVersion>4294967295</MinorVersion>
  <ProcessPath>String content</ProcessPath>
  <RevisionID>String content</RevisionID>
  <RevisionNumber>4294967295</RevisionNumber>
  <RevisionPath>String content</RevisionPath>
  <TimeLastModified>1999-05-31T11:20:00</TimeLastModified>
  <WorkItemDescription>String content</WorkItemDescription>
  <WorkItemSubject>String content</WorkItemSubject>
  <WorkItemType>String content</WorkItemType>
</ProcessRevisionInfo>

Sample Json Response Body

The following is a sample Json response body.

{
  "CreationTime":"\/Date(928167600000-0500)\/",
  "Description":"String content",
  "HasManualTrigger":true,
  "IsInProduction":true,
  "MajorVersion":4294967295,
  "MinorVersion":4294967295,
  "ProcessPath":"String content",
  "RevisionID":"String content",
  "RevisionNumber":4294967295,
  "RevisionPath":"String content",
  "TimeLastModified":"\/Date(928167600000-0500)\/",
  "WorkItemDescription":"String content",
  "WorkItemSubject":"String content",
  "WorkItemType":"String content"
}

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:complexType name="ProcessRevisionInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="CreationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="HasManualTrigger" type="xs:boolean" />
      <xs:element minOccurs="0" name="IsInProduction" type="xs:boolean" />
      <xs:element minOccurs="0" name="MajorVersion" type="xs:unsignedInt" />
      <xs:element minOccurs="0" name="MinorVersion" type="xs:unsignedInt" />
      <xs:element minOccurs="0" name="ProcessPath" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="RevisionID" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="RevisionNumber" type="xs:unsignedInt" />
      <xs:element minOccurs="0" name="RevisionPath" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="TimeLastModified" type="xs:dateTime" />
      <xs:element minOccurs="0" name="WorkItemDescription" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="WorkItemSubject" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="WorkItemType" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ProcessRevisionInfo" nillable="true" type="tns:ProcessRevisionInfo" />
</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>