Go to primary content
Agile Product Lifecycle Management Web Services Guide
Release 9.3.5
E61173-02
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

A Core Operations - Agile PLM Web Services

This section describes the Agile PLM Core Web Services Operations. Download Agile Web Services Schema Documents from the Oracle Software Delivery Cloud (edelivery.oracle.com) for details of all operations.

A.1 Admin and Metadata Web Services

This topic describes the admin and metadata Web Services.

A.1.1 getAllClasses

Service

To retrieve all Agile classes from Agile PLM system.

Usage

Specifies class filtering details in the request object. A list of Agile classes retrieved according to the filter is obtained in the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAllClasses xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <level>ALL</level>
            </request>
         </getAllClasses>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAllClassesResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <class>
                  <nodeId>931</nodeId>
                  <apiName>ChangesBaseClass</apiName>
                  typeCLASS</type>
                  <displayName>Changes</displayName>
                  <abstractClass>true</abstractClass>
                  <subClass>
                     <nodeId>1450</nodeId>
                     <apiName>ManufacturerOrdersClass</apiName>
                     typeSUBCLASS</type>
                     <displayName>Manufacturer Orders</displayName>
                  </subClass>
                  <subClass>
                     <nodeId>6000</nodeId>
                     <apiName>ChangeOrdersClass</apiName>
                     typeSUBCLASS</type>
                     <displayName>Change Orders</displayName>
                  </subClass>
               </class>
                 ...  <!-- additional classes -->
            </response>
         </getAllClassesResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.2 getSubClasses

Service

To retrieve all Agile subclasses for a given base class from the Agile PLM system.

Usage

The request object contains relevant details for the same. A list of Agile subclasses are obtained in the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSubClasses xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <subClassesRequest>
                  <classIdentifier>Changes</classIdentifier>
               </subClassesRequest>
               <subClassesRequest>
                  <classIdentifier>Items</classIdentifier>
               </subClassesRequest>
            </request>
         </getSubClasses>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSubClassesResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <subClassesResponse>
                  <classIdentifier>Changes</classIdentifier>
                  <classes>
                     <nodeId>1450</nodeId>
                     <apiName>ManufacturerOrdersClass</apiName>
                     typeSUBCLASS</type>
                     <displayName>Manufacturer Orders</displayName>
                     <abstractClass>true</abstractClass>
                     <superClass>
                        <nodeId>931</nodeId>
                        <apiName>ChangesBaseClass</apiName>
                        typeCLASS</type>
                        <displayName>Changes</displayName>
                     </superClass>
                  </classes>
                  <classes>
                     <nodeId>6000</nodeId>
                     <apiName>ChangeOrdersClass</apiName>
                     typeSUBCLASS</type>
                     <displayName>Change Orders</displayName>
                     <abstractClass>true</abstractClass>
                     <superClass>
                        <nodeId>931</nodeId>
                        <apiName>ChangesBaseClass</apiName>
                        typeCLASS</type>
                        <displayName>Changes</displayName>
                     </superClass>
                  </classes>
               </subClassesResponse>
            </response>
         </getSubClassesResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.3 getNode

Service

To retrieve Agile nodes for a given node identifier.

Usage

The request object contains details and the queried node is obtained in the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getNode xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <nodeRequest>
                  <nodeIdentifier>5009</nodeIdentifier>
                  <recursive>true</recursive>
               </nodeRequest>
            </request>
         </getNode>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getNodeResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <nodeResponse>
                  <node>
                     <nodeId>5009</nodeId>
                     <apiName>AutoNumbers</apiName>
                     typeNODE</type>
                     <displayName>AutoNumbers</displayName>
                     <childNode>
                        <nodeId>990</nodeId>
                        <apiName>ECONumber</apiName>
                        typeNODE</type>
                        <displayName>ECO Number</displayName>
                        <Properties>
                           <propertyId>30</propertyId>
                           <apiName>Name</apiName>
                           <displayName>Name</displayName>
                           <readOnly>false</readOnly>
                           <Name xsi:type="xs:string"       
                             xmlns:xs="http://www.w3.org/2001/XMLSchema">ECO Number</Name>
                        </Properties>
                        <Properties>
                           <propertyId>38</propertyId>
                           <apiName>Description</apiName>
                           <displayName>Description</displayName>
                           <readOnly>false</readOnly>
                           <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">ECO Number</Description>
                        </Properties>
                     </childNode>
                  </node>
               </nodeResponse>
            </response>
         </getNodeResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.4 getLists

Service

To retrieve Agile Lists for a given List Identifier.

Usage

The request object contains relevant details for the same. The retrieved lists are obtained in the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getLists xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <listsRequest>
                  <listIdentifier>PartCategory</listIdentifier>
               </listsRequest>
            </request>
         </getLists>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getListsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <listsResponse>
                  <list>
                     <id>311</id>
                     <apiName>PartCategory</apiName>
                     <displayName>Part Category</displayName>
                     typeSIMPLELIST</type>
                     <value xsi:nil="true"/>
                     <entry>
                        <id>2</id>
                        <apiName>ELECTRICAL</apiName>
                        typeSIMPLELIST</type>
                        <value>Electrical</value>
                     </entry>
                     <entry>
                        <id>1</id>
                        <apiName>MECHANICAL</apiName>
                        typeSIMPLELIST</type>
                        <value>Mechanical</value>
                     </entry>
                  </list>
                  <listIdentifier>311</listIdentifier>
               </listsResponse>
            </response>
         </getListsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getNode, getTableMetadata, getAttributes

A.1.5 getAttributes

Service

To retrieve Agile attributes for a particular Class and Attribute Identifier.

Usage

The request object contains relevant details for the same. The retrieved list attributes are obtained in the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAttributes xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <attributesRequests>
                  <classIdentifier>Specification</classIdentifier>
                  <attributeIdentifier>description</attributeIdentifier>
               </attributesRequests>
            </request>
         </getAttributes>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAttributesResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <attributesResponses>
                  <attributes>
                     <nodeId>2000001968</nodeId>
                     <apiName>description</apiName>
                     typeATTRIBUTE</type>
                     <displayName>Description</displayName>
                     <dataType>2</dataType>
                     <searchable>true</searchable>
                     <visible>true</visible>
                     <required>false</required>
                     <maxLength>100</maxLength>
                     <properties>
                        <propertyId>1</propertyId>
                        <apiName>AttType</apiName>
                        <displayName>AttType</displayName>
                        <readOnly>false</readOnly>
                        <AttType xsi:type="xs:string"
                             xmlns:xs="http://www.w3.org/2001/XMLSchema"></AttType>
                     </properties>
                     <properties>
                        <propertyId>3</propertyId>
                        <apiName>Max System Length</apiName>
                        <displayName>Max System Length</displayName>
                        <readOnly>true</readOnly>
                        <MaxSystemLength xsi:type="xs:string"
                             xmlns:xs="http://www.w3.org/2001/XMLSchema">500</MaxSystemLength>
                     </properties>
                     <relationalOperators>EQ</relationalOperators>
                     <relationalOperators>NEQ</relationalOperators>
                     <relationalOperators>ISNULL</relationalOperators>
                     <relationalOperators>ISNOTNULL</relationalOperators>
                     <relationalOperators>LIKE</relationalOperators>
                     <relationalOperators>NOTLIKE</relationalOperators>
                     <relationalOperators>STARTSWITH</relationalOperators>
                     <relationalOperators>NOTSTARTSWITH</relationalOperators>
                     <relationalOperators>CONTAINS</relationalOperators>
                     <relationalOperators>NOTCONTAINS</relationalOperators>
                  </attributes>
                  <classIdentifier>Specification</classIdentifier>
               </attributesResponses>
            </response>
         </getAttributesResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getLists, getNode, getTableMetadata

A.1.6 getTableMetadata

Service

To retrieve the metadata information of an Agile table in the PLM system.

Usage

The request object contains classIdentifier and tableIdentifier. The request is also to return the metadata for all classes needed for EC in one call (Design, Documents, Parts and Changes) and localized field names. The table metadata information retrieved is obtained through the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getTableMetadata xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <tableIdentifier>807</tableIdentifier>
               </requests>
               <requests>
                  <classIdentifier>ECO</classIdentifier>
                  <tableIdentifier>808</tableIdentifier>
               </requests>
            </request>
         </getTableMetadata>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getTableMetadataResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <attributes>
                     <nodeId>3669</nodeId>
                     <apiName>list19</apiName>
                     typeATTRIBUTE</type>
                     <displayName>List19</displayName>
                     <dataType>4</dataType>
                     <possibleValues>
                        <id xsi:nil="true"/>
                        <apiName>list19</apiName>
                        <displayName>List19</displayName>
                        typeSIMPLELIST</type>
                        <value xsi:nil="true"/>
                     </possibleValues>
                     <searchable>true</searchable>
                     <visible>false</visible>
                     <required>false</required>
                     <maxLength>2147483647</maxLength>
                     <properties>
                        <propertyId>1</propertyId>
                        <apiName>AttType</apiName>
                        <displayName>AttType</displayName>
                        <readOnly>false</readOnly>
                        <AttType xsi:type="xs:string"
                       xmlns:xs="http://www.w3.org/2001/XMLSchema"></AttType>
                     </properties>
                     <properties>
                        <propertyId>5</propertyId>
                        <apiName>DefaultValue</apiName>
                        <displayName>DefaultValue</displayName>
                        <readOnly>false</readOnly>
                        <DefaultValue xsi:type="common:AgileListEntryType"
                       xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"/>
                     </properties>
               </responses>
              </response>
         </getTableMetadataResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getAttributes

A.1.7 getAutoNumbers

Service

To retrieve a suitable AutoNumber for an Agile object.

Usage

The request object contains the Class and AutoNumber identifiers of the object. The AutoNumber for the object fetched by the Web Service is obtained through the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAutoNumbers xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <includeAllAutoNumberSource>true</includeAllAutoNumberSource>
                  <size>3</size>
               </requests>
               <requests>
                  <classIdentifier>ECO</classIdentifier>
                  <includeAllAutoNumberSource>true</includeAllAutoNumberSource>
                  <size>2</size>
               </requests>
            </request>
         </getAutoNumbers>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAutoNumbersResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <autoNumberResponses>
                  <classIdentifier>Part</classIdentifier>
                  <autoNumbers>
                     <nodeId>12416</nodeId>
                     <apiName>PartNumber</apiName>
                     typeAUTONUMBER</type>
                     <displayName>Part Number</displayName>
                     <autoNumber>P00580</autoNumber>
                     <autoNumber>P00581</autoNumber>
                     <autoNumber>P00582</autoNumber>
                  </autoNumbers>
               </autoNumberResponses>
               <autoNumberResponses>
                  <classIdentifier>ECO</classIdentifier>
                  <autoNumbers>
                     <nodeId>990</nodeId>
                     <apiName>ECONumber</apiName>
                     typeAUTONUMBER</type>
                     <displayName>ECO Number</displayName>
                     <autoNumber>C00186</autoNumber>
                     <autoNumber>C00187</autoNumber>
                  </autoNumbers>
               </autoNumberResponses>
            </response>
         </getAutoNumbersResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getAllClasses, getSubClasses

A.1.8 getUsers

Service

To retrieve the information of Agile PLM Users.

Usage

Obtains a list of users through the response object of the Web Service. The request object does not contain any element while the response consists of AgileUserType objects, which contain message elements carrying information pertaining to an Agile user.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getUsers xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns=""/>
         </getUsers>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getUsersResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <users>
                  <objectIdentifier>
                     <classId>11610</classId>
                     <className>User</className>
                     <classDisplayName>User</classDisplayName>
                     <objectId>704</objectId>
                     <objectName>admin</objectName>
                  </objectIdentifier>
                  <userID xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11617" readOnly="False">admin</userID>
                  <status xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="12643" readOnly="True">
                     <selection>
                        <id>1</id>
                        <apiName>ACTIVE</apiName>
                        <value>Active</value>
                     </selection>
                  </status>
                  <firstName xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11614" readOnly="False">admin</firstName>
                  <lastName xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11616" readOnly="False">Administrator</lastName>
                  <title xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="12235" readOnly="False"></title>
                  <address xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11625" readOnly="False"></address>
                  <geography xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="8840" readOnly="False"/>
                  <city xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11626" readOnly="False"></city>
                  <postalZipCode xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11629" readOnly="False"></postalZipCode>
                  <businessPhone xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11619" readOnly="False"></businessPhone>
                  <homePhone xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11620" readOnly="False"></homePhone>
                  <mobilePhone xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11621" readOnly="False"></mobilePhone>
                  <fax xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11622" readOnly="False"></fax>
                  <pager xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11623" readOnly="False"></pager>
                  <email xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="11624" readOnly="False">admin@admin.com</email>
                  <secondaryEmail xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="12350" readOnly="False"></secondaryEmail>
                  <profile xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="8815" readOnly="True"></profile>
                  <roleS xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="11640" readOnly="False">
               </users>
         </getUsersResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getUserGroups

A.1.9 getUserGroups

Service

To retrieve the information of Users Groups in Agile PLM.

Usage

Obtains a list of user groups obtained through the response object of the Web Service. The request does not contain any element while the response consists of AgileUserGroupType objects, which carry message elements that contain information pertaining to an Agile user group.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getUserGroups xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns=""/>
         </getUserGroups>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getUserGroupsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </getUserGroupsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getUsers

A.1.10 convertCurrency

Service

To convert a certain denomination and amount of money to a desired currency.

Usage

Converts a currency from one type to another given a certain date. The money is expressed as an object of type AgileMoneyType. The converted currency is obtained through the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <convertCurrency xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <money>
                     <amount>100.0</amount>
                     <currency>INR</currency>
                  </money>
                  <toCurrency>GBP</toCurrency>
                  <date>2009-05-05T13:37:35.555Z</date>
               </requests>
            </request>
         </convertCurrency>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <convertCurrencyResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <money>
                     <amount>1.4843087362171332</amount>
                     <currency>GBP</currency>
                  </money>
                  <date>2009-05-05T13:37:35.555Z</date>
               </responses>
            </response>
         </convertCurrencyResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.11 changeLoginPassword

Service

To change the login password for an Agile user.

Usage

User identifier and new password information is supplied in the request. The details of the users whose passwords are to be changed, and the new passwords are specified in an array of requests. If the current user's password is to be reset then the old password must also be specified.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <changeLoginPassword xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <userIdentifier>yvonnec</userIdentifier>
                  <oldPassword>agile1</oldPassword>
                  <newPassword>agile</newPassword>
               </requests>
            </request>
         </changeLoginPassword>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <changeLoginPasswordResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </changeLoginPasswordResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.12 changeApprovalPassword

Service

To change the approval password for an Agile user.

Usage

User identifier and new password information is supplied in the request. The details of the users whose approval password is to be changed, along with their old and new passwords are specified in an array of requests. If the current user's approval password is to be reset then the old approval password must also be specified.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <changeApprovalPassword xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <userIdentifier>approval1</userIdentifier>
                  <oldPassword>agile1</oldPassword>
                  <newPassword>agile2</newPassword>
               </requests>
            </request>
         </changeApprovalPassword>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <changeApprovalPasswordResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </changeApprovalPasswordResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.13 createTransferAuthority

Service

To create a transfer authority record from an Agile user to another.

Usage

The request contains information about the user from whom the authority is transferred and the user to whom the authority will be granted, the dates from and up to which the transfer is effective and the criteria identifying the authority to be transferred.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createTransferAuthority xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <transferAuthorityRecord>
                     <fromUser>yvonnec</fromUser>
                     <toUser>admin</toUser>
                     <fromDate>2010-08-24T13:26:40.654Z</fromDate>
                     <toDate>2010-09-23T13:26:40.654Z</toDate>
                     <criteria>AllChanges</criteria>
                     <affectChanges>1</affectChanges>
                  </transferAuthorityRecord>
               </requests>
            </request>
         </createTransferAuthority>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createTransferAuthorityResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </createTransferAuthorityResponse>
      </soapenv:Body>
   </soapenv:Envelope>


A.1.14 getTransferAuthority

Service

To retrieve a transfer authority record from the transfer authority record manager.

Usage

A criteria identifying the authority to be retrieved is specified in the request. The request object does not contain any input element. All the transfer authority records found in the transfer authority manager are retrieved.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getTransferAuthority xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <all>true</all>
            </request>
         </getTransferAuthority>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getTransferAuthorityResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <transferAuthorityRecords>
                  <transferRecordId>6099243</transferRecordId>
                  <creator>admin</creator>
                  <fromUser>yvonnec</fromUser>
                  <toUser>admin</toUser>
                  <fromDate>2010-06-01T11:45:49.000Z</fromDate>
                  <toDate>2010-07-01T11:45:48.000Z</toDate>
                  <criteria>AllChanges</criteria>
                  <affectedChanges>1</affectedChanges>
                  <lastChangeUser>admin</lastChangeUser>
               </transferAuthorityRecords>
               <transferAuthorityRecords>
                  <transferRecordId>6099242</transferRecordId>
                  <creator>admin</creator>
                  <fromUser>yvonnec</fromUser>
                  <toUser>admin</toUser>
                  <fromDate>2010-06-01T11:38:13.000Z</fromDate>
                  <toDate>2010-07-01T11:38:08.000Z</toDate>
                  <criteria>AllChanges</criteria>
                  <affectedChanges>1</affectedChanges>
                  <lastChangeUser>admin</lastChangeUser>
               </transferAuthorityRecords>
            </response>
         </getTransferAuthorityResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.15 modifyTransferAuthority

Service

To retrieve the transfer authority record from the transfer authority record manager..

Usage

A criteria identifying the authority to be retrieved is specified in the request. The request object does not contain any input element. All the transfer authority records found in the transfer authority manager are retrieved.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <ModifyTransferAuthority xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <transferAuthorityID>6103630</transferAuthorityID>
                  <transferAuthorityRecord>
                     <fromUser>yvonnec</fromUser>
                     <toUser>admin</toUser>
                     <fromDate>2012-05-11T18:30:00.000Z</fromDate>
                     <toDate>2012-06-10T18:30:00.000Z</toDate>
                     <criteria>AllChanges</criteria>
                     <affectChanges>0</affectChanges>
                  </transferAuthorityRecord>
               </requests>
            </request>
         </ModifyTransferAuthority>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <ModifyTransferAuthorityResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </ModifyTransferAuthorityResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.16 removeTransferAuthority

Service

To remove a transfer authority record from the transfer authority record manager.

Usage

A criteria identifying the authority to be retrieved is specified in the request. It contains an array of requests to support batch operations. The transfer authorities that are to be removed are specified in these requests.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeTransferAuthority xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <transferRecordId>6099247</transferRecordId>
               </requests>
            </request>
         </removeTransferAuthority>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeTransferAuthorityResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </removeTransferAuthorityResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.1.17 getAgileClass

Service

To retrieve Agile classes from the PLM system.

Usage

Specifies the details of the subclasses to be retrieved. It contains an array of requests named AgileGetClassRequestType to support the batch operations. A ClassType with the details of the Agile class is obtained in the response.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAgileClass xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>PartsClass</classIdentifier>
               </requests>
            </request>
         </getAgileClass>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getAgileClassResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/AdminMetadata/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <agileClass>
                     <nodeId>10141</nodeId>
                     <apiName>Part</apiName>
                     typeSUBCLASS</type>
                     <displayName>Part</displayName>
                     <abstractClass>false</abstractClass>
                     <superClass>
                        <nodeId>10000</nodeId>
                        <apiName>PartsClass</apiName>
                        typeCLASS</type>
                        <displayName>Parts</displayName>
                     </superClass>
                  </agileClass>
               </responses>
            </response>
         </getAgileClassResponse>
      </soapenv:Body>
   </soapenv:Envelope>




A.2 Attachment Web Services

This section describes the web services operations available for Attachment Web Services.

A.2.1 getFileAttachment

Service

To retrieve a specific file from the Attachments Tab of a particular Agile object.

Usage

Contains the specifications that identify the attachment to be downloaded. The response object provides comprehensive information about the file retrieved.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getFileAttachment xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00734</objectNumber>
                  <allFiles>false</allFiles>
                  <downloadUrl>true</downloadUrl>
                  <attachments>
                     <rowId>6112830</rowId>
                  </attachments>
               </requests>
            </request>
         </getFileAttachment>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getFileAttachmentResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00734</objectNumber>
                  <attachment>
                     <rowId>6112830</rowId>
                     <fileId>6112635</fileId>
                     <name>P00734_file123.txt</name>
                     <description>Description for file 1</description>
                     <fileType>txt</fileType>
                     <fileSize>19</fileSize>
                     <fileDownloadURL>http://DTP-VSREEDHA-WF:8877/webfs/DownloadServlet?token=D6A8C1A41AA40B5AE29A2CFD33D0BEE143E7ABBBC0024567A16EBD62A195193C8FE6B3FBCC3131B58BC18A774412F759D648C6D0EC5D579A9E0B660217EA744A24220B54E0583A1C569F6E9722B6&amp;vault=&amp;fileID=3DB9227A1EFF6DC2EB</fileDownloadURL>
                  </attachment>
               </responses>
            </response>
         </getFileAttachmentResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.2 addFileAttachment

Service

To add a new file to the Attachment Tab of an Agile Object.

Usage

Specifies relevant details of the new file through the request object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addFileAttachment xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00720</objectNumber>
                  <singleFolder>false</singleFolder>
                  <attachments>
                     <name>Filename.txt</name>
                     <description>Description for file </description>
                     <content>RmlsZSBDb250ZW50Li4uZmlsZQ==</content>
                  </attachments>
               </requests>
            </request>
         </addFileAttachment>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addFileAttachmentResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00720</objectNumber>
               </responses>
            </response>
         </addFileAttachmentResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.3 checkOutAttachment

Service

To check out a specific file from the Attachment Tab of an Agile object and to retrieve its contents.

Usage

Specifies the object and file to be retrieved while the desired content is received through the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkOutAttachment xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00726</objectNumber>
                  <attachments>
                     <rowId>6112534</rowId>
                  </attachments>
               </requests>
            </request>
         </checkOutAttachment>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkOutAttachmentResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00726</objectNumber>
                  <files>
                     <rowId>6112534</rowId>
                     <fileId>6112352</fileId>
                     <fileType>txt</fileType>
                     <fileSize>19</fileSize>
                     <name>null_File123.txt</name>
                     <description>Description for file 1</description>
                     <content>RmlsZSBDb250ZW50Li4uZmlsZQ==</content>
                  </files>
               </responses>
            </response>
         </checkOutAttachmentResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.4 checkInAttachment

Service

To check-in an attachment that was previously checked out.

Usage

This attachment could be modified after checking out and must be checked in back to the Agile system. Details of the modified file and its content, and the parent object, are specified in the request object. Note that the filename of the file you are checking in must have the same extension as that of the file that you are checking out.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkInAttachment xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <request>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00724</objectNumber>
                  <rowId>6112462</rowId>
                  <attachments>
                     <fileName>Modified_P00724_File123.txt</fileName>
                     <fileContent>TW9kaWZpZWQgZmlsZSBpbmZvcm1hdGlvbiBhZGRlZCBhZnRlciB0aGUgY2hlY2tpbg==</fileContent>
                  </attachments>
               </request>
            </request>
         </checkInAttachment>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkInAttachmentResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </checkInAttachmentResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.5 getFileFF

Service

To retrieve a list of files from a specific Agile file folder object.

Usage

Contains the specifications that identify the file to be downloaded. The response object provides comprehensive information about the files retrieved, including content, file type, size, and row identifiers.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getFileFF xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <folderNumber>FOLDER00232</folderNumber>
                  <folderVersion xsi:nil="true"/>
                  <files>
                     <rowId>6112773</rowId>
                  </files>
               </requests>
            </request>
         </getFileFF>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getFileFFResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folderNumber>FOLDER00232</folderNumber>
                  <folderVersion xsi:nil="true"/>
                  <files>
                     <rowId>6112773</rowId>
                     <fileId>6112630</fileId>
                     <name>FOLDER00232_File123.txt</name>
                     <description>Description for file 1</description>
                     <fileType>txt</fileType>
                     <fileSize>19</fileSize>
                     <content>RmlsZSBDb250ZW50Li4uZmlsZQ==</content>
                  </files>
               </responses>
            </response>
         </getFileFFResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.6 addFileFF

Service

To add a new file to the Files Tab of an Agile File Folder object.

Usage

Specifies details of the file folder that was previously checked out to facilitate the add file process. Before adding a new file to a folder, the folder object must be checked out.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addFileFF xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <request>
                  <folderNumber>FOLDER00220</folderNumber>
                  <files>
                     <fileName>File_FOLDER00220.txt</fileName>
                     <fileContent>RmlsZSBDb250ZW50Li4uZmlsZQ==</fileContent>
                     <description>Description for file 1</description>
                  </files>
               </request>
            </request>
         </addFileFF>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addFileFFResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </addFileFFResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.7 checkOutFF

Service

To check-out an Agile File Folder object.

