2.7 StartManualWorkflowByMetaData

POST method to pass custom work item attributes to the workflow.

2.7.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.7.2 Request Data

Include the following element in the POST request data as needed.

Element	Description
Path	REQUIRED. File system path to a Workflow Automation process revision.

Sample XML Request Body

The following is a sample XML request body.

<AttributeMetadataInfo xmlns="http://www.attachmate.com/Aegis/">
  <Path>String content</Path>
  <ParameterList>
    <AttributeMetadataValue>
      <Description>String content</Description>
      <DisplayName>String content</DisplayName>
      <HideInUI>true</HideInUI>
      <Name>String content</Name>
      <ReadOnly>true</ReadOnly>
      <Type>String content</Type>
      <!--Valid elements of type: ArrayOfAttributeMetadataValue, ArrayOfstring, AttributeMetadataInfo, AttributeMetadataValue, PathInfo, schema-->
      <Value i:type="ArrayOfAttributeMetadataValue" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <AttributeMetadataValue>
          <Description>String content</Description>
          <DisplayName>String content</DisplayName>
          <HideInUI>true</HideInUI>
          <Name>String content</Name>
          <ReadOnly>true</ReadOnly>
          <Type>String content</Type>
          <!--Valid elements of type: ArrayOfAttributeMetadataValue, ArrayOfstring, AttributeMetadataInfo, AttributeMetadataValue, PathInfo, schema-->
          <Value i:type="ArrayOfAttributeMetadataValue">
            <AttributeMetadataValue i:nil="true" />
            <AttributeMetadataValue i:nil="true" />
          </Value>
        </AttributeMetadataValue>
        <AttributeMetadataValue>
          <Description>String content</Description>
          <DisplayName>String content</DisplayName>
          <HideInUI>true</HideInUI>
          <Name>String content</Name>
          <ReadOnly>true</ReadOnly>
          <Type>String content</Type>
          <!--Valid elements of type: ArrayOfAttributeMetadataValue, ArrayOfstring, AttributeMetadataInfo, AttributeMetadataValue, PathInfo, schema-->
          <Value i:type="ArrayOfAttributeMetadataValue">
            <AttributeMetadataValue i:nil="true" />
            <AttributeMetadataValue i:nil="true" />
          </Value>
        </AttributeMetadataValue>
      </Value>
    </AttributeMetadataValue>
    <AttributeMetadataValue>
      <Description>String content</Description>
      <DisplayName>String content</DisplayName>
      <HideInUI>true</HideInUI>
      <Name>String content</Name>
      <ReadOnly>true</ReadOnly>
      <Type>String content</Type>
      <!--Valid elements of type: ArrayOfAttributeMetadataValue, ArrayOfstring, AttributeMetadataInfo, AttributeMetadataValue, PathInfo, schema-->
      <Value i:type="ArrayOfAttributeMetadataValue" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <AttributeMetadataValue>
          <Description>String content</Description>
          <DisplayName>String content</DisplayName>
          <HideInUI>true</HideInUI>
          <Name>String content</Name>
          <ReadOnly>true</ReadOnly>
          <Type>String content</Type>
          <!--Valid elements of type: ArrayOfAttributeMetadataValue, ArrayOfstring, AttributeMetadataInfo, AttributeMetadataValue, PathInfo, schema-->
          <Value i:type="ArrayOfAttributeMetadataValue">
            <AttributeMetadataValue i:nil="true" />
            <AttributeMetadataValue i:nil="true" />
          </Value>
        </AttributeMetadataValue>
        <AttributeMetadataValue>
          <Description>String content</Description>
          <DisplayName>String content</DisplayName>
          <HideInUI>true</HideInUI>
          <Name>String content</Name>
          <ReadOnly>true</ReadOnly>
          <Type>String content</Type>
          <!--Valid elements of type: ArrayOfAttributeMetadataValue, ArrayOfstring, AttributeMetadataInfo, AttributeMetadataValue, PathInfo, schema-->
          <Value i:type="ArrayOfAttributeMetadataValue">
            <AttributeMetadataValue i:nil="true" />
            <AttributeMetadataValue i:nil="true" />
          </Value>
        </AttributeMetadataValue>
      </Value>
    </AttributeMetadataValue>
  </ParameterList>
</AttributeMetadataInfo>

Sample Json Request Body

The following is a sample Json request body.

{
  "Path":"String content",
  "ParameterList":[{
    "Description":"String content",
    "DisplayName":"String content",
    "HideInUI":true,
    "Name":"String content",
    "ReadOnly":true,
    "Type":"String content",
    "Value":{
      "AttributeMetadataValue":{
        "Description":"String content",
        "DisplayName":"String content",
        "HideInUI":true,
        "Name":"String content",
        "ReadOnly":true,
        "Type":"String content",
        "Value":{
          "AttributeMetadataValue":null
        }
      }
    }
  }]
}

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="AttributeMetadataInfo">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:PathInfo">
        <xs:sequence>
          <xs:element minOccurs="0" name="ParameterList" nillable="true" type="tns:ArrayOfAttributeMetadataValue" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="AttributeMetadataInfo" nillable="true" type="tns:AttributeMetadataInfo" />
  <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:complexType name="ArrayOfAttributeMetadataValue">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="AttributeMetadataValue" nillable="true" type="tns:AttributeMetadataValue" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfAttributeMetadataValue" nillable="true" type="tns:ArrayOfAttributeMetadataValue" />
  <xs:complexType name="AttributeMetadataValue">
    <xs:sequence>
      <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="DisplayName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="HideInUI" type="xs:boolean" />
      <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ReadOnly" type="xs:boolean" />
      <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Value" nillable="true" type="xs:anyType" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="AttributeMetadataValue" nillable="true" type="tns:AttributeMetadataValue" />
</xs:schema>

Additional Request XML Schemas

The following is an additional 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 request XML schema.

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ArrayOfstring">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
</xs:schema>

The following is an additional request XML schema.

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

2.7.3 Response Data

The POST response data contains the following element.

Element	Description
WorkItemID	Workflow Automation work item identifier for the new work item.

Sample XML Response Body

The following is a sample XML response body.

<WorkItemIDInfo xmlns="http://www.attachmate.com/Aegis/">
  <WorkItemID>4294967295</WorkItemID>
</WorkItemIDInfo>

Sample Json Response Body

The following is a sample Json response body.

{
  "WorkItemID":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:complexType name="WorkItemIDInfo">
    <xs:sequence>
      <xs:element minOccurs="0" name="WorkItemID" type="xs:unsignedInt" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="WorkItemIDInfo" nillable="true" type="tns:WorkItemIDInfo" />
</xs:schema>

Additional Response XML Schemas

The following is an additional Xresponse 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.

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