Usage

Specifies the file folder that has to be checked out. Subsequent operations such as adding a file to this file folder and then checking in the folder back are possible after this step. Before adding a new file to a folder, the folder object must be checked out before any file operation uses the checkout Web Service.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkOutFF xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <folderNumber>FOLDER00214</folderNumber>
               </requests>
            </request>
         </checkOutFF>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkOutFFResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folderNumber>FOLDER00214</folderNumber>
               </responses>
            </response>
         </checkOutFFResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.2.8 checkInFF

Service

To check-in an Agile File Folder Object.

Usage

Specifies the file folder that is checked out and one that must be checked in by the Web Service operation.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkInFF xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <folderNumber>FOLDER00220</folderNumber>
               </requests>
            </request>
         </checkInFF>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkInFFResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folderNumber>FOLDER00220</folderNumber>
               </responses>
            </response>
         </checkInFFResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: checkOutFF

A.2.9 cancelCheckOutFF

Service

To cancel the 'checked-out' status of an Agile File Folder object that was earlier checked out using the checkout operation.

Usage

Specifies the file folder for which the 'checked-out' status is to be annulled.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <cancelCheckOutFF xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <folderNumber>FOLDER00217</folderNumber>
               </requests>
            </request>
         </cancelCheckOutFF>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <cancelCheckOutFFResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folderNumber>FOLDER00217</folderNumber>
               </responses>
            </response>
         </cancelCheckOutFFResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: checkOutFF

A.2.10 checkInAF

Service

To check in an Affected File Folder that is with a DFCO Change.

Usage

Specifies the file folder which has already been checked out and needs to be checked in by the web service operation. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
  <soapenv:Header/>
  <soapenv:Body> 
   <v1:checkInAF>
        <request>
           <requests>
             <changeNumber>DFCO00013</changeNumber>
             <folderNumber>FOLDER00136</folderNumber>
             <rowId>6116894</rowId>
             <replaceFile>
               <fileName>Modified_FOLDER00136.txt</fileName>
<fileContent>TW9kaWZpZWQgZmlsZSBpbmZvcm1hdGlvbiBhZGRlZCBhZnRlciB0aGUgY2hlY2tpbg==</fileContent>
             </replaceFile>
          </requests>
         </request>
       </v1:checkInAF>
     </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:checkInAFResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <messageId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <messageName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            </responses>
         </response>
      </ns0:checkInAFResponse>
   </S:Body>
</S:Envelope>

A.2.11 checkOutAF

Service

To checkout out an Affected File Folder that was with a DFCO Change.

Usage

The request object specifies the file folder that has to be checked out and the success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:checkOutAF>
         <request>
                <requests>
               <!--Optional:-->
             <changeNumber>DFCO00013</changeNumber>
             <folderNumber>FOLDER00136</folderNumber>
          </requests>
       </request>
     </v1:checkOutAF>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:checkOutAFResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <statusCode>SUCCESS</statusCode>
         </response>
      </ns0:checkOutAFResponse>
   </S:Body>
</S:Envelope>

A.2.12 cancelCheckOutAF

Service

To cancel the 'checkout-out' status of an Affected File Folder that was with a DFCO Change.

Usage

The request object specifies the file folder of the 'checked-out' status.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Header/>
      <v1:cancelCheckOutAF>
         <request>
            <requests>
               <changeNumber>DFCO00013</changeNumber>
               <folderNumber>FOLDER00136</folderNumber>
            </requests>
         </request>
      </v1:cancelCheckOutAF>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:cancelCheckOutAFResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <statusCode>SUCCESS</statusCode>
         </response>
      </ns0:cancelCheckOutAFResponse>
   </S:Body>
</S:Envelope>

A.2.13 setIncorporate AF

Service

Used to set Incorporate/UnIncorporate status for an Affected File that was with a DFCO Change. Details of the updated affected file and its content and the parent object are specified in the request object. Success of the operation may be verified using the status code in the response object.

To set Incorporate/UnIncorporate status for an Affected File that was with a DFCO Change.

Usage

Details of the updated affected file and its content and the parent object are specified in the request object. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:setIncorporateAF>
         <request>
            <!--1 or more repetitions:-->
            <requests>
               <folderNumber>FOLDER00016</folderNumber>
               <!--Optional:-->
               <changeNumber>DFCO00016</changeNumber>
               <incorporate>true</incorporate> 
            </requests>
         </request>
      </v1:setIncorporateAF>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:setIncorporateAFResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <messageId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <messageName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <statusCode>SUCCESS</statusCode>
           </responses>
             <messageId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
             <messageName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
           </responses>
        </response>
     </ns0:setIncorporateAFResponse>
   </S:Body>
</S:Envelope>

A.2.14 addMarkupRow

Service

To add markup file to an Affected File Row that was with a DFCO Change.

Usage

Details of the added markup file and its content and selected affected file are specified in the request object. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:addMarkupRow>
         <request> 
            <requests>
               <folderNumber>FOLDER00136</folderNumber>
               <changeNumber>DFCO00013</changeNumber>
               <rowId>6116894</rowId>
               <markupfile>
                  <fileName>Sample.mkd</fileName>
<fileContent>TW9kaWZpZWQgZmlsZSBpbmZvcm1hdGlvbiBhZGRlZCBhZnRlciB0aGUgY2hlY2tpbg==</fileContent>
               </markupfile>
            </requests>
         </request>
      </v1:addMarkupRow>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:addMarkupRowResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <statusCode>SUCCESS</statusCode>
         </response>
      </ns0:addMarkupRowResponse>
   </S:Body>
</S:Envelope>

A.2.15 removeMarkupRow

Service

To remove markup row from the Markup Table of an Affected File Row. Details of the added markup file and its content and selected affected file are specified in the request object.

Usage

Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:removeMarkupRow>
         <request>
            <requests>
               <folderNumber>FOLDER00136</folderNumber>
               <changeNumber>DFCO00013</changeNumber>
               <afRowId>6116894</afRowId>
               <markupRowId>6116895</markupRowId>
            </requests>
         </request>
      </v1:removeMarkupRow>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:removeMarkupRowResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <statusCode>SUCCESS</statusCode>
         </response>
      </ns0:removeMarkupRowResponse>
   </S:Body>
</S:Envelope>

A.2.16 updateMarkupRow

Service

To update markup file row of an Affected File. Details of the updated markup file and its content and selected affected file are specified in the request object.

Usage

Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:updateMarkupRow>
         <request>
            <requests>
               <folderNumber>FOLDER00136</folderNumber>
               <changeNumber>DFCO00013</changeNumber>
               <afRowId>6116894</afRowId>
               <markupRowId>6116896</markupRowId>
               <options>
                  <propertyName>markupDescription</propertyName>
                  <propertyValue>Description for markup</propertyValue>
               </options>
           </requests>
         </request>
      </v1:updateMarkupRow>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <response>
            <statusCode>SUCCESS</statusCode>
         </response>
      </ns0:updateMarkupRowResponse>
   </S:Body>
</S:Envelope>

A.2.17 loadMarkupTable

Service

To load the content of an existing Agile Table object using relevant information that identifies the table to be retrieved and the information to be obtained from it.

Usage

The request object is built using information from the same. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:loadMarkupTable>
         <request>
            <requests>
               <changeNumber>DFCO00013</changeNumber>
               <afRowId>6116894</afRowId>
            </requests>
         </request>
      </v1:loadMarkupTable>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:loadMarkupTableResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
         <response>
            <statusCode>SUCCESS</statusCode>
            <tableContents>
               <tableIdentifier xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <row rowId="6116895">
                  <objectReferentId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <additionalRowInfo xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <name attributeId="2000025873" readOnly="False" xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sample.mkd</name>
                  <number attributeId="2000025874" readOnly="True" xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">MARKUP00008</number>
                  <markupDescription attributeId="2000025875" readOnly="False" xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <folderVersion attributeId="2000025876" readOnly="True" xsi:type="xs:integer" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2</folderVersion>
                  <redlineProcess attributeId="2000025877" readOnly="True" xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">DFCO00013</redlineProcess>
                  <redlineUser attributeId="2000025878" readOnly="True" xsi:type="common:AgileListEntryType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                     <listName xsi:nil="true"/>
                     <selection>
                       <id>704</id>
                       <apiName xsi:nil="true"/>
                       <value>Administrator, a (admin)</value>
                     </selection>
                  </redlineUser>
                  <lastModifiedDate attributeId="2000025879" readOnly="True" xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2015-12-18T10:30:08.000Z</lastModifiedDate>
                  <filesize attributeId="2000025880" readOnly="True" xsi:type="xs:double" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">49.0</filesize>
                  <fileType attributeId="2000025881" readOnly="True" xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">mkd</fileType>
                  <createDate attributeId="2000025883" readOnly="True" xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2015-12-18T10:30:08.000Z</createDate>
                  <fileName attributeId="2000026261" readOnly="True" xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">fullLog.txt</fileName>
               </row>
            </tableContents>
         </response>
      </ns0:loadMarkupTableResponse>
   </S:Body>
</S:Envelope>

A.3 Core Web Services Operations

This chapter describes the elements of Agile CNM Projects Web Services, and provides sample code snippets.

For related information on working with CNM Objects, refer to Agile PLM Customer Needs Management User and Administration Guide.

A.3.1 createObject

Service

To create a specific object in Agile PLM system.

Usage

Specifies detailed object specifications in the request object where the class type, unique object number and other primary data are configured, apart from more specific options.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <data rowId="0">
                     <number>P00585</number>
                     <description>Object Desc</description>
                  </data>
               </requests>
            </request>
         </createObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <agileObject>
                     <objectIdentifier>
                        <classId>10141</classId>
                        <className>Part</className>
                        <classDisplayName>Part</classDisplayName>
                        <objectId>6110466</objectId>
                        <objectName>P00585</objectName>
                     </objectIdentifier>
                     <number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1001" readOnly="False">P00585</number>
                     <itemType xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1081" readOnly="False">
                        <selection>
                           <id>10141</id>
                           <apiName>PART</apiName>
                           <value>Part</value>
                        </selection>
                     </itemType>
                     <lifecyclePhase xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1084" readOnly="True">
                        <selection>
                           <id>976</id>
                           <apiName>PRELIMINARY</apiName>
                           <value>Preliminary</value>
                        </selection>
                     </lifecyclePhase>
                     <description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1002" readOnly="False">Object Desc</description>
                     <itemCategory xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1082" readOnly="False"/>
                     <size xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1068" readOnly="False"/>
                     <productLineS xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1004" readOnly="False"/>
                     <rev xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1014" readOnly="False">
                        <selection>
                           <id>0</id>
                           <apiName>Rev</apiName>
                           <value>Introductory</value>
                        </selection>
                     </rev>
                     <revIncorpDate xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1017" readOnly="True"/>
                     <revReleaseDate xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1016" readOnly="True"/>
                     <effectivityDate xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="12089" readOnly="True"/>
                     <shippableItem xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000002781" readOnly="False">
                        <selection>
                           <id>0</id>
                           <apiName>NO</apiName>
                           <value>No</value>
                        </selection>
                     </shippableItem>
                     <excludeFromRollup xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000002859" readOnly="False">
                        <selection>
                           <id>0</id>
                           <apiName>NO</apiName>
                           <value>No</value>
                        </selection>
                     </excludeFromRollup>
                     <complianceCalculatedDate xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2000004143" readOnly="True"/>
                     <partFamily xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000004416" readOnly="False"/>
                     <mass xsi:type="common:AgileUnitOfMeasureType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000004612" readOnly="False"/>
                     <overallCompliance xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000004891" readOnly="True"/>
                     <itemGroupS xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000008520" readOnly="True"/>
                     <thumbnail xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000008549" readOnly="True"/>
                  </agileObject>
               </responses>
            </response>
         </createObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getAutoNumbers, getAttributes, getAllClasses, getSubClasses

A.3.2 getObject

Service

To retrieve a specific Agile object from the Agile PLM system.

Usage

Detailed specifications in the request object of the object to be retrieved, of the class type, unique object number and other relevant data. Successful execution of the Web Service call retrieves comprehensive information about the object in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>ManufacturerPart</classIdentifier>
                  <objectNumber>MANUF_PART1241535324230</objectNumber>
                  <tableRequests>
                     <tableIdentifier>807</tableIdentifier>
                     <loadCellMetaData>false</loadCellMetaData>
                  </tableRequests>
                  <options>
                     <propertyName>manufacturer_name</propertyName>
                     <propertyValue>MANUF1241535323652</propertyValue>
                  </options>
               </requests>
            </request>
         </getObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <agileObject>
                     <objectIdentifier>
                        <classId>1488</classId>
                        <className>ManufacturerPart</className>
                        <classDisplayName>Manufacturer Part</classDisplayName>
                        <objectId>6110515</objectId>
                        <objectName>MANUF_PART1241535324230</objectName>
                     </objectIdentifier>
                     <table>
                        <tableIdentifier>
                           <classId>1488</classId>
                           <className>ManufacturerPart</className>
                           <objectId>6110515</objectId>
                           <objectName>MANUF_PART1241535324230</objectName>
                           <tableId>807</tableId>
                           <tableName>Attachments</tableName>
                           <tableDisplayName>Attachments</tableDisplayName>
                        </tableIdentifier>
                     </table>
                     <manufacturerPartNumber xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1648">MANUF_PART1241535324230</manufacturerPartNumber>
                     <manufacturerName xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1647">MANUF1241535323652</manufacturerName>
                     <description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3566">Description</description>
                     <lifecyclePhase xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1649">
                        <selection>
                           <id>1517</id>
                           <apiName>ACTIVE</apiName>
                           <value>Active</value>
                        </selection>
                     </lifecyclePhase>
                     <mfrPartType xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2543">
                        <selection>
                           <id>1488</id>
                           <apiName>MANUFACTURER_PART</apiName>
                           <value>Manufacturer Part</value>
                        </selection>
                     </mfrPartType>
                     <partFamily xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000004417"/>
                     <mass xsi:type="common:AgileUnitOfMeasureType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000004613"/>
                     <complianceCalculatedDate xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2000004735"/>
                     <overallCompliance xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000005405"/>
                     <thumbnail xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000008559"/>
                     <itemGroupS xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="2000008566"/>
                  </agileObject>
               </responses>
            </response>
         </getObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: quickSearch, advancedSearch, createObject

A.3.3 updateObject

Service

To update a specific object in the Agile PLM system.

Usage

The revised object specifications are detailed in the request object where data specific to an Agile object may be expressed.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <updateObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>ManufacturerPart</classIdentifier>
                  <objectNumber>MANUF_PART1241535380057</objectNumber>
                  <data rowId="0">
                     <Message_Desc attributeId="3566">Updated value of Manuf part Description</Message_Desc>
                  </data>
                  <options>
                     <propertyName>manufacturer_name</propertyName>
                     <propertyValue>MANUF1241535379620</propertyValue>
                  </options>
               </requests>
            </request>
         </updateObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <updateObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </updateObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getAttributes

A.3.4 deleteObject

Service

To delete a specific object in the Agile PLM system.

Usage

The specifications of the object to be deleted are given in the request object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00589</objectNumber>
               </requests>
            </request>
         </deleteObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isDeleted>true</isDeleted>
               </responses>
            </response>
         </deleteObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: quickSearch, advancedSearch

A.3.5 undeleteObject

Service

To revoke the 'deleted' status of a specific object that was previously deleted from the Agile PLM system.

Usage

The specifications of the object to be undeleted are given in the request object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <undeleteObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00600</objectNumber>
               </requests>
            </request>
         </undeleteObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <undeleteObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses/>
            </response>
         </undeleteObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: advancedSearch, quickSearch, deleteObject

A.3.6 isDeletedObject

Service

To check whether a specific Agile object in the Agile PLM system is deleted or not.

Usage

The object specifications are detailed in the request object where the class type, unique object number may be specified. From the response object, it is possible to ascertain whether the Agile object queried for still exists in the Agile PLM or if it was deleted.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isDeletedObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00593</objectNumber>
               </requests>
            </request>
         </isDeletedObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isDeletedObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isDeleted>false</isDeleted>
               </responses>
            </response>
         </isDeletedObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: advancedSearch, quickSearch, deleteObject

A.3.7 sendObject

Service

To send a specific Agile object to the Agile PLM system.


Note:

To send the objects through Web Services or web user interface, you must first enable the notification feature. In Java client, under Admin > Server settings > Database, set the Notification Enabled to Yes.

Usage

The object specifications of the object to be sent are detailed in the request object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <sendObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00599</objectNumber>
                  <sendTo>
                     <classIdentifier>User</classIdentifier>
                     <objectIdentifier>User1241535366448</objectIdentifier>
                  </sendTo>
                  <comments>Test comments</comments>
               </requests>
            </request>
         </sendObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <sendObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses/>
            </response>
         </sendObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getUsers

A.3.8 saveAsObject

Service

To save a specific Agile object as a new object in the Agile PLM system.

Usage

The object specifications are detailed in the request object where the class type, unique object number and other primary data may be specified. The response object contains information identifying the object that was saved.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <saveAsObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <saveAsObjectRequest>
                  <parentClassIdentifier>Part</parentClassIdentifier>
                  <parentObjectNumber>P00594</parentObjectNumber>
                  <newClassIdentifier>Part</newClassIdentifier>
                  <data rowId="0">
                     <Message_Num attributeId="1001">P00596</Message_Num>
                  </data>
               </saveAsObjectRequest>
               <saveAsObjectRequest>
                  <parentClassIdentifier>Part</parentClassIdentifier>
                  <parentObjectNumber>P00595</parentObjectNumber>
                  <newClassIdentifier>Part</newClassIdentifier>
                  <autoNumberSource>Part Number</autoNumberSource>
               </saveAsObjectRequest>
            </request>
         </saveAsObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <saveAsObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <saveAsObjectResponse>
                  <classIdentifier>Part</classIdentifier>
                  <objectId>6110572</objectId>
                  <objectNumber>P00596</objectNumber>
               </saveAsObjectResponse>
               <saveAsObjectResponse>
                  <classIdentifier>Part</classIdentifier>
                  <objectId>6110579</objectId>
                  <objectNumber>P00598</objectNumber>
               </saveAsObjectResponse>
            </response>
         </saveAsObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getAutoNumbers, getAttributes

A.3.9 checkPrivilege

Service

To check whether a specific Agile user holds the privileges to perform a specific action in the Agile PLM system.

Usage

The user and privilege specifications are detailed in the request object. The request object confirms whether the specified agile user has the privilege to perform the Web Service operation.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkPrivilege xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <userIdentification>
                     <userIdentifier>admin</userIdentifier>
                  </userIdentification>
                  <privilege>1</privilege>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00585</objectNumber>
               </requests>
            </request>
         </checkPrivilege>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkPrivilegeResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <userIdentification>
                     <userIdentifier>admin</userIdentifier>
                  </userIdentification>
                  <privilege>
                     <privilege>1</privilege>
                     <checkPrivilege>true</checkPrivilege>
                     <classIdentifier>Part</classIdentifier>
                     <objectNumber>P00585</objectNumber>
                  </privilege>
               </responses>
            </response>
         </checkPrivilegeResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getUsers, copyTable

A.3.10 getSubscriptions

Service

To retrieve the subscriptions for a specific data object in the Agile PLM system.

Usage

The data object specifications are detailed in the request object. The response object contains the details of the subscriptions.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSubscriptions xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>TEST_PART5554188</objectNumber>
               </requests>
               <requests>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>TEST_ECO3514179</objectNumber>
               </requests>
            </request>
         </getSubscriptions>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSubscriptionsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <objectReferent>
                     <classIdentifier>Part</classIdentifier>
                     <objectIdentifier>TEST_PART7510476</objectIdentifier>
                     <version>0</version>
                  </objectReferent>
                  <subscriptions>
                     <id>1</id>
                     <name>Lifecycle Phase Change</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>2</id>
                     <name>Field Change</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>13</id>
                     <name>Rev Change</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>3</id>
                     <name>Add File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>4</id>
                     <name>Delete File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>5</id>
                     <name>Checkin File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>6</id>
                     <name>Checkout File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>7</id>
                     <name>Cancel Checkout File</name>
                     <enable>false</enable>
                  </subscriptions>
               </responses>
            </response>
         </getSubscriptionsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.3.11 modifySubscriptions

Service

To retrieve the subscriptions for a specific data object in the Agile PLM system.

Usage

Details data object and subscription specifications in the request object. The response object will contain the details of the subscriptions.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>  
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <modifySubscriptions xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <request xmlns="">
               <requests>                 
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>TEST_PART6194052</objectNumber>
                  <subscriptions>
                     <id>2</id>
                     <name>Field Change</name>
                     <enable>false</enable>
                  </subscriptions>
                  <applyToChildren>false</applyToChildren>
               </requests>
            </request>
         </modifySubscriptions>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <modifySubscriptionsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <subscriptions>
                     <id>1</id>
                     <name>Lifecycle Phase Change</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>2</id>
                     <name>Field Change</name>
                     <enable>true</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>13</id>
                     <name>Rev Change</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>3</id>
                     <name>Add File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>4</id>
                     <name>Delete File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>5</id>
                     <name>Checkin File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>6</id>
                     <name>Checkout File</name>
                     <enable>false</enable>
                  </subscriptions>
                  <subscriptions>
                     <id>7</id>
                     <name>Cancel Checkout File</name>
                     <enable>false</enable>
                  </subscriptions>
               </responses>
            </response>
         </modifySubscriptionsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.3.12 createReferenceObject

Service

To create an Agile Reference object by using API names to detail the mandatory specifications.

Usage

The request object specifies the attributes using the appropriate API names to create new objects using the operation createObject.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:createObject>
         <request>
            <requests>
               <classIdentifier>RefObjectClassName</classIdentifier>
               <data rowId="0">
                  <Name>RefObj001</Name>
                  <Description>Reference Object RefObj001</Description>
             <referencedObjKey>0001|12345</referencedObjKey>                        
               </data>
            </requests>
         </request>
      </v1:createObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <createObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <agileObject>
                  <objectIdentifier>
                     <classId>2623238</classId>
                     <className>RefObjectClassName</className>
                     <classDisplayName>RefObjectClassName</classDisplayName>
                     <objectId>6206023</objectId>
                     <objectName>RefObj001</objectName>
                     <version>0</version>
                  </objectIdentifier>
               </agileObject>
            </responses>
         </response>
      </createObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

A.3.13 getReferenceObject

Service

To retrieve details of the specific Agile Reference Object from the Agile PLM system.

Usage

The specifications of the Reference object to be retrieved are detailed in the request object. You can specify the class type, unique object number and relevant data. Comprehensive information about the object is retrieved in the response object after successful execution of the Web Service call.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:getObject>
         <request>
            <requests>
               <classIdentifier>RefObjectClassName</classIdentifier>
               <objectNumber>RefObj001</objectNumber>
                    <!--Optional-->
                    <referencedObjKey>0001|12345</referencedObjKey>
            </requests>
         </request>
      </v1:getObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <getObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <agileObject>
                  <objectIdentifier>
                     <classId>2623238</classId>
                     <className>RefObjectClassName</className>
                     <classDisplayName>RefObjectClassName</classDisplayName>
                     <objectId>6206023</objectId>
                     <objectName>RefObj001</objectName>
                     <version>0</version>
                  </objectIdentifier>
               </agileObject>
            </responses>
         </response>
      </getObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

A.3.14 deleteReferenceObject

Service

To delete the reference object.

Usage

The specifications of the object to be deleted are given in the request object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:deleteObject>
         <request>
            <requests>
               <classIdentifier>RefObjectClassName</classIdentifier>
               <objectNumber>RefObj01</objectNumber>
                       <!--Optional-->
                       <referencedObjKey>0001|12345</referencedObjKey>               
            </requests>
         </request>
      </v1:deleteObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <deleteObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <isDeleted>true</isDeleted>
            </responses>
         </response>
      </deleteObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

A.3.15 updateReferenceObject

Service

To update the details of the reference object using the updateObject operation.

Usage

Updates the particulars of an Agile object. The request object contains specifications identifying the object which must be updated.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:updateObject>
         <request>
            <requests>
               <classIdentifier>RefObjectClassName</classIdentifier>
               <objectNumber>RefObj001</objectNumber>
                    <!--Optional-->
                    <referencedObjKey>0001|12345</referencedObjKey>
                       <data rowId="0">
                             <URL>/Agile/PLMServlet?fromPCClient=true&amp;module=ItemHandler&amp;requestUrl=module%3DItemHandler%26opcode%3DdisplayObject%26classid%3D10000%26objid%3D501781%26tabid%3D0%26</URL>
                             <Description>Updated Reference Object RefObj01</Description>
                             <CurrentStatus>Evaluated</CurrentStatus>                
                       </data>
            </requests>
         </request>
      </v1:updateObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <updateObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </updateObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

A.4 Collaboration Web Services

This section describes the web services operations available for Collaboration Web Services.

A.4.1 getWorkflows

Service

To retrieve the valid workflows of an Agile routable object.

Usage

When you create a new change, package, product service request, or quality change order, you must select a workflow. Otherwise, the object remains in an unassigned state and cannot progress through a workflow process.

Agile system can have multiple workflows defined for each type of routable object. To retrieve the valid workflows for an object, use getWorklows service.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getWorkFlows xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <workflowRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00034</objectNumber>
               </workflowRequest>
            </request>
         </getWorkFlows>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getWorkFlowsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <workflowResponse>
                  <identifier>
                     <classId>6141</classId>
                     <className>ECO</className>
                     <classDisplayName>ECO</classDisplayName>
                     <objectId>6128130</objectId>
                     <objectName>C00034</objectName>
                  </identifier>
                  <workflow>
                     <workflowId>3752</workflowId>
                     <workflowName>DefaultChangeOrders</workflowName>
                     <workflowDisplayName>Default Change Orders</workflowDisplayName>
                  </workflow>
               </workflowResponse>
            </response>
         </getWorkFlowsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: setWorkFlow

A.4.2 getStatus

Service

To get the current and the next workflow status of an routable object.

Usage

To determine the status of a change - pending or released. The getStatus service returns a Status object.Workflow functionalities that are made available to users for a particular routable object, depend on the status of the routable object and the users' privileges. The workflow actions available for a pending change are different from those for a released change.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getStatus xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <statusRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00034</objectNumber>
               </statusRequest>
            </request>
         </getStatus>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getStatusResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <statusResponse>
                  <identifier>
                     <classId>6141</classId>
                     <className>ECO</className>
                     <classDisplayName>ECO</classDisplayName>
                     <objectId>6128130</objectId>
                     <objectName>C00034</objectName>
                  </identifier>
                  <currentStatus>
                     <statusId>3753</statusId>
                     <statusName>Pending</statusName>
                     <statusDisplayName>Pending</statusDisplayName>
                  </currentStatus>
                  <nextDefaultStatus>
                     <statusId>3766</statusId>
                     <statusName>Submitted</statusName>
                     <statusDisplayName>Submitted</statusDisplayName>
                  </nextDefaultStatus>
                  <nextStatus>
                     <statusId>3766</statusId>
                     <statusName>Submitted</statusName>
                     <statusDisplayName>Submitted</statusDisplayName>
                  </nextStatus>
               </statusResponse>
            </response>
         </getStatusResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.4.3 auditRObject

Service

To audit a routable object.

Usage

Audit a change to determine if any required entry cells are incomplete or if the change violates any Agile Smart Rules, at any point in the lifecycle of a Change.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <auditRObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <request>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00035</objectNumber>
                  <auditRelease>true</auditRelease>
               </request>
            </request>
         </auditRObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <auditRObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <responses xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <response>
                  <identifier>
                     <classId>6141</classId>
                     <className>ECO</className>
                     <classDisplayName>ECO</classDisplayName>
                     <objectId>6128165</objectId>
                     <objectName>C00035</objectName>
                  </identifier>
                  <error>
                     <exceptionId>60086</exceptionId>
                     <message>The following required fields are missing : C00035: Affected Items.New Rev: P00336</message>
                  </error>
               </response>
            </responses>
         </auditRObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: changeStatus

A.4.4 getApprovers

Service

To get a list of approvers or observers for Agile's routable objects.

Usage

When a routable object is released in a workflow, it is either sent to a user for approval or for notification. A list of users is required to be selected and added for the workflow to begin. This list is obtained from Agile system by sending a getApprovers request.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getApprovers xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <approversRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00038</objectNumber>
                  <statusIdentifier>CCB</statusIdentifier>
               </approversRequest>
            </request>
         </getApprovers>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getApproversResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <approversResponse>
                  <identifier>
                     <classId>6141</classId>
                     <className>ECO</className>
                     <classDisplayName>ECO</classDisplayName>
                     <objectId>6128265</objectId>
                     <objectName>C00038</objectName>
                  </identifier>
               </approversResponse>
            </response>
         </getApproversResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getStatus

A.4.5 changeStatus

Service

A general purpose service for changing the status of an Agile object (a new attribute: acknowledgers).

Usage

Submits, releases, or cancels a change.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:changeStatus>
         <request>
            <changeStatusRequest>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00133</objectNumber>
               <newStatusIdentifier>CCB</newStatusIdentifier>
               <approvers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
                  <jobFunction>Developer</jobFunction>
               </approvers>
               <observers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>albertl</objectIdentifier>
               </observers>
               <acknowledgers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>cn_user</objectIdentifier>
                  <jobFunction>QA</jobFunction>
               </acknowledgers>
            </changeStatusRequest>
         </request>
      </v1:changeStatus>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <changeStatusResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </changeStatusResponse>
   </soapenv:Body>
</soapenv:Envelope>

See also: auditRObject

A.4.6 approveRObject

Service

To see the approval results for an object.

Usage

Informs the users whether the object has been approved by the approver, or, when an approver is approving the object on behalf of one or more user groups. After you route a change to a group of approvers, the online approval process begins. Users listed in the Workflow table for a change can approve or reject the change.

When you approve a change, the Agile system records the approval in the Workflow table. When all approvers have approved the change, the system sends an email notification to the change analyst or component engineer indicating that the change is ready to be released.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:approveRObject>
         <request>
            <approveRObject>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00514</objectNumber>
               <password>agile</password>
               <comment>approval for C00514</comment>         
               <approveForGroup>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
               </approveForGroup>
     <notifyOriginator>true</notifyOriginator>
               <notifyCCB>false</notifyCCB>
               <notifyChangeAnalyst>true</notifyChangeAnalyst>
               <urgent>false</urgent>
            </approveRObject>
         </request>
      </v1:approveRObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <approveRObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </approveRObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

See also: getStatus, getApprovers

A.4.7 rejectRObject

Service

To reject a routable object.

Usage

Informs users that the routable object is rejected by an approver, or when an approver has rejected the object on behalf of one or more user groups. After you route a change to group of approvers, the online approval process begins. Users listed in the Workflow table for a change can approve or reject the change.

When you approve a change, the Agile system records the approval in the Workflow table. When all approvers have approved the change, the system sends an email notification to the change analyst or component engineer indicating that the change is ready to be released.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:rejectRObject>
         <request>
            <rejectRObject>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00514</objectNumber>
               <password>agile</password>
               <comment>rejected C00514</comment>
               <secondSignature>admin</secondSignature>
               <rejectForGroups>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
                  <jobFunction>Developer</jobFunction>
               </rejectForGroups>
     <notifyOriginator>true</notifyOriginator>
               <notifyCCB>false</notifyCCB>
               <notifyChangeAnalyst>true</notifyChangeAnalyst>
               <urgent>false</urgent>
            </rejectRObject>
         </request>
      </v1:rejectRObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <rejectRObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </rejectRObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

See also: getApprovers, getStatus, auditRObject, approveRObject

A.4.8 setWorkFlow

Service

To set the workflow of an object.

Usage

As long as a change is in the Pending status, you have the option to set a different workflow. Once a change moves beyond Pending status, you cannot change the workflow. If a routable object has not been assigned a workflow yet, use the setWorkflow method to set the workflow.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <setWorkFlow xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <setWorkFlowRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00033</objectNumber>
                  <workFlowIdentifier>3752</workFlowIdentifier>
               </setWorkFlowRequest>
            </request>
         </setWorkFlow>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <setWorkFlowResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </setWorkFlowResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getWorkFlows

A.4.9 addApprovers

Service

To add a list of Approvers or Observers to a routable object.

addApprovers is used for adding a set of approvers for a given status in Agile PLM. Details of status and list of approvers can be specified in the request object. Verify the success of the operation using the status code in the response object.

Usage

When a change is routed and the online approval process has begun, it may be necessary to add or remove people from the list of approvers or observers. When you use addApprovers services, you specify the lists of approvers and observers, whether the notification is urgent, and an optional comment.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addApprovers xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <addApproversRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00074</objectNumber>
                  <statusIdentifier>CCB</statusIdentifier>
                  <approvers>
                     <classIdentifier>11610</classIdentifier>
                     <objectIdentifier>User11239100555679</objectIdentifier>
                  </approvers>
                  <approvers>
                     <classIdentifier>11610</classIdentifier>
                     <objectIdentifier>User21239100555679</objectIdentifier>
                  </approvers>
                  <urgent>false</urgent>
                  <comment>Comments</comment>
               </addApproversRequest>
            </request>
         </addApprovers>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addApproversResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </addApproversResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getWorkFlows, getStatus

A.4.10 removeApprovers

Service

Removes the approvers or observers added to a routable object.

Usage

After you start an online approval process and route a change, you may need to remove people from the list of approvers/observers. Using removeApprovers, you specify the lists of approvers/observers, whether the notification is urgent, and add optional comments.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeApprovers xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <removeApproversRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00042</objectNumber>
                  <statusIdentifier>CCB</statusIdentifier>
                  <approvers>
                     <classIdentifier>11610</classIdentifier>
                     <objectIdentifier>admin</objectIdentifier>
                  </approvers>
                  <comment>Comments</comment>
               </removeApproversRequest>
            </request>
         </removeApprovers>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeApproversResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </removeApproversResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getApprovers, addApprovers

A.4.11 commentRObject

Service

To comment on a routable object.

Usage

Comments on a change, sends a comment to other CCB reviewers during the online approval process. In addition, specifies whether to notify the originator, the change analyst, and the change control board.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <commentRObject xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <request xmlns="">
               <commentRObjectRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00037</objectNumber>
                  <comment>Comment</comment>
                  <notifyOriginator>true</notifyOriginator>
                  <notifyChangeAnalyst>true</notifyChangeAnalyst>
                  <notifyCCB>true</notifyCCB>
                  <notifyList>
                     <classIdentifier>11610</classIdentifier>
                     <objectIdentifier>admin</objectIdentifier>
                  </notifyList>
               </commentRObjectRequest>
            </request>
         </commentRObject>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <commentRObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </commentRObjectResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.4.12 getReviewers

Service

To retrieve list of reviewers (approvers, observers, acknowledgers) from a routable object only from sign off table for a given workflow status in the Agile system.

Usage

Contains the specifications that identify a change and status while the response object retrieves all the approvers queried for. An array of requests of type AgileGetReviewersRequestType includes details about the object for whose workflow the reviewers are to be retrieved. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
     xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <soapenv:Body>
           <getReviewers
                 xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
                 <request xmlns="">
                       <disableAllWarnings>true</disableAllWarnings>
                       <reviewersRequest>
                             <classIdentifier>ECO</classIdentifier>
                             <objectNumber>C00517</objectNumber>
                             <statusIdentifier>CCB</statusIdentifier>
                       </reviewersRequest>
                 </request>
           </getReviewers>
     </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <getReviewersResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <reviewersResponse>
               <identifier>
                  <classId>6141</classId>
                  <className>ECO</className>
                  <classDisplayName>ECO</classDisplayName>
                  <objectId>6133992</objectId>
                  <objectName>C00517</objectName>
               </identifier>
               <approvers>
                  <classIdentifier>com.agile.api.pc.admin.user.User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
                  <jobFunction/>
               </approvers>
               <approvers>
                  <classIdentifier>com.agile.api.pc.admin.user.User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
                  <jobFunction>Developer</jobFunction>
               </approvers>
               <observers>

See also: getAll Reviewers

A.4.13 acknowledgeRObject

Service

To acknowledge a change in Agile PLM.

Usage

Used when an Acknowledger added to a change, acknowledges that particular change. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:acknowledgeRObject>
         <request>
            <acknowledgeRObject>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00515</objectNumber>
               <password>agile</password>
               <comment>acknowledge C00515</comment>
               <secondSignature>admin</secondSignature>
               <acknowledgeForGroups>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
               </acknowledgeForGroups>
               <urgent>false</urgent>         
            </acknowledgeRObject>
         </request>
      </v1:acknowledgeRObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <acknowledgeRObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </acknowledgeRObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>
See also

See also: commentRObject

A.4.14 getAllReviewers

Service

To retrieve all the reviewers (approvers, observers, acknowledgers) for a particular change from a routable object signoff table and its workflow criteria for a given workflow status from both Web and Java client in the Agile system.

Usage

Contains the specifications that identifies a change and status while the response object will retrieve all the reviewers queried for. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:getAllReviewers>
         <request>
            <reviewersRequest>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00515</objectNumber>
               <statusIdentifier>CCB</statusIdentifier>
            </reviewersRequest>
         </request>
      </v1:getAllReviewers>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <getAllReviewersResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <reviewersResponse>
               <identifier>
                  <classId>6141</classId>
                  <className>ECO</className>
                  <classDisplayName>ECO</classDisplayName>
                  <objectId>6133766</objectId>
                  <objectName>C00515</objectName>
               </identifier>
               <approvers>
                  <classIdentifier>com.agile.api.pc.admin.user.User</classIdentifier>
                  <objectIdentifier>avnet</objectIdentifier>
                  <jobFunction/>
               </approvers>
               <observers>
                  <classIdentifier>com.agile.api.pc.admin.user.User</classIdentifier>
                  <objectIdentifier>veenas</objectIdentifier>
                  <jobFunction/>
               </observers>
               <acknowledgers>
                  <classIdentifier>com.agile.api.pc.admin.user.User</classIdentifier>
                  <objectIdentifier>robertb</objectIdentifier>
                  <jobFunction/>
               </acknowledgers>
            </reviewersResponse>
         </response>
      </getAllReviewersResponse>
   </soapenv:Body>
</soapenv:Envelope>
See also

See also: getReviewers

A.4.15 addReviewers

Service

To add reviewers (approvers, observers, acknowledgers) to a routable object in Agile PLM.

Usage

Specifies the details of the status and lists of reviewers in the request object. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:addReviewers>
         <request>
            <addReviewersRequest>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00517</objectNumber>
               <statusIdentifier>CCB</statusIdentifier>
               <approvers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
                  <jobFunction>Developer</jobFunction>
               </approvers>
               <observers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>albertl</objectIdentifier>
                  <jobFunction>QA</jobFunction>
               </observers>
               <acknowledgers>
                  <classIdentifier>User</classIdentifier>
               </acknowledgers>
               <urgent>false</urgent>
            </addReviewersRequest>
         </request>
      </v1:addReviewers>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <addReviewersResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </addReviewersResponse>
   </soapenv:Body>
</soapenv:Envelope>

See also: getReviewers, getAllreviewers

A.4.16 checkOutFF

Service

To check-out an Agile File Folder object.

Usage

The request object specifies the file folder that has to be checked out. Subsequent operations such as adding a file to this file folder and then checking in the folder back are possible after this step. Before adding a new file to a folder, the folder object must be checked out before any file operation using the checkout Web Service.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkOutFF xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <request xmlns="">
               <requests>
                  <folderNumber>FOLDER00214</folderNumber>
               </requests>
            </request>
         </checkOutFF>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <checkOutFFResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Attachment/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folderNumber>FOLDER00214</folderNumber>
               </responses>
            </response>
         </checkOutFFResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.4.17 removeReviewers

Service

To remove reviewers (approvers, observers, acknowledgers) from a routable object in Agile PLM.

Usage

Specifies the details of the status and lists of reviewers in the request object. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:removeReviewers>
         <request>
            <removeReviewersRequest>
               <classIdentifier>ECO</classIdentifier>
               <objectNumber>C00005</objectNumber>
               <statusIdentifier>CCB</statusIdentifier>
               <approvers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
                  <jobFunction>Developer</jobFunction>
               </approvers>
               <observers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>cn_user</objectIdentifier>
               </observers>
               <acknowledgers>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>albertl</objectIdentifier>
                  <jobFunction>QA</jobFunction>
               </acknowledgers>
            </removeReviewersRequest>
         </request>
      </v1:removeReviewers>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <removeReviewersResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Collaboration/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
         </response>
      </removeReviewersResponse>
   </soapenv:Body>
</soapenv:Envelope>

See also: addReviewers

A.5 Doc Publishing Web Services

This section describes the web services operations available for Doc Publishing Web Services.

A.5.1 loadXMLSchema

Service

To return an XML package that fully describes the attributes of the object.

Usage

Creates XML schema files that will be used by the BI Publisher to create the templates

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadXMLSchema xmlns="http://xmlns.oracle.com/AgileObjects/Core/DocPublishing/V1">
            <request xmlns="">
               <requests>
                  <classIdentifiers>Part</classIdentifiers>
               </requests>
            </request>
         </loadXMLSchema>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadXMLSchemaResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/DocPublishing/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <url>http://LAP-MKAGARWA-WF:8888/webfs/DownloadServlet?token=CCB1322A8018407FB0DDF2C10F49C3C8D5B5F4C1725C94DA0259E3874D2D58B65F1740E2C4EFD98A13313C899D2BB3602D5030762A88DB4AE9CBDB5FD010C43E2CFCC938C6C4B6B284806A58489D&amp;vault=&amp;fileID=61C735C6EBB8BDEE33</url>
               </responses>
            </response>
         </loadXMLSchemaResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.5.2 loadXMLData

Service

To return the actual data that is stored for an object in an XML package.

Usage

Retrieves the object data that is combined with the template to create the output file. You can also use the saved output from this Web Service to test a template in BI Publisher.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadXMLData xmlns="http://xmlns.oracle.com/AgileObjects/Core/DocPublishing/V1">
            <request xmlns="">
               <requests>
                  <objectReferent>
                     <classIdentifier>Part</classIdentifier>
                     <objectIdentifier>P0001</objectIdentifier>
                  </objectReferent>
                  <filterName>DefaultPartFilter</filterName>
               </requests>
            </request>
         </loadXMLData>
      </soapenv:Body>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadXMLDataResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/DocPublishing/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <url>http://LAP-MKAGARWA-WF:8888/webfs/DownloadServlet?token=753F08D64B2FF2ED9C5257A3D8EB08E12E9B669C2C2D1D3AEFF9A733768634801513492E9A08E12EF38BCAAC38644A34EB546F4272CB08C561D9197D66B9B6DB6B1F0127EB65E7167CEECF385710&amp;vault=&amp;fileID=22C1D1CB8BA62AFDB7</url>
               </responses>
            </response>
         </loadXMLDataResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6 Folder Web Services

This section describes the web services operations available for Folder Web Services.

A.6.1 getFolder

Service

To load folders.

Usage

Retrieves the user's specific folders, such as Home Folder, Recent Visits, Favorites and so on. The operation can be used by the UI clients to provide folder browsing capability. You can also get the logged-in user's folders.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getFolder xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>3</baseFolder>
                     <name>Personal Searches/TestFOLDERA3765379</name>
                  </folderIdentifier>
                  <recursive>true</recursive>
               </requests>
            </request>
         </getFolder>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getFolderResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folder>
                     <identifier>
                        <baseFolder>3</baseFolder>
                        <name>Personal Searches/TestFOLDERA3765379</name>
                        <version>1</version>
                     </identifier>
                     <folderType>0</folderType>
                     <owner>admin</owner>
                  </folder>
               </responses>
            </response>
         </getFolderResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6.2 createFolder

Service

To create folders.

Usage

Creates personal folders and child folders. You can also set the access rights from default private to public.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createFolder xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>3</baseFolder>
                     <name>Personal Searches/TestFOLDERA4472326</name>
                  </folderIdentifier>
               </requests>
            </request>
         </createFolder>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createFolderResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folder>
                     <identifier>
                        <baseFolder>3</baseFolder>
                        <name>Personal Searches/TestFOLDERA4472326</name>
                        <version>1</version>
                     </identifier>
                     <folderType>0</folderType>
                     <owner>admin</owner>
                  </folder>
               </responses>
            </response>
         </createFolderResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6.3 renameFolder

Service

To rename a folder.

Usage

Passes the value of original folder name and the new name for it.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <renameFolder xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>3</baseFolder>
                     <name>Personal Searches/TESTFOLDER1517677</name>
                  </folderIdentifier>
                  <newName>newTestFOLDER8320018</newName>
               </requests>
            </request>
         </renameFolder>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <renameFolderResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folder>
                     <identifier>
                        <baseFolder>3</baseFolder>
                        <name>Personal Searches/newTestFOLDER8320018</name>
                        <version>2</version>
                     </identifier>
                     <folderType>0</folderType>
                     <owner>admin</owner>
                  </folder>
               </responses>
            </response>
         </renameFolderResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6.4 deleteFolder

Service

To delete a folder.

Usage

Given the folder identifier, deletes that folder.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteFolder xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>3</baseFolder>
                     <name>Personal Searches/TestFOLDERA3765379</name>
                  </folderIdentifier>
                  <recursive>false</recursive>
               </requests>
            </request>
         </deleteFolder>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteFolderResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </deleteFolderResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6.5 addChildNode

Service

To add child Nodes to a folder.

Usage

List of child Nodes to be added to a folder are passed as input to the request. The child nodes can be a query object, an AgileObject or a subfolder itself.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>  
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addChildNode xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>26</baseFolder>
                     <name>TEST_ITEMS</name>
                  </folderIdentifier>
                  <agileObjects>
                     <classIdentifier>Part</classIdentifier>
                     <objectIdentifier>TEST_PART16202692</objectIdentifier>                 
                  </agileObjects>
               </requests>
            </request>
         </addChildNode>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addChildNodeResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </addChildNodeResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6.6 getChildNode

Service

To get child Nodes of a folder.

Usage

List of child nodes to be returned for a folder is passed as input to the request. The returned childNode can be a query object, an AgileObject or a subfolder itself.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getChildNode xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>26</baseFolder>
                     <name>TESTFOLDERA5703774</name>
                  </folderIdentifier>
                  <children>TESTFOLDERB8643248</children>
                  <allChildren>false</allChildren>
               </requests>
            </request>
         </getChildNode>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getChildNodeResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <folderIdentifier>
                     <baseFolder>26</baseFolder>
                     <name>TESTFOLDERA5703774</name>
                     <version>3</version>
                  </folderIdentifier>
                  <folders>
                     <baseFolder>26</baseFolder>
                     <name>TESTFOLDERA5703774/TESTFOLDERB8643248</name>
                     <version>4</version>
                  </folders>
               </responses>
            </response>
         </getChildNodeResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.6.7 removeChildNode

Service

To remove child Nodes from a folder.

Usage

List of child nodes to be removed is passed as input to the request. You can also choose to remove all child nodes of a folder by setting a flag present on the request Object. The child node can be a query object, an AgileObject or a subfolder itself.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeChildNode xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <request xmlns="">
               <requests>
                  <folderIdentifier>
                     <baseFolder>26</baseFolder>
                     <name>TESTFOLDERA1611270</name>
                  </folderIdentifier>
                  <children>TESTFOLDERB5695801</children>
                  <allChildren>false</allChildren>
               </requests>
            </request>
         </removeChildNode>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeChildNodeResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Folder/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </removeChildNodeResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.7 PC Web Services

This section describes the web services operations available for PC Web Services.

A.7.1 setIncorporate

Service

To set the status of an Agile object as 'incorporated' or 'unincorporated'.

Usage

The request object is formed based on the class and object identifiers of the object and the status of incorporation. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <setIncorporate xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P00735</objectNumber>
                  <incorporate>true</incorporate>
               </requests>
            </request>
         </setIncorporate>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <setIncorporateResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isIncorporated>true</isIncorporated>
               </responses>
            </response>
         </setIncorporateResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.7.2 getRevisions

Service

To retrieve the revisions of an Agile object given the details of the object and relevant options.

Usage

The request object is formed based this information and revisions of the object are obtained through the response object. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getRevisions xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>1000-02</objectNumber>
                  <allRevisions>false</allRevisions>
               </requests>
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>1000-02</objectNumber>
                  <allRevisions>true</allRevisions>
               </requests>
            </request>
         </getRevisions>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getRevisionsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <currentRev>C</currentRev>
               </responses>
               <responses>
                  <currentRev>C</currentRev>
                  <revisions>
                     <changeIdentifier>
                        <classId>6141</classId>
                        <className>ECO</className>
                        <classDisplayName>ECO</classDisplayName>
                        <objectId>45</objectId>
                        <objectName>25000</objectName>
                     </changeIdentifier>
                     <revision>(D)</revision>
                  </revisions>
                  <revisions>
                     <changeIdentifier>
                        <classId>6141</classId>
                        <className>ECO</className>
                        <classDisplayName>ECO</classDisplayName>
                        <objectId>44</objectId>
                        <objectName>24433</objectName>
                     </changeIdentifier>
                     <revision>C</revision>
                  </revisions>
                  <revisions>
                     <changeIdentifier>
                        <classId>6141</classId>
                        <className>ECO</className>
                        <classDisplayName>ECO</classDisplayName>
                        <objectId>43</objectId>
                        <objectName>24020</objectName>
                     </changeIdentifier>
                     <revision>B</revision>
                  </revisions>
                  <revisions>
                     <changeIdentifier>
                        <classId>6141</classId>
                        <className>ECO</className>
                        <classDisplayName>ECO</classDisplayName>
                        <objectId>41</objectId>
                        <objectName>23450</objectName>
                     </changeIdentifier>
                     <revision>A</revision>
                  </revisions>
                  <revisions>
                     <changeIdentifier xsi:nil="true"/>
                     <revision>Introductory</revision>
                  </revisions>
               </responses>
            </response>
         </getRevisionsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getObject, loadTable

A.7.3 undoRedline

Service

To revert a redlined entity in Agile PLM by issuing an undo operation on the redline.

Usage

Creates a request object using relevant details.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <undoRedline xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">                      
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>                                  
                  <objectNumber>P1242809159264</objectNumber>                                  
                  <redlineTable>TABLE_REDLINEBOM</redlineTable>                                  
                  <rowId>6201465</rowId>
                  <options>
                     <propertyName>revision</propertyName>                                        
                     <propertyValue>B</propertyValue>                                  
                  </options>
               </requests>
            </request>
         </undoRedline>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <undoRedlineResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses/>
            </response>
         </undoRedlineResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: loadTable.

A.7.4 isRedlineModified

Service

To determine whether a particular redlined entity in Agile PLM has been modified or not.

Usage

Creates a request object using the relevant details. The response object includes information that denotes whether the specified redline was modified.

Sample Code

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isRedlineModified xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <request xmlns="">
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P1242818906603</objectNumber>
                  <redlineTable>TABLE_REDLINEBOM</redlineTable>
                  <rowId>6201729</rowId>
                  <options>
                     <propertyName>revision</propertyName>
                     <propertyValue>B</propertyValue>
                  </options>
               </requests>
               <requests>
                  <classIdentifier>Part</classIdentifier>
                  <objectNumber>P1242818906603</objectNumber>
                  <redlineTable>TABLE_REDLINEBOM</redlineTable>
                  <rowId>6201734</rowId>
                  <options>
                     <propertyName>revision</propertyName>
                     <propertyValue>B</propertyValue>
                  </options>
               </requests>
            </request>
         </isRedlineModified>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isRedlineModifiedResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isRedlineModified>true</isRedlineModified>
               </responses>
               <responses>
                  <isRedlineModified>false</isRedlineModified>
               </responses>
            </response>
         </isRedlineModifiedResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: loadTable.

A.7.5 isIncorporated

Service

To determine whether a particular data object entity in Agile PLM has been Incorporated.

Usage

Specifies the details of the object whose 'Is Incorporated' status is to be retrieved. The response object includes information that will denote whether the specified data object has been Incorporated or not.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isIncorporated xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">           
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <classIdentifier>10141</classIdentifier>
                  <objectNumber>TEST_PART5780230</objectNumber>
               </requests>
            </request>
         </isIncorporated>
      </soapenv:Body>  
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isIncorporatedResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pc/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isIncorporated>false</isIncorporated>
               </responses>
            </response>
         </isIncorporatedResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.8 PG&C Web Services

This section describes the web services operations available for Product Governance & Compliance.

A.8.1 getRollupData

Service

To get the rollup compliance data.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
 <soapenv:Header/>
   <soapenv:Body>
     <v1:activateComposition>
       <request>
         <AgilerequestType>
            <objNumber>TC59224_PART001</objNumber>
            <objClass>Part</objClass>
            <changeNumber>C00004</changeNumber>
            <compostionid>6018883</compostionid>
         </AgilerequestType>
       <request>
     <v1:activateComposition>
  </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <getRollupDataResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
     <response xmlns="">
      <messageId xsi:nil="true"/>
      <messageName xsi:nil="true"/>
      <statusCode>SUCCESS</statusCode>
      <responses>
        <rollupData>0  ITEM    P00160 A C00119    No    0.0</rollupData>
      </responses>
     </response>
    </getRollupDataResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.2 triggerExtractRollupDataforObject

Service

To trigger the rollup data action for a specific object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
 <soapenv:Header/>
  <soapenv:Body>
    v1:triggerExtractRollupDataforObject>
      <request>
       <AgilerequestType>
         <objNumber>P00160</objNumber>
         <objClass>Parts</objClass>
         <changeNumber>C00119</changeNumber>
       </AgilerequestType>
      </request>
    </v1:triggerExtractRollupDataforObject>
  </soapenv:Body>
</soapenv:Envelope>
==== Response ======
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <triggerExtractRollupDataforObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
     <response xmlns="">
      <messageId xsi:nil="true"/>
      <messageName xsi:nil="true"/>
      <statusCode>SUCCESS</statusCode>
      <AgileResponseType>
        <job_id>0</job_id>
      </AgileResponseType>
     </response>
    </triggerExtractRollupDataforObjectResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.3 triggerExternalRollup

Service

To trigger external rollup engine to do the rollup based on the extracted data (in fact_table).

Sample Code

SOAP

===== Request =====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
     <v1:triggerExternalRollup>
       <request>
         <AgilerequestType>
          <job_id>0</job_id>
         <AgilerequestType>
       <request>
     </v1:triggerExternalRollup>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <triggerExternalRollupResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType/>
      </response>
    </triggerExternalRollupResponse>
  <soapenv:Body>
<soapenv:Envelope>

A.8.4 getObjectComposition

Service

To get the composition result.

Sample Code

SOAP

==== Request =====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:getObjectComposition>
        <request>
          <AgilerequestType>
            <extract_id>1</extract_id>
          <AgilerequestType>
        <request>
      </v1:getObjectComposition>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <getObjectCompositionResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType>
          <compostion_info>
             <root_object_id>0</root_object_id>
             <change_id>6108862</change_id>
             <classId>6666415</classId>
             <compliance_status>0</compliance_status>
            <specification_name xsi:nil="true"/>
            <specification_id>43555622</specification_id>
            <rollup_date xsi:nil="true"/>
            <fmd>0</fmd>
          </compostion_info>
        </AgileResponseType>
      </response>
    </getObjectCompositionResponse>
  </soapenv:Body>

A.8.5 appendUpdateRow

Service

To add the calculated composition.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:appendUpdateRow>
        <request>
          <AgilerequestType>
            <objNumber>P00160</objNumber>
            <objClass>Part</objClass>
            <changeNumber>C00119</changeNumber>
            <objcompsition>
            <compostion_info>
              <root_object_id>6108862</root_object_id>
              <change_id>6108789</change_id>
              <change_id>6108789</change_id>
              <compliance_status>0</compliance_status>
              <specification_id>6108862</specification_id>
              <fmd>0</fmd>
            </compostion_info>
            </objcompsition>
          </AgilerequestType>
        </request>
      </v1:appendUpdateRow>
    </soapenv:Body>
====== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  </soapenv:Body>
    <appendUpdateRowResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
          <row>
            <objectReferentId>
              <classId>200002536</classId>
              <className>Homogeneous Material Declaration</className>
              <objectId>6100658</objectId>
              <objectName>MD00065</objectName>
              <version>17</version>
            </objectReferentId>
          <row>
        </response>
      </appendUpdateRowResponse>
    </soapenv:Body>
  </soapenv:Envelope>

A.8.6 getObjectCompositionSubstance

Service

To get the substance composition information after running the external rollup engine.

Sample Code

SOAP

===== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:getObjectCompositionSubstance>
        <request>
          <!--Zero or more repetitions:-->
          <AgilerequestType>
            <extract_id>0</extract_id>
          </AgilerequestType>
        </request>
      </v1:getObjectCompositionSubstance>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <getObjectCompositionSubstanceResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType/>
      </response>
    </getObjectCompositionSubstanceResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.7 appendUpdateSubstanceRow

Service

To add the calculated substance composition into substance table of the object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:appendUpdateSubstanceRow>
      <request>
        <AgilerequestType>
          <objNumber>P00160</objNumber>
          <objClass>Part</objClass>
          <rowid>6002358</rowid>
          <!--1 or more repetitions:-->
          <objcompsition>
            <substanceid>6002354</substanceid>
            <substance_name>Lead</substance_name>
            <classId>2000001014</classId>
            <mass>20</mass>
            <calcPPM>2</calcPPM>
            <compliance_status>0</compliance_status>
          </objcompsition>
        </AgilerequestType>
      </request>
    </v1:appendUpdateSubstanceRow>
  </soapenv:Body>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <appendUpdateRowResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
          <row>
            <objectReferentId>
            <classId>2000001014</classId>
            <className>Substance</className>
            <objectId>6002354</objectId>
            <objectName>Lead</objectName>
            <version>17</version>
          </objectReferentId>
        </row>
      </response>
    </appendUpdateRowResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.8 activateComposition

Service

To activate the composition rows of the archived composition table.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:activateComposition>
      <request>
        <AgilerequestType>
          <objNumber>P00160</objNumber>
          <objClass>Parts</objClass>
          <changeNumber>C00119</changeNumber>
          <compostionid>6032815</compostionid>
        </AgilerequestType>
      </request>
    </v1:activateComposition>
  </soapenv:Body>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <activateCompositionResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
      </response>
    </activateCompositionResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.9 deleteExtractedData

Service

To delete the data of a specific task in the staging table (fact_table).

Sample Code

SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:deleteExtractedData>
      <request>
        <AgilerequestType>
          <jobid>0</jobid>
        </AgilerequestType>
      </request>
    </v1:deleteExtractedData>
  </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <deleteExtractedDataResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType>
          <isdeleted>true</isdeleted>
        </AgileResponseType>
      </response>
    </deleteExtractedDataResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.10 updateObjectRollupResult

Service

To update the value of the calculated compliance attribute against the external specification.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:updateObjectRollupResult>
        <request>
          <AgilerequestType>
            <objNumber>P00160</objNumber>
            <objClass>Parts</objClass>
            <changeNumber>C00119</changeNumber>
            <specID>6032783</specID>
            <calculatedCompliance>0</calculatedCompliance>
            <rollupdate>2014-10-31T07:16:03.000Z</rollupdate>
          </AgilerequestType>
        </request>
      </v1:updateObjectRollupResult>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <updateObjectRollupResultResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType>
          <isrollupresultset>true</isrollupresultset>
        </AgileResponseType>
      </response>
    </updateObjectRollupResultResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.11 setCalculatedComplianceForObjectSpec

Service

To set the calculated Compliance value in the composition Table for a specific object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:setCalculatedComplianceForObjectSpec>
      <request>
        <AgilerequestType>
          <objNumber>P00160</objNumber>
          <objClass>Parts</objClass>
          <changeNumber>C00119</changeNumber>
          <specname>IEEE</specname>
          <calculatedCompliance>Compliant</calculatedCompliance>
          <canbemodified>true</canbemodified>
        </AgilerequestType>
      </request>
    </v1:setCalculatedComplianceForObjectSpec>
  </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <setCalculatedComplianceForObjectSpecResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType/>
      </response>
    </setCalculatedComplianceForObjectSpecResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.12 setCalculatedComplianceForDeclarationObjectSpec

Service

To set calculated compliance value for a part in the item/mfrpart table.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:setCalculatedComplianceForDeclarationObjectSpec>
      <request>
        <AgilerequestType>
        <declarationNumber>MD00022</declarationNumber>
        <objNumber>P00160</objNumber>
        <objClass>Parts</objClass>
        <changeNumber>c00119</changeNumber>
        <specname>IEEE</specname>
        <calculatedCompliance>Exempt</calculatedCompliance>
        <canbemodified>true</canbemodified>
      </AgilerequestType>
    </request>
  </v1:setCalculatedComplianceForDeclarationObjectSpec>
</soapenv:Body>
====== Response ======
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <setCalculatedComplianceForDeclarationObjectSpecResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
      <AgileResponseType/>
    </response>
  </setCalculatedComplianceForDeclarationObjectSpecResponse>
 </soapenv:Body>
</soapenv:Envelope>

A.8.13 setNeedRollupForDeclaration

Service

To set the value of Declaration.TitleBlock.Need Roll up.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:setNeedRollupForDeclaration>
        <request>
          <!--Zero or more repetitions:-->
          <AgilerequestType>
            <declarationobject>MD00022</declarationobject>
            <needrollup_value>true</needrollup_value>
          </AgilerequestType>
        </request>
      </v1:setNeedRollupForDeclaration>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <setNeedRollupForDeclarationResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType/>
      </response>
    </setNeedRollupForDeclarationResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.8.14 setCalculateOverallCompliance

Service

To calculate the value of overall compliance attribute of item/manufacturer part.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:setCalculateOverallCompliance>
        <request>
          <AgilerequestType>
            <classnumber>Parts</classnumber>
            <objectnumber>P00160</objectnumber>
            <changenumber>C00119</changenumber>
          </AgilerequestType>
        </request>
      </v1:setCalculateOverallCompliance>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response =====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <setCalculateOverallComplianceResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
      <response xmlns="">
        <messageId xsi:nil="true"/>
        <messageName xsi:nil="true"/>
        <statusCode>SUCCESS</statusCode>
        <AgileResponseType/>
      </response>
     </setCalculateOverallComplianceResponse>
    </soapenv:Body>
  </soapenv:Envelope>

A.8.15 setCalculatedComplianceForDeclarationPartSpecSubstance

Service

To set calculated compliance value for a declaration in the substances table for the object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
  <soapenv:Header/>
    <soapenv:Body>
      <v1:setCalculatedComplianceForDeclarationPartSpecSubstance>
        <request>
          <AgilerequestType>
            <declarationnumber>MD00022</declarationnumber>
            <classnumber>Parts</classnumber>
            <classnumber>Parts</classnumber>
            <objectnumber>P00160</objectnumber>
            <changenumber>C00119</changenumber>
            <spename>IEEE</spename>
            <substancename>Lead</substancename>
            <complianceEntryValue>Waived</complianceEntryValue>
          </AgilerequestType>
        </request>
      </v1:setCalculatedComplianceForDeclarationPartSpecSubstance>
    </soapenv:Body>
  </soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <setCalculatedComplianceForDeclarationPartSpecSubstanceResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Pgc/V1">
        <response xmlns="">
          <messageId xsi:nil="true"/>
          <messageName xsi:nil="true"/>
          <statusCode>FAILURE</statusCode>
          <exceptions>
            <id>-1</id>
            <exception>
              <identifier>
                <id>6032815</id>
                <name>HomogeneousMaterialDeclaration</name>
                <displayName>MD00022</displayName>
              </identifier>
            <exceptionId>90248</exceptionId>
            <message>The compliance value cannt be set due to the substance has no Threshold Mass PPM.</message>
          </exception>
        </exceptions>
      </response>
    </setCalculatedComplianceForDeclarationPartSpecSubstanceResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.9 Project Web Services

This section describes the web services operations available for Project Web Services.

A.9.1 createBaseline

Service

To create a new Project baseline.

Usage

Contains information about the Project Object and the name by which you must create the new baseline. You can save multiple baselines, and retrieve them later for comparison. Creates a baseline (snapshot) for the program object. The baseline name is sent as an input to the request. Baselines can be created only for the root program object.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createBaseline xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00007</projectIdentifier>
                  <description>TEST_BASELINE</description>
                  <kickoffBaseline>true</kickoffBaseline>
               </requests>
            </request>
         </createBaseline>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createBaselineResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <version>2</version>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00007</objectIdentifier>
                     <version>0</version>
                  </project>
               </responses>
            </response>
         </createBaselineResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.2 removeBaseline

Service

To remove the list of all baselines associated with a program object.

Usage

Contains the ClassIdentifier and the ObjectIdentifier of the Program Object on which the baselines are being removed. Also contains the name of the baselines being removed.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeBaseline xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00011</projectIdentifier>
                  <version>1</version>
               </requests>
            </request>
         </removeBaseline>
      </soapenv:Body>  
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeBaselineResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00011</objectIdentifier>
                     <version>0</version>
                  </project>
               </responses>
            </response>
         </removeBaselineResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.3 getBaselines

Service

To retrieve the list of all baselines associated with a program object.

Usage

The getBaselines operation selects a Project baseline. Request object contains the ClassIdentifier and the ObjectIdentifier of the Program Object for which the baselines are being loaded.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getBaselines xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00009</projectIdentifier>
               </requests>
            </request>
         </getBaselines>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getBaselinesResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <baselines>
                     <version>1</version>
                     <description>TEST_BASELINE</description>
                     <milestone xsi:nil="true"/>
                     <kickoffBaseline>false</kickoffBaseline>
                     <planOfRecord>true</planOfRecord>
                     <createDate>2010-05-21T08:48:52.000Z</createDate>
                  </baselines>
                  <baselines>
                     <version>2</version>
                     <description>TEST_BASELINE2</description>
                     <milestone xsi:nil="true"/>
                     <kickoffBaseline>false</kickoffBaseline>
                     <planOfRecord>false</planOfRecord>
                     <createDate>2010-05-21T08:48:52.000Z</createDate>
                  </baselines>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00009</objectIdentifier>
                     <version>0</version>
                  </project>
               </responses>
            </response>
         </getBaselinesResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.4 delegateOwnership

Service

To let the owner or program manager of a program object to assign the ownership of the program to other users by delegating it.

Usage

The delegated user receives a request which may be accepted or rejected. If the delegation is accepted, the delegated user becomes the owner of the task. A delegated owner is automatically given the Program Manager role for the delegated program object.

The web service request specifies the user to whom the ownership must be delegated and whether the act of delegation also applies to the program's children.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <delegateOwnership xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00008</projectIdentifier>
                  <userIdentifier>yvonnec</userIdentifier>
                  <applyToChildren>true</applyToChildren>
               </requests>
            </request>
         </delegateOwnership>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <delegateOwnershipResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00008</objectIdentifier>
                     <version>2</version>
                  </project>
               </responses>
            </response>
         </delegateOwnershipResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.5 substituteResource

Service

To enable the substitution of one resource, a user or a user group, with another.

Usage

For a given program, the current resource's role may be assigned to the substituted resource. When resources are to be substituted, use users and user groups. The request also specifies whether the substitution of resources is propagated to the program's children.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <substituteResource xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00014</projectIdentifier>
                  <currentResource>
                     <classIdentifier>11610</classIdentifier>
                     <objectIdentifier>badriv</objectIdentifier>
                  </currentResource>
                  <newResource>
                     <classIdentifier>11610</classIdentifier>
                     <objectIdentifier>yvonnec</objectIdentifier>
                  </newResource>
                  <applyToChildren>true</applyToChildren>
               </requests>
            </request>
         </substituteResource>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <substituteResourceResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00014</objectIdentifier>
                     <version>6</version>
                  </project>
               </responses>
            </response>
         </substituteResourceResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.6 isLocked

Service

To check the locked status of a program object.

Usage

Determines whether a Program object in Agile is locked. The request object must have the ClassIdentifier and the ObjectIdentifier of the Program Object that is being checked.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isLocked xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00010</projectIdentifier>
               </requests>
            </request>
         </isLocked>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isLockedResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isLocked>false</isLocked>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00010</objectIdentifier>
                     <version>0</version>
                  </project>
               </responses>
            </response>
         </isLockedResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.7 setLock

Service

To lock or unlock a program object.

Usage

The request object must have the ClassIdentifier and the ObjectIdentifier of the Program Object that is being locked.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <setLock xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00013</projectIdentifier>
                  <lock>false</lock>
               </requests>
            </request>
         </setLock>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <setLockResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00013</objectIdentifier>
                     <version>0</version>
                  </project>
               </responses>
            </response>
         </setLockResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.8 reschedule

Service

To reschedule a Program object.

Usage

Once a program's schedule has been defined, use this operation to reschedule it. The operation enables the client to change the startdate and endDate, and move the program backward or forward.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <reschedule xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00012</projectIdentifier>
                  <rescheduleType>
                     <startDate>2009-08-14T18:30:00.000Z</startDate>
                  </rescheduleType>
               </requests>
            </request>
         </reschedule>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <rescheduleResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00012</objectIdentifier>
                     <version>2</version>
                  </project>
               </responses>
            </response>
         </rescheduleResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.9 assignUsersFromPool

Service

To assign Users from a resource pool.

Usage

In Agile Web Client, when you add a resource pool to the Team table, you can replace the pool with one or more resources contained within it. That is, instead of assigning the entire resource pool, you can assign select users from the pool. The operation reproduces this functionality. The operation makes detailed resource assignments by selecting a specific user from a group used as team member.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <assignUsersFromPool xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <request xmlns="">
               <requests>
                  <projectIdentifier>PGM00006</projectIdentifier>
                  <users>demo1</users>
                  <usergroup>TEST_USER_GROUP_NAME747945</usergroup>
               </requests>
            </request>
         </assignUsersFromPool>
      </soapenv:Body>
   </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <assignUsersFromPoolResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <project>
                     <classIdentifier>Program</classIdentifier>
                     <objectIdentifier>PGM00006</objectIdentifier>
                     <version>4</version>
                  </project>
               </responses>
            </response>
         </assignUsersFromPoolResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.10 loadProject

Service

To load PPM Projects.

Sample Code

SOAP

========request========
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:loadProjects>
         <request>
            <projectIdentifiers>
               <className>Program</className>
               <objectName>PGM00001</objectName>
            </projectIdentifiers>
         </request>
      </v1:loadProjects>
   </soapenv:Body>
</soapenv:Envelope>
 
=======response=======
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <loadProjectsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <projects>
               <project>
                  <treeLocked>false</treeLocked>
                  <readOnly>false</readOnly>
                  <projectId>
                     <classId>18022</classId>
                     <className>ActivitiesClass</className>
                     <classDisplayName>Activities</classDisplayName>
                     <objectId>121</objectId>
                     <objectName>PGM00001</objectName>
                     <version>0</version>
                     <subClassId>18027</subClassId>
                     <subClassName>Program</subClassName>
                     <subClassDisplayName>Program</subClassDisplayName>
                     <objectDisplayName>G1</objectDisplayName>
                  </projectId>
                  <selectedRootId>
                     <classId>18022</classId>
                     <className>ActivitiesClass</className>
                     <classDisplayName>Activities</classDisplayName>
                     <objectId>121</objectId>
                     <objectName>PGM00001</objectName>
                     <version>0</version>
                     <subClassId>18027</subClassId>
                     <subClassName>Program</subClassName>
                     <subClassDisplayName>Program</subClassDisplayName>
                     <objectDisplayName>G1</objectDisplayName>
                  </selectedRootId>
                  <projectVersion>0</projectVersion>
                  <languageCode>en-us</languageCode>
                  <tasks>
                     <task>
                        <taskId>
                           <classId>18022</classId>
                           <className>ActivitiesClass</className>
                           <classDisplayName>Activities</classDisplayName>
                           <objectId>121</objectId>
                           <objectName>PGM00001</objectName>
                           <version>0</version>
                           <subClassId>18027</subClassId>
                           <subClassName>Program</subClassName>
                           <subClassDisplayName>Program</subClassDisplayName>
                           <objectDisplayName>G1</objectDisplayName>
                        </taskId>
                        <actualCapitalExpenses>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </actualCapitalExpenses>
                        <actualDuration>0</actualDuration>
                        <actualDurationVarianceWorkDays>0</actualDurationVarianceWorkDays>
                        <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                        <actualFixedCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </actualFixedCost>
                        <actualFlexCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </actualFlexCost>
                        <actualLaborCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </actualLaborCost>
                        <actualStartVarianceWorkDays>0</actualStartVarianceWorkDays>
                        <actualTimeInDays>0</actualTimeInDays>
                        <auditScore>0</auditScore>
                        <budgetedCapitalExpenses>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </budgetedCapitalExpenses>
                        <budgetedFixedCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </budgetedFixedCost>
                        <budgetedFlexCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </budgetedFlexCost>
                        <budgetedLaborCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </budgetedLaborCost>
                        <budgetedTimeInDays>0</budgetedTimeInDays>
                        <costStatus>
                           <selection>
                              <id xsi:nil="true"/>
                              <apiName xsi:nil="true"/>
                              <value xsi:nil="true"/>
                           </selection>
                        </costStatus>
                        <critical>false</critical>
                        <daysEffort>0</daysEffort>
                        <deliverablesStatus>
                           <status>
                              <statusType>
                                 <listName>StatusTypeSelection</listName>
                                 <selection>
                                    <id>4</id>
                                    <apiName>COMPLETE</apiName>
                                    <value>Complete</value>
                                 </selection>
                              </statusType>
                              <statusMet>true</statusMet>
                           </status>
                           <status>
                              <statusType>
                                 <listName>StatusTypeSelection</listName>
                                 <selection>
                                    <id>2</id>
                                    <apiName>REVIEW</apiName>
                                    <value>Review</value>
                                 </selection>
                              </statusType>
                              <statusMet>true</statusMet>
                           </status>
                        </deliverablesStatus>
                        <durationType>
                           <listName>DurationTypeList</listName>
                           <selection>
                              <id>2</id>
                              <apiName>FIXED</apiName>
                              <value>Fixed</value>
                           </selection>
                        </durationType>
                        <estimatedCapitalExpensesToCompletion>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </estimatedCapitalExpensesToCompletion>
                        <estimatedDuration>0</estimatedDuration>
                        <estimatedDurationVarianceWorkDays>0</estimatedDurationVarianceWorkDays>
                        <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                        <estimatedFixedCostToCompletion>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </estimatedFixedCostToCompletion>
                        <estimatedFlexCostToCompletion>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </estimatedFlexCostToCompletion>
                        <estimatedLaborCostToCompletion>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </estimatedLaborCostToCompletion>
                        <estimatedStartVarianceWorkDays>0</estimatedStartVarianceWorkDays>
                        <estimatedTimeToCompletion>0</estimatedTimeToCompletion>
                        <global>false</global>
                        <leaf>true</leaf>
                        <name>G1</name>
                        <number>PGM00001</number>
                        <overallStatus>
                           <selection>
                              <id xsi:nil="true"/>
                              <apiName xsi:nil="true"/>
                              <value xsi:nil="true"/>
                           </selection>
                        </overallStatus>
                        <owner>
                           <classId>11605</classId>
                           <className>UsersClass</className>
                           <classDisplayName>users</classDisplayName>
                           <objectId>704</objectId>
                           <objectName>admin</objectName>
                           <version>0</version>
                           <subClassId>11610</subClassId>
                           <subClassName>User</subClassName>
                           <subClassDisplayName>User</subClassDisplayName>
                           <objectDisplayName>Administrator, a (admin)</objectDisplayName>
                        </owner>
                        <percentComplete>0</percentComplete>
                        <PLMReference>
                           <agileObjectListEntry>
                              <listName>AllObjects</listName>
                           </agileObjectListEntry>
                        </PLMReference>
                        <projectKeywords>
                           <listName>KeywordsList</listName>
                           <selection>
                              <id>1</id>
                              <apiName>IMPORTANT_CONTENT</apiName>
                              <value>Important Content</value>
                           </selection>
                        </projectKeywords>
                        <projectState>
                           <listName>ActivityStateList</listName>
                           <selection>
                              <id>2</id>
                              <apiName>PROPOSED</apiName>
                              <value>Proposed</value>
                           </selection>
                        </projectState>
                        <qualityStatus>
                           <selection>
                              <id xsi:nil="true"/>
                              <apiName xsi:nil="true"/>
                              <value xsi:nil="true"/>
                           </selection>
                        </qualityStatus>
                        <resourceStatus>
                           <selection>
                              <id xsi:nil="true"/>
                              <apiName xsi:nil="true"/>
                              <value xsi:nil="true"/>
                           </selection>
                        </resourceStatus>
                        <rollupHealthStatus>true</rollupHealthStatus>
                        <scheduleDuration>28800000</scheduleDuration>
                        <scheduleEditor>
                           <listName>ScheduleEditorList</listName>
                           <selection>
                              <id>0</id>
                              <apiName>PPM</apiName>
                              <value>PPM</value>
                           </selection>
                        </scheduleEditor>
                        <scheduleEndDate>2015-01-23T17:00:00.000Z</scheduleEndDate>
                        <scheduleStartDate>2015-01-23T08:00:00.000Z</scheduleStartDate>
                        <scheduleStatus>
                           <selection>
                              <id xsi:nil="true"/>
                              <apiName xsi:nil="true"/>
                              <value xsi:nil="true"/>
                           </selection>
                        </scheduleStatus>
                        <status>
                           <selection>
                              <id>18516</id>
                              <apiName>DefaultActivities.NotStarted</apiName>
                              <value>Default Activities.Not Started</value>
                           </selection>
                        </status>
                        <statusType>
                           <listName>StatusTypeSelection</listName>
                           <selection>
                              <id>0</id>
                              <apiName>PENDING</apiName>
                              <value>Pending</value>
                           </selection>
                        </statusType>
                        <totalActualCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </totalActualCost>
                        <totalBudgetedCost>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </totalBudgetedCost>
                        <totalEstimatedCostToCompletion>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </totalEstimatedCostToCompletion>
                        <type>
                           <selection>
                              <id>18027</id>
                              <apiName>Program</apiName>
                              <value>Program</value>
                           </selection>
                        </type>
                        <weight>0.0</weight>
                        <workflow>
                           <selection>
                              <id>18512</id>
                              <apiName>DefaultActivities</apiName>
                              <value>Default Activities</value>
                           </selection>
                        </workflow>
                        <pageTwo/>
                        <pageThree/>
                     </task>
                  </tasks>
                  <resources>
                     <resource>
                        <resourceId>
                           <classId>11605</classId>
                           <className>UsersClass</className>
                           <classDisplayName>users</classDisplayName>
                           <objectId>704</objectId>
                           <objectName>admin</objectName>
                           <version>0</version>
                           <subClassId>11610</subClassId>
                           <subClassName>User</subClassName>
                           <subClassDisplayName>User</subClassDisplayName>
                           <objectDisplayName>Administrator, a (admin)</objectDisplayName>
                        </resourceId>
                        <name>Administrator, a (admin)</name>
                        <firstName>a</firstName>
                        <lastName>Administrator</lastName>
                        <userID>admin</userID>
                        <laborRate>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </laborRate>
                        <status>
                           <listName>ActiveInactiveList</listName>
                           <selection>
                              <id>1</id>
                              <apiName>ACTIVE</apiName>
                              <value>Active</value>
                           </selection>
                        </status>
                        <email>a</email>
                        <overheadRate>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </overheadRate>
                     </resource>
                  </resources>
                  <assignments>
                     <assignment>
                        <taskID>
                           <classId>18022</classId>
                           <className>ActivitiesClass</className>
                           <classDisplayName>Activities</classDisplayName>
                           <objectId>121</objectId>
                           <objectName>PGM00001</objectName>
                           <version>0</version>
                           <subClassId>18027</subClassId>
                           <subClassName>Program</subClassName>
                           <subClassDisplayName>Program</subClassDisplayName>
                           <objectDisplayName>G1</objectDisplayName>
                        </taskID>
                        <actualHours>0</actualHours>
                        <daysEffort>0</daysEffort>
                        <id>
                           <id>122</id>
                           <name>Team</name>
                           <displayName>Administrator, a (admin)</displayName>
                        </id>
                        <laborCostValue>
                           <amount>0.0</amount>
                           <currency>USD</currency>
                        </laborCostValue>
                        <allocation>0.0</allocation>
                        <rejectedFlag>false</rejectedFlag>
                        <name>
                           <classId>11605</classId>
                           <className>UsersClass</className>
                           <classDisplayName>users</classDisplayName>
                           <objectId>704</objectId>
                           <objectName>admin</objectName>
                           <version>0</version>
                           <subClassId>11610</subClassId>
                           <subClassName>User</subClassName>
                           <subClassDisplayName>User</subClassDisplayName>
                           <objectDisplayName>Administrator, a (admin)</objectDisplayName>
                        </name>
                        <roles>
                           <selection>
                              <id>9507</id>
                              <apiName>ProgramManager</apiName>
                              <value>Program Manager</value>
                           </selection>
                        </roles>
                     </assignment>
                  </assignments>
                  <treeInfo/>
               </project>
            </projects>
         </response>
      </loadProjectsResponse>
   </soapenv:Body>
</soapenv:Envelope>







A.9.11 updateProject

Service

To update a PPM Project.

Sample Code

SOAP

========request========
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <ns1:updateProjects xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
      <request xmlns="">
        <messageId>Project WS Sample - UpdateNewProject</messageId>
        <messageName>Project WS Sample - UpdateNewProject</messageName>
        <projects>
          <project>
            <treeLocked>false</treeLocked>
            <readOnly>false</readOnly>
            <projectId>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>-10006</objectId>
              <version>0</version>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421977274712</objectDisplayName>
            </projectId>
            <selectedRootId>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>-10006</objectId>
              <version>0</version>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421977274712</objectDisplayName>
            </selectedRootId>
            <projectVersion>0</projectVersion>
            <languageCode>en-us</languageCode>
            <tasks>
              <task>
                <taskId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </taskId>
                <actualCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualCapitalExpenses>
                <actualDuration>0</actualDuration>
                <actualDurationVarianceWorkDays>0</actualDurationVarianceWorkDays>
                <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                <actualFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFixedCost>
                <actualFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFlexCost>
                <actualLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualLaborCost>
                <actualStartVarianceWorkDays>0</actualStartVarianceWorkDays>
                <actualTimeInDays>0</actualTimeInDays>
                <auditScore>0</auditScore>
                <budgetedCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedCapitalExpenses>
                <budgetedFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFixedCost>
                <budgetedFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFlexCost>
                <budgetedLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedLaborCost>
                <budgetedTimeInDays>114048000</budgetedTimeInDays>
                <costStatus>
                  <selection>
                    <id>18784</id>
                    <apiName>OnBudget</apiName>
                    <value>On Budget</value>
                  </selection>
                </costStatus>
                <costStatusReason>Children are On Budget</costStatusReason>
                <critical>false</critical>
                <daysEffort>114048000</daysEffort>
                <deliverablesStatus/>
                <description>Test1421977274712</description>
                <durationType>
                  <listName>DurationTypeList</listName>
                  <selection>
                    <id>2</id>
                    <apiName>FIXED</apiName>
                    <value>Fixed</value>
                  </selection>
                </durationType>
                <estimatedCapitalExpensesToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedCapitalExpensesToCompletion>
                <estimatedDuration>0</estimatedDuration>
                <estimatedDurationVarianceWorkDays>0</estimatedDurationVarianceWorkDays>
                <estimatedEndDate>2009-10-07T17:00:00.000Z</estimatedEndDate>
                <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                <estimatedFixedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFixedCostToCompletion>
                <estimatedFlexCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFlexCostToCompletion>
                <estimatedLaborCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedLaborCostToCompletion>
                <estimatedStartDate>2009-09-26T08:00:00.000Z</estimatedStartDate>
                <estimatedStartVarianceWorkDays>0</estimatedStartVarianceWorkDays>
                <estimatedTimeToCompletion>0</estimatedTimeToCompletion>
                <global>false</global>
                <leaf>false</leaf>
                <name>Test1421977274712</name>
                <overallStatus>
                  <selection>
                    <id>18817</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </overallStatus>
                <owner>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </owner>
                <percentComplete>0</percentComplete>
                <projectKeywords>
                  <listName>KeywordsList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>IMPORTANT_CONTENT</apiName>
                    <value>Important Content</value>
                  </selection>
                </projectKeywords>
                <projectState>
                  <listName>ActivityStateList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </projectState>
                <rollupHealthStatus>true</rollupHealthStatus>
                <scheduleDuration>259200000</scheduleDuration>
                <scheduleEditor>
                  <listName>ScheduleEditorList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PPM</apiName>
                    <value>PPM</value>
                  </selection>
                </scheduleEditor>
                <scheduleEndDate>2009-10-07T17:00:00.000Z</scheduleEndDate>
                <scheduleStartDate>2009-09-26T08:00:00.000Z</scheduleStartDate>
                <scheduleStatus>
                  <selection>
                    <id>18674</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </scheduleStatus>
                <scheduleStatusReason>Children are On Track</scheduleStatusReason>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PENDING</apiName>
                    <value>Pending</value>
                  </selection>
                </statusType>
                <totalBudgetedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalBudgetedCost>
                <totalEstimatedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalEstimatedCostToCompletion>
                <type>
                  <selection>
                    <id>18027</id>
                    <apiName>Program</apiName>
                    <value>Program</value>
                  </selection>
                </type>
                <weight>0.0</weight>
                <pageTwo>
                  <flexEntry>
                    <apiName>money01</apiName>
                    <value xmlns:ns1="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" xsi:type="ns1:AgileMoneyType">
                      <amount>66.0</amount>
                      <currency>INR</currency>
                    </value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>date01</apiName>
                    <value xsi:type="xsd:dateTime">2009-09-23T14:22:00.000Z</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>multiList01</apiName>
                    <value xmlns:ns2="http://xmlns.oracle.com/AgileObjects/Core/Project/V1" xsi:type="ns2:ProjectListType">
                      <agileListEntry>
                        <listName>COLORS</listName>
                        <selection>
                          <value>Green</value>
                        </selection>
                        <selection>
                          <value>Pink</value>
                        </selection>
                      </agileListEntry>
                    </value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>multiText10</apiName>
                    <value xsi:type="xsd:string">MultiText</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>text01</apiName>
                    <value xsi:type="xsd:string">Text</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>list01</apiName>
                    <value xmlns:ns3="http://xmlns.oracle.com/AgileObjects/Core/Project/V1" xsi:type="ns3:ProjectListType">
                      <agileListEntry>
                        <listName>COLORS</listName>
                        <selection>
                          <value>Green</value>
                        </selection>
                      </agileListEntry>
                    </value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>numeric01</apiName>
                    <value xsi:type="xsd:string">44</value>
                  </flexEntry>
                </pageTwo>
                <pageThree/>
              </task>
              <task>
                <taskId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10008</objectId>
                  <version>0</version>
                  <subClassName>Phase</subClassName>
                  <subClassDisplayName>Phase</subClassDisplayName>
                  <objectDisplayName>Phase1</objectDisplayName>
                </taskId>
                <actualCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualCapitalExpenses>
                <actualDuration>0</actualDuration>
                <actualDurationVarianceWorkDays>0</actualDurationVarianceWorkDays>
                <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                <actualFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFixedCost>
                <actualFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFlexCost>
                <actualLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualLaborCost>
                <actualStartVarianceWorkDays>0</actualStartVarianceWorkDays>
                <actualTimeInDays>0</actualTimeInDays>
                <auditScore>0</auditScore>
                <budgetedCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedCapitalExpenses>
                <budgetedFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFixedCost>
                <budgetedFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFlexCost>
                <budgetedLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedLaborCost>
                <budgetedTimeInDays>114048000</budgetedTimeInDays>
                <costStatus>
                  <selection>
                    <id>18784</id>
                    <apiName>OnBudget</apiName>
                    <value>On Budget</value>
                  </selection>
                </costStatus>
                <costStatusReason>Children are On Budget</costStatusReason>
                <critical>false</critical>
                <daysEffort>114048000</daysEffort>
                <deliverablesStatus/>
                <durationType>
                  <listName>DurationTypeList</listName>
                  <selection>
                    <id>2</id>
                    <apiName>FIXED</apiName>
                    <value>Fixed</value>
                  </selection>
                </durationType>
                <estimatedCapitalExpensesToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedCapitalExpensesToCompletion>
                <estimatedDuration>0</estimatedDuration>
                <estimatedDurationVarianceWorkDays>0</estimatedDurationVarianceWorkDays>
                <estimatedEndDate>2009-10-07T17:00:00.000Z</estimatedEndDate>
                <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                <estimatedFixedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFixedCostToCompletion>
                <estimatedFlexCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFlexCostToCompletion>
                <estimatedLaborCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedLaborCostToCompletion>
                <estimatedStartDate>2009-09-26T08:00:00.000Z</estimatedStartDate>
                <estimatedStartVarianceWorkDays>0</estimatedStartVarianceWorkDays>
                <estimatedTimeToCompletion>0</estimatedTimeToCompletion>
                <global>false</global>
                <leaf>false</leaf>
                <name>Phase1</name>
                <overallStatus>
                  <selection>
                    <id>18817</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </overallStatus>
                <owner>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </owner>
                <parent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </parent>
                <percentComplete>0</percentComplete>
                <projectKeywords>
                  <listName>KeywordsList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>IMPORTANT_CONTENT</apiName>
                    <value>Important Content</value>
                  </selection>
                </projectKeywords>
                <projectState>
                  <listName>ActivityStateList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </projectState>
                <rollupHealthStatus>true</rollupHealthStatus>
                <rootParent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </rootParent>
                <scheduleDuration>259200000</scheduleDuration>
                <scheduleEditor>
                  <listName>ScheduleEditorList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PPM</apiName>
                    <value>PPM</value>
                  </selection>
                </scheduleEditor>
                <scheduleEndDate>2009-10-07T17:00:00.000Z</scheduleEndDate>
                <scheduleStartDate>2009-09-26T08:00:00.000Z</scheduleStartDate>
                <scheduleStatus>
                  <selection>
                    <id>18674</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </scheduleStatus>
                <scheduleStatusReason>Children are On Track</scheduleStatusReason>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PENDING</apiName>
                    <value>Pending</value>
                  </selection>
                </statusType>
                <totalBudgetedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalBudgetedCost>
                <totalEstimatedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalEstimatedCostToCompletion>
                <type>
                  <selection>
                    <id>18028</id>
                    <apiName>Phase</apiName>
                    <value>Phase</value>
                  </selection>
                </type>
                <weight>0.0</weight>
                <pageTwo/>
                <pageThree/>
              </task>
              <task>
                <taskId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task1</objectDisplayName>
                </taskId>
                <actualCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualCapitalExpenses>
                <actualDuration>0</actualDuration>
                <actualDurationVarianceWorkDays>0</actualDurationVarianceWorkDays>
                <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                <actualFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFixedCost>
                <actualFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFlexCost>
                <actualLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualLaborCost>
                <actualStartVarianceWorkDays>0</actualStartVarianceWorkDays>
                <actualTimeInDays>0</actualTimeInDays>
                <auditScore>0</auditScore>
                <budgetedCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedCapitalExpenses>
                <budgetedFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFixedCost>
                <budgetedFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFlexCost>
                <budgetedLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedLaborCost>
                <budgetedTimeInDays>114048000</budgetedTimeInDays>
                <costStatus>
                  <selection>
                    <id>18784</id>
                    <apiName>OnBudget</apiName>
                    <value>On Budget</value>
                  </selection>
                </costStatus>
                <critical>false</critical>
                <daysEffort>114048000</daysEffort>
                <deliverablesStatus/>
                <durationType>
                  <listName>DurationTypeList</listName>
                  <selection>
                    <id>2</id>
                    <apiName>FIXED</apiName>
                    <value>Fixed</value>
                  </selection>
                </durationType>
                <estimatedCapitalExpensesToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedCapitalExpensesToCompletion>
                <estimatedDuration>0</estimatedDuration>
                <estimatedDurationVarianceWorkDays>0</estimatedDurationVarianceWorkDays>
                <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                <estimatedFixedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFixedCostToCompletion>
                <estimatedFlexCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFlexCostToCompletion>
                <estimatedLaborCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedLaborCostToCompletion>
                <estimatedStartVarianceWorkDays>0</estimatedStartVarianceWorkDays>
                <estimatedTimeToCompletion>0</estimatedTimeToCompletion>
                <global>false</global>
                <leaf>true</leaf>
                <name>Task1</name>
                <overallStatus>
                  <selection>
                    <id>18817</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </overallStatus>
                <owner>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </owner>
                <parent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10008</objectId>
                  <version>0</version>
                  <subClassName>Phase</subClassName>
                  <subClassDisplayName>Phase</subClassDisplayName>
                  <objectDisplayName>Phase1</objectDisplayName>
                </parent>
                <percentComplete>0</percentComplete>
                <projectKeywords>
                  <listName>KeywordsList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>IMPORTANT_CONTENT</apiName>
                    <value>Important Content</value>
                  </selection>
                </projectKeywords>
                <projectState>
                  <listName>ActivityStateList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </projectState>
                <rollupHealthStatus>true</rollupHealthStatus>
                <rootParent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </rootParent>
                <scheduleDuration>115200000</scheduleDuration>
                <scheduleEditor>
                  <listName>ScheduleEditorList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PPM</apiName>
                    <value>PPM</value>
                  </selection>
                </scheduleEditor>
                <scheduleEndDate>2009-09-30T17:00:00.000Z</scheduleEndDate>
                <scheduleStartDate>2009-09-26T08:00:00.000Z</scheduleStartDate>
                <scheduleStatus>
                  <selection>
                    <id>18674</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </scheduleStatus>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PENDING</apiName>
                    <value>Pending</value>
                  </selection>
                </statusType>
                <totalBudgetedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalBudgetedCost>
                <totalEstimatedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalEstimatedCostToCompletion>
                <type>
                  <selection>
                    <id>18029</id>
                    <apiName>Task</apiName>
                    <value>Task</value>
                  </selection>
                </type>
                <weight>0.0</weight>
                <pageTwo>
                  <flexEntry>
                    <apiName>numeric01</apiName>
                    <value xsi:type="xsd:string">0.0</value>
                  </flexEntry>
                </pageTwo>
                <pageThree>
                  <flexEntry>
                    <apiName>list01</apiName>
                    <value xmlns:ns4="http://xmlns.oracle.com/AgileObjects/Core/Project/V1" xsi:type="ns4:ProjectListType">
                      <agileListEntry>
                        <listName>NUMBER</listName>
                        <selection>
                          <value>Five</value>
                        </selection>
                      </agileListEntry>
                    </value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>numeric01</apiName>
                    <value xsi:type="xsd:string">15</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>multiText10</apiName>
                    <value xsi:type="xsd:string">MultiText</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>date01</apiName>
                    <value xsi:type="xsd:dateTime">2009-09-30T14:25:00.000Z</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>money01</apiName>
                    <value xmlns:ns5="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" xsi:type="ns5:AgileMoneyType">
                      <amount>15.0</amount>
                      <currency>INR</currency>
                    </value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>text01</apiName>
                    <value xsi:type="xsd:string">Text</value>
                  </flexEntry>
                  <flexEntry>
                    <apiName>multiList01</apiName>
                    <value xmlns:ns6="http://xmlns.oracle.com/AgileObjects/Core/Project/V1" xsi:type="ns6:ProjectListType">
                      <agileListEntry>
                        <listName>NUMBER</listName>
                        <selection>
                          <value>Nine</value>
                        </selection>
                        <selection>
                          <value>One</value>
                        </selection>
                        <selection>
                          <value>Seven</value>
                        </selection>
                      </agileListEntry>
                    </value>
                  </flexEntry>
                </pageThree>
              </task>
              <task>
                <taskId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10011</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task2</objectDisplayName>
                </taskId>
                <actualCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualCapitalExpenses>
                <actualDuration>0</actualDuration>
                <actualDurationVarianceWorkDays>0</actualDurationVarianceWorkDays>
                <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                <actualFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFixedCost>
                <actualFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFlexCost>
                <actualLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualLaborCost>
                <actualStartVarianceWorkDays>0</actualStartVarianceWorkDays>
                <actualTimeInDays>0</actualTimeInDays>
                <auditScore>0</auditScore>
                <budgetedCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedCapitalExpenses>
                <budgetedFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFixedCost>
                <budgetedFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFlexCost>
                <budgetedLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedLaborCost>
                <budgetedTimeInDays>0</budgetedTimeInDays>
                <costStatus>
                  <selection>
                    <id>18784</id>
                    <apiName>OnBudget</apiName>
                    <value>On Budget</value>
                  </selection>
                </costStatus>
                <critical>false</critical>
                <daysEffort>0</daysEffort>
                <deliverablesStatus/>
                <durationType>
                  <listName>DurationTypeList</listName>
                  <selection>
                    <id>2</id>
                    <apiName>FIXED</apiName>
                    <value>Fixed</value>
                  </selection>
                </durationType>
                <estimatedCapitalExpensesToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedCapitalExpensesToCompletion>
                <estimatedDuration>0</estimatedDuration>
                <estimatedDurationVarianceWorkDays>0</estimatedDurationVarianceWorkDays>
                <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                <estimatedFixedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFixedCostToCompletion>
                <estimatedFlexCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFlexCostToCompletion>
                <estimatedLaborCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedLaborCostToCompletion>
                <estimatedStartVarianceWorkDays>0</estimatedStartVarianceWorkDays>
                <estimatedTimeToCompletion>0</estimatedTimeToCompletion>
                <global>false</global>
                <leaf>true</leaf>
                <name>Task2</name>
                <overallStatus>
                  <selection>
                    <id>18817</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </overallStatus>
                <owner>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </owner>
                <parent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10008</objectId>
                  <version>0</version>
                  <subClassName>Phase</subClassName>
                  <subClassDisplayName>Phase</subClassDisplayName>
                  <objectDisplayName>Phase1</objectDisplayName>
                </parent>
                <percentComplete>0</percentComplete>
                <projectKeywords>
                  <listName>KeywordsList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>IMPORTANT_CONTENT</apiName>
                    <value>Important Content</value>
                  </selection>
                </projectKeywords>
                <projectState>
                  <listName>ActivityStateList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </projectState>
                <rollupHealthStatus>true</rollupHealthStatus>
                <rootParent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </rootParent>
                <scheduleDuration>144000000</scheduleDuration>
                <scheduleEditor>
                  <listName>ScheduleEditorList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PPM</apiName>
                    <value>PPM</value>
                  </selection>
                </scheduleEditor>
                <scheduleEndDate>2009-10-07T17:00:00.000Z</scheduleEndDate>
                <scheduleStartDate>2009-10-01T08:00:00.000Z</scheduleStartDate>
                <scheduleStatus>
                  <selection>
                    <id>18674</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </scheduleStatus>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PENDING</apiName>
                    <value>Pending</value>
                  </selection>
                </statusType>
                <totalBudgetedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalBudgetedCost>
                <totalEstimatedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalEstimatedCostToCompletion>
                <type>
                  <selection>
                    <id>18029</id>
                    <apiName>Task</apiName>
                    <value>Task</value>
                  </selection>
                </type>
                <weight>0.0</weight>
                <pageTwo/>
                <pageThree/>
              </task>
              <task>
                <taskId>
                  <className>GatesClass</className>
                  <classDisplayName>Gates</classDisplayName>
                  <objectId>-10010</objectId>
                  <version>0</version>
                  <subClassName>Gate</subClassName>
                  <subClassDisplayName>Gate</subClassDisplayName>
                  <objectDisplayName>Gate1</objectDisplayName>
                </taskId>
                <actualDuration>0</actualDuration>
                <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                <auditScore>0</auditScore>
                <costStatus>
                  <selection>
                    <id>18784</id>
                    <apiName>OnBudget</apiName>
                    <value>On Budget</value>
                  </selection>
                </costStatus>
                <critical>false</critical>
                <deliverablesStatus/>
                <estimatedDuration>0</estimatedDuration>
                <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                <global>false</global>
                <leaf>true</leaf>
                <name>Gate1</name>
                <overallStatus>
                  <selection>
                    <id>18817</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </overallStatus>
                <owner>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </owner>
                <parent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </parent>
                <projectKeywords>
                  <listName>KeywordsList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>IMPORTANT_CONTENT</apiName>
                    <value>Important Content</value>
                  </selection>
                </projectKeywords>
                <projectState>
                  <listName>ActivityStateList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </projectState>
                <rollupHealthStatus>true</rollupHealthStatus>
                <rootParent>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </rootParent>
                <scheduleDuration>0</scheduleDuration>
                <scheduleEditor>
                  <listName>ScheduleEditorList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PPM</apiName>
                    <value>PPM</value>
                  </selection>
                </scheduleEditor>
                <scheduleEndDate>2009-09-30T17:00:00.000Z</scheduleEndDate>
                <scheduleStatus>
                  <selection>
                    <id>18674</id>
                    <apiName>OnTrack</apiName>
                    <value>On Track</value>
                  </selection>
                </scheduleStatus>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PENDING</apiName>
                    <value>Pending</value>
                  </selection>
                </statusType>
                <type>
                  <selection>
                    <id>18401</id>
                    <apiName>Gate</apiName>
                    <value>Gate</value>
                  </selection>
                </type>
                <weight>0.0</weight>
                <pageTwo/>
                <pageThree/>
              </task>
            </tasks>
            <resources>
              <resource>
                <resourceId>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </resourceId>
                <name>Administrator (admin)</name>
                <firstName/>
                <lastName>Administrator</lastName>
                <userID>admin</userID>
                <status>
                  <listName>ActiveInactiveList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </status>
                <email/>
              </resource>
              <resource>
                <resourceId>
                  <className>UserGroupsClass</className>
                  <classDisplayName>User groups</classDisplayName>
                  <version>0</version>
                  <subClassName>UserGroup</subClassName>
                  <subClassDisplayName>User Group</subClassDisplayName>
                  <objectName>TestPPMWSUsrGroup2</objectName>
                  <objectDisplayName>TestPPMWSUsrGroup2</objectDisplayName>
                </resourceId>
                <name>TestPPMWSUsrGroup2</name>
                <status>
                  <listName>ActiveInactiveList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </status>
                <title/>
              </resource>
              <resource>
                <resourceId>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>testppmwsusr1</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>(testppmwsusr1)</objectDisplayName>
                </resourceId>
                <name>(testppmwsusr1)</name>
                <firstName/>
                <lastName/>
                <userID>testppmwsusr1</userID>
                <status>
                  <listName>ActiveInactiveList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </status>
                <title/>
              </resource>
              <resource>
                <resourceId>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>testppmwsusr2</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>(testppmwsusr2)</objectDisplayName>
                </resourceId>
                <name>(testppmwsusr2)</name>
                <firstName/>
                <lastName/>
                <userID>testppmwsusr2</userID>
                <status>
                  <listName>ActiveInactiveList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </status>
                <title/>
              </resource>
            </resources>
            <assignments>
              <assignment>
                <taskID>
                  <className>GatesClass</className>
                  <classDisplayName>Gates</classDisplayName>
                  <objectId>-10010</objectId>
                  <version>0</version>
                  <subClassName>Gate</subClassName>
                  <subClassDisplayName>Gate</subClassDisplayName>
                  <objectDisplayName>Gate1</objectDisplayName>
                </taskID>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>Administrator (admin)</displayName>
                </id>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9507</id>
                    <apiName>ProgramManager</apiName>
                    <value>Program Manager</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task1</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>(testppmwsusr1)</displayName>
                </id>
                <allocation>44.0</allocation>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>testppmwsusr1</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>(testppmwsusr1)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9506</id>
                    <apiName>ProgramTeamMember</apiName>
                    <value>Program Team Member</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task1</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>Administrator (admin)</displayName>
                </id>
                <allocation>0.0</allocation>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9507</id>
                    <apiName>ProgramManager</apiName>
                    <value>Program Manager</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task1</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>(testppmwsusr2)</displayName>
                </id>
                <allocation>22.0</allocation>
                <assignedFrom>
                  <className>UserGroupsClass</className>
                  <classDisplayName>User groups</classDisplayName>
                  <objectName>TestPPMWSUsrGroup1</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectName>TestPPMWSUsrGroup1</objectName>
                  <objectDisplayName>TestPPMWSUsrGroup1</objectDisplayName>
                </assignedFrom>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>testppmwsusr2</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>(testppmwsusr2)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9506</id>
                    <apiName>ProgramTeamMember</apiName>
                    <value>Program Team Member</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task1</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>TestPPMWSUsrGroup2</displayName>
                </id>
                <allocation>33.0</allocation>
                <assignedFrom>
                  <className>UserGroupsClass</className>
                  <classDisplayName>User groups</classDisplayName>
                  <version>0</version>
                  <subClassName>UserGroup</subClassName>
                  <subClassDisplayName>User Group</subClassDisplayName>
                  <objectName>TestPPMWSUsrGroup2</objectName>
                  <objectDisplayName>TestPPMWSUsrGroup2</objectDisplayName>
                </assignedFrom>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UserGroupsClass</className>
                  <classDisplayName>User groups</classDisplayName>
                  <version>0</version>
                  <subClassName>UserGroup</subClassName>
                  <subClassDisplayName>User Group</subClassDisplayName>
                  <objectName>TestPPMWSUsrGroup2</objectName>
                  <objectDisplayName>TestPPMWSUsrGroup2</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9506</id>
                    <apiName>ProgramTeamMember</apiName>
                    <value>Program Team Member</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10011</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task2</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>Administrator (admin)</displayName>
                </id>
                <allocation>0.0</allocation>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9507</id>
                    <apiName>ProgramManager</apiName>
                    <value>Program Manager</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>Administrator (admin)</displayName>
                </id>
                <allocation>0.0</allocation>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9507</id>
                    <apiName>ProgramManager</apiName>
                    <value>Program Manager</value>
                  </selection>
                </roles>
              </assignment>
              <assignment>
                <taskID>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10008</objectId>
                  <version>0</version>
                  <subClassName>Phase</subClassName>
                  <subClassDisplayName>Phase</subClassDisplayName>
                  <objectDisplayName>Phase1</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>Administrator (admin)</displayName>
                </id>
                <allocation>0.0</allocation>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9507</id>
                    <apiName>ProgramManager</apiName>
                    <value>Program Manager</value>
                  </selection>
                </roles>
              </assignment>
            </assignments>
            <dependencies>
              <dependency>
                <predecessorTaskId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task1</objectDisplayName>
                </predecessorTaskId>
                <successorTaskId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10011</objectId>
                  <version>0</version>
                  <subClassName>Task</subClassName>
                  <subClassDisplayName>Task</subClassDisplayName>
                  <objectDisplayName>Task2</objectDisplayName>
                </successorTaskId>
                <timeBuffer>0</timeBuffer>
                <type>
                  <listName>DependencyType</listName>
                  <selection>
                    <id>1</id>
                    <apiName>FINISH_TO_START_FS</apiName>
                    <value>Finish-to-Start (FS)</value>
                  </selection>
                </type>
                <externalFlag>false</externalFlag>
              </dependency>
            </dependencies>
            <treeInfo>
              <parent>
                <id>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10006</objectId>
                  <version>0</version>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421977274712</objectDisplayName>
                </id>
                <children>
                  <child>
                    <className>ActivitiesClass</className>
                    <classDisplayName>Activities</classDisplayName>
                    <objectId>-10008</objectId>
                    <version>0</version>
                    <subClassName>Phase</subClassName>
                    <subClassDisplayName>Phase</subClassDisplayName>
                    <objectDisplayName>Phase1</objectDisplayName>
                  </child>
                  <child>
                    <className>GatesClass</className>
                    <classDisplayName>Gates</classDisplayName>
                    <objectId>-10010</objectId>
                    <version>0</version>
                    <subClassName>Gate</subClassName>
                    <subClassDisplayName>Gate</subClassDisplayName>
                    <objectDisplayName>Gate1</objectDisplayName>
                  </child>
                </children>
              </parent>
              <parent>
                <id>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10008</objectId>
                  <version>0</version>
                  <subClassName>Phase</subClassName>
                  <subClassDisplayName>Phase</subClassDisplayName>
                  <objectDisplayName>Phase1</objectDisplayName>
                </id>
                <children>
                  <child>
                    <className>ActivitiesClass</className>
                    <classDisplayName>Activities</classDisplayName>
                    <objectId>-10009</objectId>
                    <version>0</version>
                    <subClassName>Task</subClassName>
                    <subClassDisplayName>Task</subClassDisplayName>
                    <objectDisplayName>Task1</objectDisplayName>
                  </child>
                  <child>
                    <className>ActivitiesClass</className>
                    <classDisplayName>Activities</classDisplayName>
                    <objectId>-10011</objectId>
                    <version>0</version>
                    <subClassName>Task</subClassName>
                    <subClassDisplayName>Task</subClassDisplayName>
                    <objectDisplayName>Task2</objectDisplayName>
                  </child>
                </children>
              </parent>
            </treeInfo>
          </project>
        </projects>
      </request>
    </ns1:updateProjects>
  </soapenv:Body>
</soapenv:Envelope>
=======response=======
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <updateProjectsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
      <response xmlns="">
        <messageId>Project WS Sample - UpdateNewProject</messageId>
        <messageName>Project WS Sample - UpdateNewProject</messageName>
        <statusCode>PARTIAL_SUCCESS</statusCode>
        <exceptions>
          <id>0</id>
          <exception>
            <identifier>
              <id>-10006</id>
              <name></name>
              <displayName>Test1421977274712</displayName>
            </identifier>
            <exceptionId>584</exceptionId>
            <message>Wed Sep 23 14:22:00 GMT 2009 is not a valid value for Date01.</message>
          </exception>
          <exception>
            <identifier>
              <id>-10009</id>
              <name></name>
              <displayName>Task1</displayName>
            </identifier>
            <exceptionId>584</exceptionId>
            <message>Wed Sep 30 14:25:00 GMT 2009 is not a valid value for Date01.</message>
          </exception>
        </exceptions>
        <updateProjectsStatuses>
          <updateProjectStatus>
            <projectId>
              <classId xsi:nil="true"/>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>0</objectId>
              <objectName xsi:nil="true"/>
              <version>0</version>
              <subClassId xsi:nil="true"/>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421977274712</objectDisplayName>
            </projectId>
            <statusCode>FAILURE</statusCode>
          </updateProjectStatus>
        </updateProjectsStatuses>
      </response>
    </updateProjectsResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.9.12 loadDeliverablesStatus

Service

To load the deliverable status of a project in PPM.

Sample Code

SOAP

==========request============
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <loadDeliverablesStatus xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
      <request xmlns="">
        <messageId>Project WS Sample - LoadDeliverablesStatus</messageId>
        <messageName>Project WS Sample - LoadDeliverablesStatus</messageName>
        <projectIdentifier>
          <classId>18022</classId>
          <className>ActivitiesClass</className>
          <objectName>PGM00004</objectName>
          <subClassId>18027</subClassId>
          <subClassName>Program</subClassName>
        </projectIdentifier>
        <includeAllLevels>true</includeAllLevels>
      </request>
    </loadDeliverablesStatus>
  </soapenv:Body>
</soapenv:Envelope>
========response=========
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <loadDeliverablesStatusResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
      <response xmlns="">
        <messageId>Project WS Sample - LoadDeliverablesStatus</messageId>
        <messageName>Project WS Sample - LoadDeliverablesStatus</messageName>
        <statusCode>SUCCESS</statusCode>
        <taskDeliverablesStatuses>
          <taskDeliverablesStatus>
            <taskId>
              <classId>18022</classId>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>127</objectId>
              <objectName>PGM00004</objectName>
              <version>2</version>
              <subClassId>18027</subClassId>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421979241264</objectDisplayName>
            </taskId>
            <deliverablesStatus>
              <status>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>4</id>
                    <apiName>COMPLETE</apiName>
                    <value>Complete</value>
                  </selection>
                </statusType>
                <statusMet>true</statusMet>
              </status>
              <status>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>2</id>
                    <apiName>REVIEW</apiName>
                    <value>Review</value>
                  </selection>
                </statusType>
                <statusMet>false</statusMet>
              </status>
            </deliverablesStatus>
          </taskDeliverablesStatus>
        </taskDeliverablesStatuses>
      </response>
    </loadDeliverablesStatusResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.9.13 validateProject

Service

To validate a PPM Project.

Sample Code

SOAP

==========request==========
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <ns1:validateProjects xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
      <request xmlns="">
        <messageId>Project WS Sample - ValidateProject</messageId>
        <messageName>Project WS Sample - ValidateProject</messageName>
        <projects>
          <project>
            <treeLocked>false</treeLocked>
            <readOnly>false</readOnly>
            <projectId>
              <classId>18022</classId>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>-10009</objectId>
              <version>0</version>
              <subClassId>18027</subClassId>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421979422135</objectDisplayName>
            </projectId>
            <selectedRootId>
              <classId>18022</classId>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>-10009</objectId>
              <version>0</version>
              <subClassId>18027</subClassId>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421979422135</objectDisplayName>
            </selectedRootId>
            <projectVersion>0</projectVersion>
            <languageCode>en-us</languageCode>
            <tasks>
              <task>
                <taskId>
                  <classId>18022</classId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassId>18027</subClassId>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421979422135</objectDisplayName>
                </taskId>
                <actualCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualCapitalExpenses>
                <actualDuration>0</actualDuration>
                <actualDurationVarianceWorkDays>0</actualDurationVarianceWorkDays>
                <actualFinishVarianceWorkDays>0</actualFinishVarianceWorkDays>
                <actualFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFixedCost>
                <actualFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualFlexCost>
                <actualLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </actualLaborCost>
                <actualStartVarianceWorkDays>0</actualStartVarianceWorkDays>
                <actualTimeInDays>0</actualTimeInDays>
                <auditScore>0</auditScore>
                <budgetedCapitalExpenses>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedCapitalExpenses>
                <budgetedFixedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFixedCost>
                <budgetedFlexCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedFlexCost>
                <budgetedLaborCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </budgetedLaborCost>
                <budgetedTimeInDays>0</budgetedTimeInDays>
                <critical>false</critical>
                <daysEffort>0</daysEffort>
                <deliverablesStatus/>
                <description>Test1421979422135</description>
                <durationType>
                  <listName>DurationTypeList</listName>
                  <selection>
                    <id>2</id>
                    <apiName>FIXED</apiName>
                    <value>Fixed</value>
                  </selection>
                </durationType>
                <estimatedCapitalExpensesToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedCapitalExpensesToCompletion>
                <estimatedDuration>0</estimatedDuration>
                <estimatedDurationVarianceWorkDays>0</estimatedDurationVarianceWorkDays>
                <estimatedFinishVarianceWorkDays>0</estimatedFinishVarianceWorkDays>
                <estimatedFixedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFixedCostToCompletion>
                <estimatedFlexCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedFlexCostToCompletion>
                <estimatedLaborCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </estimatedLaborCostToCompletion>
                <estimatedStartVarianceWorkDays>0</estimatedStartVarianceWorkDays>
                <estimatedTimeToCompletion>0</estimatedTimeToCompletion>
                <global>false</global>
                <leaf>true</leaf>
                <name>Test1421979422135</name>
                <owner>
                  <classId>11605</classId>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectId>704</objectId>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassId>11610</subClassId>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </owner>
                <percentComplete>200</percentComplete>
                <projectKeywords>
                  <listName>KeywordsList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>IMPORTANT_CONTENT</apiName>
                    <value>Important Content</value>
                  </selection>
                </projectKeywords>
                <projectState>
                  <listName>ActivityStateList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </projectState>
                <rollupHealthStatus>true</rollupHealthStatus>
                <scheduleDuration>28800000</scheduleDuration>
                <scheduleEditor>
                  <listName>ScheduleEditorList</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PPM</apiName>
                    <value>PPM</value>
                  </selection>
                </scheduleEditor>
                <scheduleEndDate>2009-09-29T17:00:00.000Z</scheduleEndDate>
                <scheduleStartDate>2009-09-29T08:00:00.000Z</scheduleStartDate>
                <statusType>
                  <listName>StatusTypeSelection</listName>
                  <selection>
                    <id>0</id>
                    <apiName>PENDING</apiName>
                    <value>Pending</value>
                  </selection>
                </statusType>
                <totalBudgetedCost>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalBudgetedCost>
                <totalEstimatedCostToCompletion>
                  <amount>0.0</amount>
                  <currency>USD</currency>
                </totalEstimatedCostToCompletion>
                <type>
                  <selection>
                    <id>18027</id>
                    <apiName>Program</apiName>
                    <value>Program</value>
                  </selection>
                </type>
                <weight>0.0</weight>
                <pageTwo/>
                <pageThree/>
              </task>
            </tasks>
            <resources>
              <resource>
                <resourceId>
                  <classId>11605</classId>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectId>704</objectId>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassId>11610</subClassId>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </resourceId>
                <name>Administrator (admin)</name>
                <firstName/>
                <lastName>Administrator</lastName>
                <userID>admin</userID>
                <status>
                  <listName>ActiveInactiveList</listName>
                  <selection>
                    <id>1</id>
                    <apiName>ACTIVE</apiName>
                    <value>Active</value>
                  </selection>
                </status>
                <email/>
              </resource>
            </resources>
            <assignments>
              <assignment>
                <taskID>
                  <classId>18022</classId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>-10009</objectId>
                  <version>0</version>
                  <subClassId>18027</subClassId>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>Test1421979422135</objectDisplayName>
                </taskID>
                <actualHours>0</actualHours>
                <daysEffort>0</daysEffort>
                <id>
                  <id>0</id>
                  <name>Team</name>
                  <displayName>Administrator (admin)</displayName>
                </id>
                <allocation>8000.0</allocation>
                <rejectedFlag>false</rejectedFlag>
                <name>
                  <classId>11605</classId>
                  <className>UsersClass</className>
                  <classDisplayName>users</classDisplayName>
                  <objectId>704</objectId>
                  <objectName>admin</objectName>
                  <version>0</version>
                  <subClassId>11610</subClassId>
                  <subClassName>User</subClassName>
                  <subClassDisplayName>User</subClassDisplayName>
                  <objectDisplayName>Administrator (admin)</objectDisplayName>
                </name>
                <roles>
                  <selection>
                    <id>9507</id>
                    <apiName>ProgramManager</apiName>
                    <value>Program Manager</value>
                  </selection>
                </roles>
              </assignment>
            </assignments>
            <treeInfo/>
          </project>
        </projects>
      </request>
    </ns1:validateProjects>
  </soapenv:Body>
</soapenv:Envelope> 
============response============
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <validateProjectsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
      <response xmlns="">
        <messageId>Project WS Sample - ValidateProject</messageId>
        <messageName>Project WS Sample - ValidateProject</messageName>
        <statusCode>PARTIAL_SUCCESS</statusCode>
        <exceptions>
          <id>0</id>
          <exception>
            <identifier>
              <id>-10009</id>
              <name></name>
              <displayName>Test1421979422135</displayName>
            </identifier>
            <exceptionId>584</exceptionId>
            <message>% Allocation should be between 0.0 and 400.0.</message>
          </exception>
          <exception>
            <identifier>
              <id>-10009</id>
              <name></name>
              <displayName>Test1421979422135</displayName>
            </identifier>
            <exceptionId>584</exceptionId>
            <message>200.00 is not a valid value. Enter a value between 0.00 and 100.00 for Percent Complete.</message>
          </exception>
          <exception>
            <identifier>
              <id>-10009</id>
              <name></name>
              <displayName>Test1421979422135</displayName>
            </identifier>
            <exceptionId>110044</exceptionId>
            <message>Root activity with name Test1421979422135 already exists.</message>
          </exception>
        </exceptions>
        <validateProjectsStatuses>
          <validateProjectStatus>
            <projectId>
              <classId>18022</classId>
              <className>ActivitiesClass</className>
              <classDisplayName>Activities</classDisplayName>
              <objectId>-10009</objectId>
              <objectName xsi:nil="true"/>
              <version>0</version>
              <subClassId>18027</subClassId>
              <subClassName>Program</subClassName>
              <subClassDisplayName>Program</subClassDisplayName>
              <objectDisplayName>Test1421979422135</objectDisplayName>
            </projectId>
            <statusCode>FAILURE</statusCode>
          </validateProjectStatus>
        </validateProjectsStatuses>
      </response>
    </validateProjectsResponse>
  </soapenv:Body>
</soapenv:Envelope>

A.9.14 Retrieving Project Summary

Service

External systems such as Oracle Innovation Management can retrieve project summary information from Agile PPM. First, the web service retrieves the Financial Rollup by Month of Project Costs for a specified list of projects, and it returns the number of FTE resources by Month by resource Pool for a specified list of projects.

Usage

PLPM rolls up this information into a view of Projects in flight by time period (month) by resource pool.

Sample Code

SOAP

<?xml version='1.0" encoding="UTF-8"?> 
<AgileData

xmnls:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://www.oracle.com/webfolder/technetwork/xml/plm/2013/09/
http://www.oracle.com/webfolder/technetwork/xml/plm/2013/09/aXML.xsd">
 <Activities uniqueId="18022:1721">
  <GeneralInfo>
      <ScheduleStartDate>2014-01-17T08:00:00Z</ScheduleStartDate>
      <ScheduleEndDate>2014-04-03T17:00:00Z</ScheduleEndDate>
      <ScheduleDuration>55</ScheduledDuration>
   <EstimatedStartVarianceWorkDays>0</EstimatedStartVarianceWorkDays>
   <EstimatedFinishVarianceWorkDays>0</EstimatedFinishVarianceWorkDays>
   <EstimatedDurationVarianceWorkDays>0</EstimatedDurationVarianceWorkDays>
   <ActualStartVarianceWorkDays>0</ActualStartVarianceWorkDays>
   <ActualDurationVarianceWorkDays>-53</ActualDurationVarianceWorkDays>
   <EstimatedStartDate>2014-01-17T08:00:00Z</EstimatedStartDate>
   <EstimatedEndDate>2014-04-03T17:00:00Z</EstimatedEndDate>
   <EstimatedDuration>55</EstimatedDuration>
   <ActualStartDate>2014-01-17T08:00:00Z</ActualStartDate>
   <ActualDuration>2</ActualDuration>
   <PercentComplete>8</PercentComplete>
   <DurationType>Fixed</DurationType>
   <DaysEffort>376</DaysEffort>
   <Number>PGM00019</Number>
   <ActivitiesType>Program</ActivitiesType>
   <Owner>Administrator, admin (admin)</Owner>
   <Name>Pr1</Name>
   <Template>Active</Template>
   <AuditScore>0</AuditScore>
   <Weight>0</Weight>
   <Status>In Process</Status>
   <RollupHealthStatus>Yes</RollupHealthStatus>
   <ScheduleStatusReason>Children are On Track</ScheduleStatusReason>
   <CostStatus>On Budget</CostStatus>
   <CostStatusReason>Children are On Budget</CostStatusReason>
   <LockUser>Administrator, admin (admin)</LockUser>
   <Workflow>Default Activities</Workflow>
   <Health>On Track</Health>
   <OverallStatus>On Track</OverallStatus>
   <Global>No</Global>
   <ActualLaborCost Currency="USD">0.00</ActualLaborCost>
   <BudgetedLaborCost Currency="USD">0.00</BudgetedLaborCost>
   <EstimatedLaborCostToCompletion        Currency="USD">0.00</EstimatedLaborCostToCompletion>
   <ActualFixedCost Currency="USD">0.00</ActualFixedCost>
   <BudgetedFixedCost Currency="USD">0.00</BudgetedFixedCost>
   <EstimatedFixedCostToCompletion         Currency="USD">0.00</EstimatedFixedCostToCompletion>
   <ActualCapitalExpenses Currency="USD">0.00</ActualCapitalExpenses>
   <BudgetedCapitalExpenses Currency="USD">0.00</BudgetedCapitalExpenses>
   <EstimatedCapitalExpensesToCompletion         Currency="USD">0.00</EstimatedCapitalExpensesToCompletion>
   <ActualTime>0</ActualTime>
   <BudgetedTime>376</BudgetedTime>
   <EstimatedFlexCostToCompletion
       Currency="USD">0.00</EstimatedFlexCostToCompletion>
   <Critical>No</Critical>
   <TotalActualCost Currency="USD">0.00</TotalActualCost>
   <TotalBudgetedCost Currency="USD">0.00</TotalBudgetedCost>
   <TotalEstimatedCostToCompletion
      Currency="USD">0.00</TotalEstimatedCostToCompletion>
   <ProjectKeywords>
     <Value>Important Content</Value>
   </ProjectKeywords>
  </GeneralInfo>
 </Activities>
</AgileData>

A.9.15 createCalendar

Service

To create a calendar.

Sample Code

Soap

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <createCalendar xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
    <request xmlns="">
      <requests>
        <name>WS_Calendar_1</name>
        <description>This is a calendar created via web
service.</description>
        <enabled>Yes</enabled>
        <workWeekSetting>1</workWeekSetting>
      </requests>
    </request>
   </createCalendar>
  </soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <createCalendarResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
        <response xmlns="">
           <messageId xsi:nil="true"/>
          <messageName xsi:nil="true"/>
          <statusCode>SUCCESS</statusCode>
          <responses/>
        </response>
      </createCalendarResponse>
    </soapenv:Body>
</soapenv:Envelope>

A.9.16 getCalendar

Service

To get a calendar in Agile.

Sample Code

SOAP

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
          <getCalendar xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
             <request xmlns="">
               <requests>
                  <calendarIdentifier>WS_Calendar_2</calendarIdentifier>
               </requests>
             </request>
          </getCalendar>
    </soapenv:Body>
  </soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <getCalendarResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
          <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
              <agileCalendar>
                <calendarId>2477739</calendarId>
                  <calendarName>WS_Calendar_2</calendarName>
                  <Description xsi:type="xs:string" attributeId="38" xmlns:xs="http://www.w3.org/2001/XMLSchema">This is a calendar created via web service.</Description>
                  <CreateFrom xsi:type="xs:string" attributeId="1071" xmlns:xs="http://www.w3.org/2001/XMLSchema">Default Calendar</CreateFrom>
                  <Enabled xsi:type="common:AgileListEntryType" attributeId="40" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                    <selection>
                      <id>1</id>
                      <apiName>YES</apiName>
                      <value>Yes</value>
                    </selection>
                  </Enabled>
                  <WorkWeekSetting xsi:type="xs:string" attributeId="1048" xmlns:xs="http://www.w3.org/2001/XMLSchema">2,3,4,5,6</WorkWeekSetting>
                  <ColorOfWorkingDays xsi:type="common:AgileListEntryType"
attributeId="1061" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                    <selection>
                      <id>15</id>
                      <apiName>White</apiName>
                      <value>White</value>
                    </selection>
                 </ColorOfWorkingDays>
              <ColorOfNonworkingDays xsi:type="common:AgileListEntryType"
 attributeId="1062"
xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                    <selection>
                      <id>2</id>
                      <apiName>Black</apiName>
                      <value>Black</value>
                    </selection>
                 </ColorOfNonworkingDays>
               <ColorOfNonworkingDaysbyExceptions xsi:type="common:AgileListEntryType" attributeId="1064"
xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                    <selection>
                       <id>4</id>
                      <apiName>Fuchsia</apiName>
                      <value>Fuchsia</value>
                    </selection>
                  </ColorOfNonworkingDaysbyExceptions>
               <ColorOfWorkingDaysbyExceptions xsi:type="common:AgileListEntryType" attributeId="1063"
xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                    <selection>
                       <id>3</id>
                       <apiName>Blue</apiName>
                       <value>Blue</value>
                    </selection>
                 </ColorOfWorkingDaysbyExceptions>
               </agileCalendar>
             </responses>
          </response>
        </getCalendarResponse>
     </soapenv:Body>
 </soapenv:Envelope>

A.9.17 updateCalendar

Service

To update calendar in Agile.

Sample Code

SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance">
       <soapenv:Body>
           <updateCalendar xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
               <request xmlns="">
                        <requests>
                            <name>WS_Calendar_3</name>
                             <start>2014-06-21T09:53:37.187Z</start>
                             <finish>2014-06-22T09:53:37.187Z</finish>
                             <actionType>add</actionType>
                        </requests>
              </request>
           </updateCalendar>
       </soapenv:Body>
    </soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:updateCalendarResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
         <response>
            <messageId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <messageName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <calendarIdentifier>WS_Calendar_3</calendarIdentifier>
            </responses>
         </response>
      </ns0:updateCalendarResponse>
   </S:Body>
</S:Envelope>

A.9.18 removeCalendar

Service

To remove calendar in Agile.

Sample Code

SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
     xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance">
    <soapenv:Body>
        <removeCalendar xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
          <request xmlns="">
                <requests>
                    <name>WS_Calendar_4</name>
                </requests>
          </request>
        </removeCalendar>
     </soapenv:Body>
  </soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <removeCalendarResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses/>
         </response>
      </removeCalendarResponse>
   </soapenv:Body>
</soapenv:Envelope>

A.9.19 logorChangeTimesheeet

Service

To update a Timesheet.

Sample Code

SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:logOrChangeTimesheet>
         <request>
             <requests>
               <!--Optional:-->
               <timeZone>GMT_00_00_GREENWICH_MEAN_TIME_DUBLIN_EDINBURGH_LISBON_LONDON</timeZone>
               <!--Optional:-->
               <year>2015</year>
               <!--Optional:-->
               <month>01</month>
               <!--Optional:-->
               <day>16</day>
               <!--1 or more repetitions:-->
               <changeRows>
                  <projectName>PT1</projectName>
                  <!--1 or more repetitions:-->
                  <changeCells>
                     <dayOfWeek>2</dayOfWeek>
                     <hours>4</hours>
                  </changeCells>
               </changeRows>
            </requests>
         </request>
      </v1:logOrChangeTimesheet>
   </soapenv:Body>
</soapenv:Envelope>

A.9.20 retrieveTimesheet

Service

To load a timesheet table.

Sample Code

SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:retrieveTimesheet>
         <request>
            <requests>
               <!--Optional:-->
               <timeZone>GMT_00_00_GREENWICH_MEAN_TIME_DUBLIN_EDINBURGH_LISBON_LONDON</timeZone>
               <!--Optional:-->
               <year>2015</year>
               <!--Optional:-->
               <month>01</month>
               <!--Optional:-->
               <day>19</day>
            </requests>
         </request>
      </v1:retrieveTimesheet>
   </soapenv:Body>
</soapenv:Envelope>

A.9.21 exportSearchedTimesheet

Service

To export Timesheets.

Sample Code

SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:exportSearchedTimesheet>
         <request>
            <requests>
               <users>
                  <classIdentifier>User</classIdentifier>
                  <objectIdentifier>admin</objectIdentifier>
               </users>
               <programs>
                  <className>ActivitiesClass</className>
                  <objectDisplayName>PT1</objectDisplayName>
                  <subClassName>Program</subClassName>
               </programs>
               <!--Optional:-->
               <fromYear>2014</fromYear>
               <!--Optional:-->
               <fromMonth>01</fromMonth>
               <!--Optional:-->
               <fromDay>01</fromDay>
               <!--Optional:-->
               <endYear>2015</endYear>
               <!--Optional:-->
               <endMonth>12</endMonth>
               <!--Optional:-->
               <endDay>31</endDay>
               <!--Optional:-->
               <includeCheckbox>false</includeCheckbox>
               <!--Optional:-->
               <fileType>xls</fileType>
               <!--Optional:-->
               <filePath>\\slc04yoc.us.oracle.com\Agile_Automation_Model\OATS_QA\Web_Services\ExportedFiles</filePath>
               <!--Optional:-->
               <fileName>PRG123</fileName>
            </requests>
         </request>
      </v1:exportSearchedTimesheet>
   </soapenv:Body>
</soapenv:Envelope>

A.9.22 exporttoAXML

Service

To export project object to an aXML file.

Sample Code

SOAP

soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
         xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
       <exportToAXML xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
             <request xmlns="">
                  <requests>
                     <program>
                         <className>ActivitiesClass</className>
                         <objectDisplayName>PGM00001</objectDisplayName>
                            <subClassName>Program</subClassName>
                     </program>
                          <filter>DefaultProjectFilter</filter>
                          <filePath>\\10.182.16.235\localWSTest</filePath>
                          <fileName>PGM00001.axml</fileName>
                 </requests>
             </request>
       </exportToAXML>
   </soapenv:Body>
</soapenv:Envelope>

A.9.23 getResourcePoolConsumption

Service

To get the Resource pool utilization information in Full Time Equivalent (FTE) by month or by quarter or by year for Project/Projects.

Usage

To be done

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <getResourcePoolConsumption xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
         <request xmlns="">
            <projectIdentifiers>
               <className>Program</className>
               <objectName>PGM00002</objectName>
            </projectIdentifiers>
         </request>
      </getResourcePoolConsumption>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <getResourcePoolConsumptionResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Project/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <projectId>
                  <classId>18022</classId>
                  <className>ActivitiesClass</className>
                  <classDisplayName>Activities</classDisplayName>
                  <objectId>121</objectId>
                  <objectName>PGM00002</objectName>
                  <version>0</version>
                  <subClassId>18027</subClassId>
                  <subClassName>Program</subClassName>
                  <subClassDisplayName>Program</subClassDisplayName>
                  <objectDisplayName>WS_Prog1</objectDisplayName>
               </projectId>
               <scheduleStartDate>2015-02-02T08:00:00.000Z</scheduleStartDate>
               <scheduleEndDate>2015-02-13T17:00:00.000Z</scheduleEndDate>
               <fullTimeEquivalents>
                  <resourcePool>WS_UG1</resourcePool>
                  <resourceID>6102407</resourceID>
                  <startDate>2015-02-01T00:00:00.000Z</startDate>
                  <endDate>2015-02-28T23:59:59.000Z</endDate>
                  <headCount>0.5</headCount>
                  </fullTimeEquivalents>
               </responses>
            </response>
         </getResourcePoolConsumptionResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.9.24 getParentObjsForRefObj

Service

To get the Parent Object of the referenced object.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
      <s0:getParentObjsForRefObj          xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"          xmlns:s0="http://xmlns.oracle.com/AgileObjects/Core/Business/V1"          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                  <requests>
                     <disableAllWarnings>false</disableAllWarnings>
                         <objectType>1001</objectType>
                         <objectId>6|10141</objectId>
                  </request>
          </s0:getParentObjsForRefObj>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns0:getParentObjsForRefObjResponse xmlns:ns0="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
         <response>
            <messageId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <messageName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <statusCode>SUCCESS</statusCode>
            <referObjParentObjs>
               <objectId>1765</objectId>
<url>/test?fromPCClient=true&amp;module=ActivityHandler&amp;requestUrl=module%3DActivityHandler%26opcode%3DdisplayObject%26classid%3D18022%26objid%3D1765%26tabid%3D0%26</url>
               <number>PGM00043</number>
               <status>In Process</status>
               <title>WS_Prog1</title>
               <ParentObject xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            </referObjParentObjs>
         </response>
      </ns0:getParentObjsForRefObjResponse>
   </S:Body>
</S:Envelope>

A.10 Reports Web Services

This section describes the web services operations available for Reports Web Services.

A.10.1 loadReportSchema

Service

To load reports.

Usage

Loads report schemas. Success of the operation is verified by using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadReportSchema xmlns="http://xmlns.oracle.com/AgileObjects/Core/Report/V1">
            <request xmlns="">
               <requests>
                  <reportIdentifier>Project Assembly Cost Report</reportIdentifier>
                  <params>
                     <id>objectNumber</id>
                     <values>PRJ00001</values>
                  </params>
               </requests>
            </request>
         </loadReportSchema>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadReportSchemaResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Report/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <reportIdentifier>103</reportIdentifier>
                  <url>http://MMUTHUSW-IDC:8888/webfs/DownloadServlet?token=A58AB33627AC4B6033077D4A63FF204E335E3378E522491A3CF50275A8D78F029DC2D464BB66C560E5F726C6E2044EE9C28BE814D82089565C9A16DEDAD793C6F80275F5D17673C20369CEA74EDF&amp;vault=&amp;fileID=C861DB6AFABCEB27FD</url>
               </responses>
            </response>
         </loadReportSchemaResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.10.2 loadReportData

Service

To load data of a report.

Usage

Loads data of a report. Success of the operation is verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadReportData xmlns="http://xmlns.oracle.com/AgileObjects/Core/Report/V1">
            <request xmlns="">
               <requests>
                  <reportIdentifier>Project Assembly Cost Report</reportIdentifier>
                  <params>
                     <id>objectNumber</id>
                     <values>PRJ00001</values>
                  </params>
                  <params>
                     <id>items</id>
                     <values>CAP500-PS</values>
                     <values>CAP450-PS</values>
                  </params>
                  <params>
                     <id>suppliers</id>
                     <values>EMS1 COMPONENT SUPPLIER</values>
                     <values>EMS2 COMPONENT MFR</values>
                  </params>
                  <params>
                     <id>pricepoints</id>
                     <values>04/01/2004 To 06/30/2004 QuantityBreak1</values>
                     <values>07/01/2003 To 09/29/2003 QuantityBreak1</values>
                     <values>09/30/2003 To 12/29/2003 QuantityBreak1</values>
                     <values>12/30/2003 To 03/31/2004 QuantityBreak1</values>
                  </params>
                  <params>
                     <id>doCostRollup</id>
                     <values>false</values>
                  </params>
               </requests>
            </request>
         </loadReportData>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====

A.11 Search Web Services

This section describes the web services operations available for Search Web Services.

A.11.1 quickSearch

Service

To retrieve a list of all Agile objects whose specifications match the search criteria specified in the request object.

Usage

Object name, number (ID), or description may be used to form the criteria. The response object contains a collection of Agile objects, which were successfully queried for. Success of the operation is verified by using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <quickSearch xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <classIdentifier>Part</classIdentifier>
               <keywords>P0*</keywords>
               <searchFiles>false</searchFiles>
            </request>
         </quickSearch>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <quickSearchResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <table>
                  <tableIdentifier>
                     <objectId>0</objectId>
                     <tableId>-102</tableId>
                     <tableName xsi:nil="true"/>
                  </tableIdentifier>
                  <row rowId="13">
                     <objectReferentId>
                        <classId>10141</classId>
                        <className>Part</className>
                        <objectId>6098830</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <ItemType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1">Part</ItemType>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">P00003</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3"></Description>
                     <LifecyclePhase xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Preliminary</LifecyclePhase>
                     <Rev xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="5"></Rev>
                  </row>
                  <row rowId="14">
                     <objectReferentId>
                        <classId>10141</classId>
                        <className>Part</className>
                        <objectId>6098836</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <ItemType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1">Part</ItemType>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">P00005</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3"></Description>
                     <LifecyclePhase xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Preliminary</LifecyclePhase>
                     <Rev xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="5"></Rev>
                  </row>
               </table>
            </response>
         </quickSearchResponse>

See also: getSearchableAttributes, advancedSearch

A.11.2 advancedSearch

Service

To retrieve a list of all Agile objects whose specifications match the advanced search criteria specified in the request object.

Usage

Advanced search provides options for forming complex search criteria. The response object contains a collection of Agile objects which were successfully queried for. Success of the operation is verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <advancedSearch xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <classIdentifier>Part</classIdentifier>
               <criteria>[Title Block.Number] contains 'P0' &amp;&amp; [Title Block.Description] is not null</criteria>
               <caseSensitive>false</caseSensitive>
               <displayName>Search123</displayName>
               <resultAttributes>Title Block.Number</resultAttributes>
               <resultAttributes>Title Block.Description</resultAttributes>
               <resultAttributes>Title Block.Lifecycle Phase</resultAttributes>
            </request>
         </advancedSearch>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <advancedSearchResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <table>
                  <tableIdentifier>
                     <objectId>6112848</objectId>
                     <objectName>Search123</objectName>
                     <tableId>-102</tableId>
                     <tableName xsi:nil="true"/>
                  </tableIdentifier>
                  <row rowId="1">
                     <objectReferentId>
                        <classId>10141</classId>
                        <className>Part</className>
                        <objectId>6098826</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1001">P00001</number>
                     <description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1002">Gimme all yer money, AAAARRRRR ye land-lover!!</description>
                     <lifecyclePhase xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1" attributeId="1084">
                        <selection>
                           <id>976</id>
                           <apiName>PRELIMINARY</apiName>
                           <value>Preliminary</value>
                        </selection>
                     </lifecyclePhase>
                  </row>
               </table>
            </response>
         </advancedSearchResponse>

See also: getAllClasses, getSearchableAttributes

A.11.3 advancedSearchReferenceObject

Service

To execute an advanced search for Reference Object.

Usage

Specifies necessary fields and contains specifications of the class identifier for the advanced search. The response object obtains the results.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:advancedSearch>
         <request>
            <classIdentifier>RefObjectClassName</classIdentifier>
            <criteria>[Title Block.Name/Number/Desc] contains '250'</criteria>
         </request>
      </v1:advancedSearch>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <advancedSearchResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <table>
               <tableIdentifier>
                  <objectId>6206062</objectId>
                  <tableId>-102</tableId>
                  <tableName xsi:nil="true"/>
               </tableIdentifier>
               <row rowId="0">
                  <objectReferentId>
                     <classId>2623238</classId>
                     <className>RefObjectClassName</className>
                     <objectId>-1</objectId>
                     <objectName xsi:nil="true"/>
                  </objectReferentId>
                  <Name xsi:type="xs:string" attributeId="2000017548" xmlns:xs="http://www.w3.org/2001/XMLSchema">250-0400</Name>
                  <Description xsi:type="xs:string" attributeId="2000017549" xmlns:xs="http://www.w3.org/2001/XMLSchema">INTEL PENTIUM II PROCESSOR 400MHZ</Description>
                  <CurrentStatus xsi:type="xs:string" attributeId="2000017550" xmlns:xs="http://www.w3.org/2001/XMLSchema">Preliminary</CurrentStatus>
                  <PublicKey xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">500464|10141</PublicKey>
                  <URL xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">/Agile/PLMServlet?fromPCClient=true&amp;module=ItemHandler&amp;requestUrl=module%3DItemHandler%26opcode%3DdisplayObject%26classid%3D10000%26objid%3D500464%26tabid%3D0%26</URL>
               </row>
               <row rowId="1">
                  <objectReferentId>
                     <classId>2623238</classId>
                     <className>RefObjectClassName</className>
                     <objectId>-1</objectId>
                     <objectName xsi:nil="true"/>
                  </objectReferentId>
                  <Name xsi:type="xs:string" attributeId="2000017548" xmlns:xs="http://www.w3.org/2001/XMLSchema">250-0450-01</Name>
                  <Description xsi:type="xs:string" attributeId="2000017549" xmlns:xs="http://www.w3.org/2001/XMLSchema">INTEL PENTIUM II PROCESSOR 450MHZ</Description>
                  <CurrentStatus xsi:type="xs:string" attributeId="2000017550" xmlns:xs="http://www.w3.org/2001/XMLSchema">Preliminary</CurrentStatus>
                  <PublicKey xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">501690|10141</PublicKey>
                  <URL xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">/Agile/PLMServlet?fromPCClient=true&amp;module=ItemHandler&amp;requestUrl=module%3DItemHandler%26opcode%3DdisplayObject%26classid%3D10000%26objid%3D501690%26tabid%3D0%26</URL>
               </row>
               <row rowId="2">
                  <objectReferentId>
                     <classId>2623238</classId>
                     <className>RefObjectClassName</className>
                     <objectId>-1</objectId>
                     <objectName xsi:nil="true"/>
                  </objectReferentId>
                  <Name xsi:type="xs:string" attributeId="2000017548" xmlns:xs="http://www.w3.org/2001/XMLSchema">250-0500-01</Name>
                  <Description xsi:type="xs:string" attributeId="2000017549" xmlns:xs="http://www.w3.org/2001/XMLSchema">INTEL PENTIUM II PROCESSOR 500MHZ</Description>
                  <CurrentStatus xsi:type="xs:string" attributeId="2000017550" xmlns:xs="http://www.w3.org/2001/XMLSchema">Preliminary</CurrentStatus>
                  <PublicKey xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">501781|10141</PublicKey>
                  <URL xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">/Agile/PLMServlet?fromPCClient=true&amp;module=ItemHandler&amp;requestUrl=module%3DItemHandler%26opcode%3DdisplayObject%26classid%3D10000%26objid%3D501781%26tabid%3D0%26</URL>
               </row>
            </table>
         </response>
      </advancedSearchResponse>
   </soapenv:Body>
</soapenv:Envelope>

See also: advancedSearch

A.11.4 getSearchableAttributes

Service

To retrieve a list of all searchable attributes on a baseclass, class or a subclass.

Usage

The request object is formed using relevant details. Contains the attributes that were queried for. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSearchableAttributes xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <classIdentifier>Part</classIdentifier>
            </request>
         </getSearchableAttributes>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSearchableAttributesResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <attributes>
                  <nodeId>2000004143</nodeId>
                  <apiName>complianceCalculatedDate</apiName>
                  typeATTRIBUTE</type>
                  <displayName>Compliance Calculated Date</displayName>
                  <dataType>3</dataType>
                  <searchable>true</searchable>
                  <visible>true</visible>
                  <required>false</required>
                  <maxLength>2147483647</maxLength>
                  <properties>
                     <propertyId>1</propertyId>
                     <apiName>AttType</apiName>
                     <displayName>AttType</displayName>
                     <readOnly>false</readOnly>
                     <AttType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"></AttType>
                  </properties>
                  <properties>
                     <propertyId>9</propertyId>
                     <apiName>Visible</apiName>
                     <displayName>Visible</displayName>
                     <readOnly>true</readOnly>
                     <Visible xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName>YES</apiName>
                           <value>Yes</value>
                        </selection>
                     </Visible>
                  </properties>
               </attributes>
            </response>
</getSearchableAttributesResponse>

See also: getAttributes

A.11.5 getSearchableClasses

Service

To retrieve a list of searchable base classes, classes and sub-classes.

Usage

Allows the user to retrieve the list of Searchable BaseClasses/ Classes/ SubClasses for which the user has privilege. The request object takes classIdentifier as input. If the classIdentifier is not set then the response will contain the list of all searchable BaseClasses, else the response will return the list of all subclasses of that classIdentifier.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>                       
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">                                               
      <soapenv:Body>                                                                        
         <getSearchableClasses xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">                                                   
            <request xmlns="">                                                                                                                 
               <disableAllWarnings>true</disableAllWarnings>                                                                                  
               <onlyBaseClasses>false</onlyBaseClasses>                                                                                        
               <classIdentifier>ChangesBaseClass</classIdentifier>                                                                            
            </request>                                                                        
         </getSearchableClasses>                                               
      </soapenv:Body>                       
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getSearchableClassesResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <classes>
                  <nodeId>6000</nodeId>
                  <apiName>ChangeOrdersClass</apiName>
                  typeCLASS</type>
                  <displayName>Change Orders</displayName>
                  <abstractClass>true</abstractClass>
               </classes>
               <classes>
                  <nodeId>1450</nodeId>
                  <apiName>ManufacturerOrdersClass</apiName>
                  typeCLASS</type>
                  <displayName>Manufacturer Orders</displayName>
                  <abstractClass>true</abstractClass>
               </classes>
               <classes>
                  <nodeId>11000</nodeId>
                  <apiName>StopShipsClass</apiName>
                  typeCLASS</type>
                  <displayName>Stop Ships</displayName>
                  <abstractClass>true</abstractClass>
               </classes>
            </response>
         </getSearchableClassesResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.12 Query Web Services

This section describes the web services operations available for Query Web Services.

A.12.1 createQuery

Service

To create a search query and save the query into a folder.

Usage

Creates a query given the criteria and folder path where it is to be saved. The response object contains the QueryObjectType objects. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createQuery xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">           
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <queryParams>
                     <queryIdentifier>
                        <name>Personal Searches/AdvancedSearch6524265</name>                    
                     </queryIdentifier>
                     <searchClassIdentifier>ECO</searchClassIdentifier>                     
                     <criteria>[1049] in ('Other')</criteria>
                     <visibility>PUBLIC</visibility>
                     <searchType>0</searchType>
                     <caseSensitive>false</caseSensitive>
                  </queryParams>
               </requests>
            </request>
         </createQuery>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <createQueryResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <query>
                     <queryIdentifier>
                        <name>Personal Searches/AdvancedSearch6504413</name>
                        <id>6100910</id>
                        <version>1</version>
                     </queryIdentifier>
                     <searchClassIdentifier>PartsClass</searchClassIdentifier>
                     <criteria>[1001] contains 'TE'</criteria>
                     <visibility>PRIVATE</visibility>
                     <searchType>0</searchType>
                     <caseSensitive>false</caseSensitive>
                     <resultAttributes>number</resultAttributes>
                     <resultAttributes>description</resultAttributes>
                     <resultAttributes>lifecyclePhase</resultAttributes>
                     <resultAttributes>rev</resultAttributes>
                     <resultAttributes>overallCompliance</resultAttributes>
                     <resultAttributes>itemType</resultAttributes>
                     <owner>admin</owner>
                  </query>
               </responses>
            </response>
         </createQueryResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.12.2 loadQuery

Service

Allows the user to load a query object given a query Identifier. The identifier can be the full Query Path which includes the queryName appended to the parentFolder path.

Usage

Loads the query given the query id or query name (full name with folder path + name). The response object contains the QueryObjectType objects. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadQuery xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <queryIdentifier>
                     <name>Personal Searches/AdvancedSearch4940265</name>
                  </queryIdentifier>
               </requests>
            </request>
         </loadQuery>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadQueryResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <query>
                     <queryIdentifier>
                        <name>Personal Searches/AdvancedSearch4940265</name>
                        <id>6101016</id>
                        <version>1</version>
                     </queryIdentifier>
                     <searchClassIdentifier>PartsClass</searchClassIdentifier>
                     <criteria>[1001] contains 'TE'</criteria>
                     <visibility>PRIVATE</visibility>
                     <searchType>0</searchType>
                     <caseSensitive>false</caseSensitive>
                     <resultAttributes>number</resultAttributes>
                     <resultAttributes>description</resultAttributes>
                     <resultAttributes>lifecyclePhase</resultAttributes>
                     <resultAttributes>rev</resultAttributes>
                     <resultAttributes>overallCompliance</resultAttributes>
                     <resultAttributes>itemType</resultAttributes>
                     <owner>admin</owner>
                  </query>
               </responses>
            </response>
         </loadQueryResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.12.3 executeSavedQuery

Service

To execute a query that is already created and saved in the Agile system.

Usage

Executes a query given the query id/query name (full name with folder path + name). The response object contains the AgileTableType objects. You can verify the success of the operation using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <executeSavedQuery xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <queryIdentifier>
                     <name>Personal Searches/AdvancedSearch8976589</name>
                  </queryIdentifier>
                  <params>
                     <parameter>Electrical</parameter>
                  </params>
               </requests>
            </request>
         </executeSavedQuery>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <executeSavedQueryResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <results>
                     <tableIdentifier>
                        <objectId>6100916</objectId>
                        <tableId>-102</tableId>
                        <tableName xsi:nil="true"/>
                     </tableIdentifier>
                  </results>
               </responses>
            </response>
         </executeSavedQueryResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.12.4 saveAsQuery

Service

To save an existing query object as a new query object in the Agile system.

Usage

Saves a query given the query id or query name (full name with folder path + name) to new folder or with a new name and provides a mechanism by which the query can be saved into a particular folder. The response will return the new Query Object back to the client. The response object contains the QueryObjectType objects. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <saveAsQuery xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <queryIdentifier>
                     <name>Global Searches/QUERY_A6120956</name>
                  </queryIdentifier>
                  <newQueryIdentifier>/Global Searches/QUERY_B3978010</newQueryIdentifier>
                  <shortcut>false</shortcut>
               </requests>
            </request>
         </saveAsQuery>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <saveAsQueryResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <query>
                     <queryIdentifier>
                        <name>/Global Searches/QUERY_B3978010</name>
                        <id>6101121</id>
                        <version>1</version>
                     </queryIdentifier>
                     <searchClassIdentifier>PartsClass</searchClassIdentifier>
                     <criteria>[1001] contains 'TE'</criteria>
                     <visibility>PRIVATE</visibility>
                     <searchType>0</searchType>
                     <caseSensitive>false</caseSensitive>
                     <resultAttributes>number</resultAttributes>
                     <resultAttributes>description</resultAttributes>
                     <resultAttributes>lifecyclePhase</resultAttributes>
                     <resultAttributes>rev</resultAttributes>
                     <resultAttributes>overallCompliance</resultAttributes>
                     <resultAttributes>itemType</resultAttributes>
                     <owner>admin</owner>
                  </query>
               </responses>
            </response>
         </saveAsQueryResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.12.5 updateQuery

Service

To update an existing query object in the Agile system.

Usage

Updates the query given the query id or query name (full name with folder path + name) with new criteria. The response object contains the QueryObjectType objects. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <updateQuery xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">           
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <queryIdentifier>
                     <name>Personal Searches/AdvancedSearchNEW1912299</name>                 
                  </queryIdentifier>
                  <newQueryParams>
                     <queryIdentifier>
                        <name>AdvancedSearchNEW1912298</name>
                     </queryIdentifier>
                     <searchClassIdentifier>ECO</searchClassIdentifier>                    
                     <criteria>[1049] contains ('Other')</criteria>                    
                     <searchType>0</searchType>
                     <caseSensitive>false</caseSensitive>
                  </newQueryParams>
               </requests>
            </request>
         </updateQuery>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <updateQueryResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <query>
                     <queryIdentifier>
                        <name>/Global Searches/Query_A4678815</name>
                        <id>6101124</id>
                        <version>6</version>
                     </queryIdentifier>
                     <searchClassIdentifier>PartsClass</searchClassIdentifier>
                     <criteria>[1001] contains 'XYZ'</criteria>
                     <visibility>PRIVATE</visibility>
                     <searchType>0</searchType>
                     <caseSensitive>false</caseSensitive>
                     <resultAttributes>number</resultAttributes>
                     <resultAttributes>description</resultAttributes>
                     <resultAttributes>lifecyclePhase</resultAttributes>
                     <resultAttributes>rev</resultAttributes>
                     <resultAttributes>overallCompliance</resultAttributes>
                     <resultAttributes>itemType</resultAttributes>
                     <owner>admin</owner>
                  </query>
               </responses>
            </response>

A.12.6 deleteQuery

Service

To delete an existing query object from the Agile system.

Usage

Deletes the query given the query id or query name (full name with folder path + name). Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteQuery xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>
               <requests>
                  <queryIdentifier>
                     <name>Personal Searches/AdvancedSearch969239</name>
                  </queryIdentifier>
               </requests>
            </request>
         </deleteQuery>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteQueryResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Search/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses/>
            </response>
         </deleteQueryResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.13 Tables Web Services

This section describes the web services operations available for Tables Web Services.

A.13.1 isReadOnlyTable

Service

To query a specific Agile Table object and determine if the table status is 'read-only'.

Usage

Contains class identifier, object id and table identifier that identify the table. The response object returns true or false for read-only status of the table, besides the table name and table display name.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isReadOnlyTable xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <isReadOnlyTable>
                  <agileTable>
                     <classIdentifier>Part</classIdentifier>
                     <objectNumber>P00711</objectNumber>
                     <tableIdentifier>807</tableIdentifier>
                  </agileTable>
               </isReadOnlyTable>
               <isReadOnlyTable>
                  <agileTable>
                     <classIdentifier>ECO</classIdentifier>
                     <objectNumber>C00217</objectNumber>
                     <tableIdentifier>809</tableIdentifier>
                  </agileTable>
               </isReadOnlyTable>
            </request>
         </isReadOnlyTable>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isReadOnlyTableResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <isTableReadOnly>
                  <agileTable>
                     <classId>10141</classId>
                     <className>Part</className>
                     <objectId>6112208</objectId>
                     <objectName>P00711</objectName>
                     <tableId>807</tableId>
                     <tableName>Attachments</tableName>
                     <tableDisplayName>Attachments</tableDisplayName>
                  </agileTable>
                  <isReadOnlyTable>false</isReadOnlyTable>
               </isTableReadOnly>
               <isTableReadOnly>
                  <agileTable>
                     <classId>6141</classId>
                     <className>ECO</className>
                     <objectId>6112212</objectId>
                     <objectName>C00217</objectName>
                     <tableId>809</tableId>
                     <tableName>AffectedItems</tableName>
                     <tableDisplayName>Affected Items</tableDisplayName>
                  </agileTable>
                  <isReadOnlyTable>false</isReadOnlyTable>
               </isTableReadOnly>
            </response>
         </isReadOnlyTableResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.13.2 clearTable

Service

To purge the contents of an Agile Table object by removing all its rows.

Usage

Contains class identifier and table identifier. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <clearTable xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <clearTable>
                  <agileTable>
                     <classIdentifier>Part</classIdentifier>
                     <objectNumber>P00707</objectNumber>
                     <tableIdentifier>807</tableIdentifier>
                  </agileTable>
               </clearTable>
               <clearTable>
                  <agileTable>
                     <classIdentifier>ECO</classIdentifier>
                     <objectNumber>C00216</objectNumber>
                     <tableIdentifier>809</tableIdentifier>
                  </agileTable>
               </clearTable>
            </request>
         </clearTable>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <clearTableResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </clearTableResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: loadTable

A.13.3 copyTable

Service

To copy the contents of an Agile Table object from one table to another.

Usage

Contains relevant information that identifies the tables. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <copyTable xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <copyTable>
                  <sourceTable>
                     <classIdentifier>Part</classIdentifier>
                     <objectNumber>P00709</objectNumber>
                     <tableIdentifier>2000001404</tableIdentifier>
                  </sourceTable>
                  <targetTable>
                     <classIdentifier>Part</classIdentifier>
                     <objectNumber>P00710</objectNumber>
                     <tableIdentifier>2000001404</tableIdentifier>
                  </targetTable>
               </copyTable>
            </request>
         </copyTable>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <copyTableResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </copyTableResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: loadTable, clearTable

A.13.4 addRows

Service

To add rows in an Agile Table object

Usage

Uses details of the new row and the table. The request object is built using rowId and objectInfo. Success of the operation is verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addRows xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <data>
                  <objectInfo>
                     <classIdentifier>ECO</classIdentifier>
                     <objectNumber>C00218</objectNumber>
                     <tableIdentifier>809</tableIdentifier>
                  </objectInfo>
                  <row rowId="0">
                     <key1054 attributeId="1054">P00713</key1054>
                  </row>
               </data>
            </request>
         </addRows>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <addRowsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </addRowsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getTableMetadata, isReadOnlyTable

A.13.5 updateRows

Service

To update an existing row in an Agile Table object.

Usage

Uses details of the modified row and the table. The request object is built using objectInfo and rowId attributes. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <updateRows xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <data>
                  <objectInfo>
                     <classIdentifier>ECO</classIdentifier>
                     <objectNumber>C00218</objectNumber>
                     <tableIdentifier>809</tableIdentifier>
                  </objectInfo>
                  <row>
                     <rowId>6112255</rowId>
                     <row rowId="0">
                        <modified_element attributeId="newRev">2</modified_element>
                     </row>
                  </row>
               </data>
            </request>
         </updateRows>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <updateRowsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </updateRowsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: getTableMetadata, isReadOnlyTable, loadTable.

A.13.6 removeRows

Service

To remove an existing row belonging to an Agile Table object.

Usage

Includes details of the row to be removed and the table identifier. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeRows xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <rows>
                  <objectInfo>
                     <classIdentifier>Part</classIdentifier>
                     <objectNumber>P00717</objectNumber>
                     <tableIdentifier>803</tableIdentifier>
                  </objectInfo>
                  <rowId>6112309</rowId>
               </rows>
            </request>
         </removeRows>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <removeRowsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </removeRowsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

See also: isReadOnlyTable, loadTable.

A.13.7 loadTable

Service

To load the content of an existing Agile Table object.

Usage

Contains identifier of the table to be retrieved and the information to be obtained from it. Success of the operation may be verified using the status code in the response object.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadTable xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <request xmlns="">
               <tableRequest>
                  <classIdentifier>ECO</classIdentifier>
                  <objectNumber>C00220</objectNumber>
                  <tableIdentifier>809</tableIdentifier>
               </tableRequest>
            </request>
         </loadTable>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <loadTableResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <tableContents>
                  <tableIdentifier>
                     <classId>6141</classId>
                     <className>ECO</className>
                     <objectId>6112315</objectId>
                     <objectName>C00220</objectName>
                     <tableId>809</tableId>
                     <tableName>AffectedItems</tableName>
                     <tableDisplayName>Affected Items</tableDisplayName>
                  </tableIdentifier>
                  <row rowId="6112318">
                     <objectReferentId>
                        <classId>10141</classId>
                        <className>Part</className>
                        <objectId>6112311</objectId>
                        <objectName>P00719</objectName>
                     </objectReferentId>
                     <hasBeenRedlinedImage xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6350" readOnly="True">false</hasBeenRedlinedImage>
                     <itemNumber xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="1054" readOnly="False">P00719</itemNumber>
                     <attachmentsImage xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="12623" readOnly="True">false</attachmentsImage>
                  </row>
               </tableContents>
            </response>
         </loadTableResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.13.8 isFlagSet

Service

To ascertain the status of a predetermined flag on a particular row of a Agile table.

Usage

These flags are specific to the table to which the row belongs. For instance, an attachment table may contain a flag 'hasAttachments' denoting whether the table has attachments present in it. To identify the row, object information identifying the table must be coupled with a unique rowId that indentifies the row itself. The table may be identified with identifier keys of class, object name and table identifier. The request must also specify the flag pertaining to the current table, for which the row is being queried. Based on this request a boolean value will be obtained in the response with which the nature of the flag status for the current row may be determined.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isFlagSet xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">                       
            <request xmlns="">
               <disableAllWarnings>true</disableAllWarnings>                              
               <requests>
                  <objectInfo>
                     <classIdentifier>Part</classIdentifier>                                         
                     <objectNumber>TEST_PARENT7958046</objectNumber>                                         
                     <tableIdentifier>-803</tableIdentifier>                                         
                     <options>
                        <propertyName>redline_change</propertyName>                                               
                        <propertyValue>TEST_ECO8990047</propertyValue>                                         
                     </options>
                  </objectInfo>
                  <rowId>6104164</rowId>
                  <flagIdentifier>-103</flagIdentifier>                              
               </requests>
            </request>
         </isFlagSet>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <isFlagSetResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Table/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <responses>
                  <isFlagSet>true</isFlagSet>
               </responses>
            </response>
         </isFlagSetResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.13.9 addrowstoReferenceObject

Service

To add rows to a table of an Agile Reference Object using the addRows operation.

Usage

Contains the content of the row to be added to the table in the form of message elements.

Sample Code

SOAP

==== Request ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:createObject>
         <request>
            <requests>
               <classIdentifier>RefObjectClassName</classIdentifier>            
               <data rowId="0">
                  <Name>RefObj001</Name>
                  <Description>Reference Object RefObj001</Description>
             <referencedObjKey>0001|12345</referencedObjKey>                        
               </data>
            </requests>
         </request>
      </v1:createObject>
   </soapenv:Body>
</soapenv:Envelope>
==== Response ====
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <createObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/Business/V1">
         <response xmlns="">
            <messageId xsi:nil="true"/>
            <messageName xsi:nil="true"/>
            <statusCode>SUCCESS</statusCode>
            <responses>
               <agileObject>
                  <objectIdentifier>
                     <classId>2623238</classId>
                     <className>RefObjectClassName</className>
                     <classDisplayName>RefObjectClassName</classDisplayName>
                     <objectId>6206023</objectId>
                     <objectName>RefObj001</objectName>
                     <version>0</version>
                  </objectIdentifier>
               </agileObject>
            </responses>
         </response>
      </createObjectResponse>
   </soapenv:Body>
</soapenv:Envelope>

A.13.10 getNotifications

Service

Gets all notification for the current User.

Usage

Retrieves all the notifications pertaining to the current Agile user. The response will return a set of notifications for the user with information describing the subject, the sender and the date when the notification was received.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getNotifications xmlns="http://xmlns.oracle.com/AgileObjects/Core/UserProfile/V1">
            <request xmlns=""/>
         </getNotifications>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
HTTP/1.1 200 OK
Date: Wed, 02 Jun 2010 12:08:37 GMT
     Server: Oracle Containers for J2EE
     Set-Cookie: JSESSIONID=156e314ab84bdf970e0466b030e455cad5188d6ed8ccc6db6d3647470b646d94; path=/core
     Cache-Control: private
     Connection: close
     Content-Type: text/xml; charset=utf-8
 
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getNotificationsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/UserProfile/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <table>
                  <tableIdentifier xsi:nil="true"/>
                  <row rowId="6000045">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME8203143 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>143</objectId>
                        <objectName>PGM_NAME8203143</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME8203143 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=143 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T12:06:36.000Z</Received>
                  </row>
                  <row rowId="6000044">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME8203143 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>143</objectId>
                        <objectName>PGM_NAME8203143</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME8203143 has been assigned to you by Administrator (admin).          Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=143 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T12:06:36.000Z</Received>
                  </row>
                  <row rowId="6000037">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME9699280 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>136</objectId>
                        <objectName>PGM_NAME9699280</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME9699280 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=136 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:40:47.000Z</Received>
                  </row>
                  <row rowId="6000038">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME9699280 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>136</objectId>
                        <objectName>PGM_NAME9699280</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME9699280 has been assigned to you by Administrator (admin).          Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=136 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:40:47.000Z</Received>
                  </row>
                  <row rowId="6000035">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME3078104 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>133</objectId>
                        <objectName>PGM_NAME3078104</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">
           Activity PGM_NAME3078104 has been assigned to you by Administrator (admin).
           Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=133
     </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:37:33.000Z</Received>
                  </row>
                  <row rowId="6000034">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME3078104 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>133</objectId>
                        <objectName>PGM_NAME3078104</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME3078104 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=133 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:37:33.000Z</Received>
                  </row>
                  <row rowId="6000031">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME5181671 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>130</objectId>
                        <objectName>PGM_NAME5181671</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME5181671 has been assigned to you by Administrator (admin).          Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=130 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:33:59.000Z</Received>
                  </row>
                  <row rowId="6000030">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME5181671 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>130</objectId>
                        <objectName>PGM_NAME5181671</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME5181671 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=130 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:33:59.000Z</Received>
                  </row>
                  <row rowId="6000029">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME9450886 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>127</objectId>
                        <objectName>PGM_NAME9450886</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME9450886 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=127 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:26:34.000Z</Received>
                  </row>
                  <row rowId="6000028">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME9450886 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>127</objectId>
                        <objectName>PGM_NAME9450886</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME9450886 has been assigned to you by Administrator (admin).          Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=127 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:26:34.000Z</Received>
                  </row>
                  <row rowId="6000024">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME2882289 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>124</objectId>
                        <objectName>PGM_NAME2882289</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME2882289 has been assigned to you by Administrator (admin).          Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=124 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:23:02.000Z</Received>
                  </row>
                  <row rowId="6000026">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME2882289 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>124</objectId>
                        <objectName>PGM_NAME2882289</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME2882289 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=124 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:23:02.000Z</Received>
                  </row>
                  <row rowId="6000021">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>1</id>
                           <apiName></apiName>
                           <value>Request</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME6328082 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Assignment of an Activity to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>121</objectId>
                        <objectName>PGM_NAME6328082</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME6328082 has been assigned to you by Administrator (admin).          The scheduled dates of the assigned activity are:        Scheduled Start:      11/30/2010 08:00:00 AM        Scheduled End:        11/30/2010 05:00:00 PM                            Please access your Agile Inbox to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=121 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:21:49.000Z</Received>
                  </row>
                  <row rowId="6000022">
                     <Type xsi:type="common:AgileListEntryType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <selection>
                           <id>0</id>
                           <apiName></apiName>
                           <value>Notification</value>
                        </selection>
                     </Type>
                     <Subject xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Project Activity Assignment: PGM_NAME6328082 with %Allocation: 100.0.</Subject>
                     <NotificationType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Activities - Notification for Activity Assignment to a Resource</NotificationType>
                     <Regarding xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>18027</classId>
                        <className>Program</className>
                        <classDisplayName>Program</classDisplayName>
                        <objectId>121</objectId>
                        <objectName>PGM_NAME6328082</objectName>
                        <version>2</version>
                     </Regarding>
                     <SentBy xsi:type="common:AgileObjectType" xmlns:common="http://xmlns.oracle.com/AgileObjects/Core/Common/V1">
                        <classId>11610</classId>
                        <className>User</className>
                        <classDisplayName>User</classDisplayName>
                        <objectId>704</objectId>
                        <objectName>admin</objectName>
                        <version>1</version>
                     </SentBy>
                     <Body xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">        Activity PGM_NAME6328082 has been assigned to you by Administrator (admin).          Please access your My Assignments to accept or decline assignment to this activity: http://MMUTHUSW-IDC:8888/web/PLMServlet?action=OpenEmailObject&amp;classid=18022&amp;objid=121 </Body>
                     <Received xsi:type="xs:date" xmlns:xs="http://www.w3.org/2001/XMLSchema">2010-06-02T11:21:49.000Z</Received>
                  </row>
               </table>
            </response>
         </getNotificationsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.13.11 deleteNotifications

Service

Deletes notifications for the current User.

Usage

Deletes the specified notifications from a set of notifications populated in the notifications tab for the current user. The request also identifies the notification to be removed and the response ascertains the status of the operation.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteNotifications xmlns="http://xmlns.oracle.com/AgileObjects/Core/UserProfile/V1">
            <request xmlns="">
               <rowId>6000045</rowId>
               <rowId>6000044</rowId>
            </request>
         </deleteNotifications>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <deleteNotificationsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/UserProfile/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
            </response>
         </deleteNotificationsResponse>
      </soapenv:Body>
   </soapenv:Envelope>

A.13.12 getMyWorkFlowRoutings

Service

Gets the workflow routings objects for the current User.

Usage

Retrieves all the workflow routings applicable for the current user according to the user's action in the workflow routings tab. The response returns a set of workflow routings for the user with information describing each workflow routing.

Sample Code

SOAP

==== Request ====
<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getMyWorkFlowRoutings xmlns="http://xmlns.oracle.com/AgileObjects/Core/UserProfile/V1">
            <request xmlns="">
               <workflowDateFilter>30</workflowDateFilter>
            </request>
         </getMyWorkFlowRoutings>
      </soapenv:Body>
   </soapenv:Envelope>
==== Response ====
<?xml version="1.0" encoding="utf-8"?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Body>
         <getMyWorkFlowRoutingsResponse xmlns="http://xmlns.oracle.com/AgileObjects/Core/UserProfile/V1">
            <response xmlns="">
               <messageId xsi:nil="true"/>
               <messageName xsi:nil="true"/>
               <statusCode>SUCCESS</statusCode>
               <table>
                  <tableIdentifier>
                     <objectId>309</objectId>
                     <tableId>-102</tableId>
                     <tableName xsi:nil="true"/>
                  </tableIdentifier>
                  <row rowId="0">
                     <objectReferentId>
                        <classId>16437</classId>
                        <className>SourcingProject</className>
                        <objectId>100001</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">DELL_101</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3">DELL PROJECT 101</Description>
                     <Status xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Open</Status>
                     <Action xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6">Assigned to Me</Action>
                     <Workflow xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="7"></Workflow>
                  </row>
                  <row rowId="1">
                     <objectReferentId>
                        <classId>16437</classId>
                        <className>SourcingProject</className>
                        <objectId>100007</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">DELL_107</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3">DELL PROJECT 107</Description>
                     <Status xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Open</Status>
                     <Action xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6">Assigned to Me</Action>
                     <Workflow xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="7"></Workflow>
                  </row>
                  <row rowId="2">
                     <objectReferentId>
                        <classId>16437</classId>
                        <className>SourcingProject</className>
                        <objectId>100008</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">DELL_108</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3">DELL PROJECT 108</Description>
                     <Status xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Open</Status>
                     <Action xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6">Assigned to Me</Action>
                     <Workflow xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="7"></Workflow>
                  </row>
                  <row rowId="3">
                     <objectReferentId>
                        <classId>16437</classId>
                        <className>SourcingProject</className>
                        <objectId>100009</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">DELL_109</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3">DELL PROJECT 109</Description>
                     <Status xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Open</Status>
                     <Action xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6">Assigned to Me</Action>
                     <Workflow xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="7"></Workflow>
                  </row>
                  <row rowId="4">
                     <objectReferentId>
                        <classId>16437</classId>
                        <className>SourcingProject</className>
                        <objectId>108000</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">PRJSeedData1</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3">seed date</Description>
                     <Status xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Open</Status>
                     <Action xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6">Assigned to Me</Action>
                     <Workflow xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="7"></Workflow>
                  </row>
                  <row rowId="5">
                     <objectReferentId>
                        <classId>16445</classId>
                        <className>RFQ</className>
                        <objectId>10001</objectId>
                        <objectName xsi:nil="true"/>
                     </objectReferentId>
                     <Number xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="2">RFQ-PRJSeedData1</Number>
                     <Description xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="3">test for RFQ</Description>
                     <Status xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="4">Draft</Status>
                     <Action xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="6">Assigned to Me</Action>
                     <Workflow xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeId="7"></Workflow>
                  </row>
               </table>
            </response>
         </getMyWorkFlowRoutingsResponse>
      </soapenv:Body>
   </soapenv:Envelope>