| Agile Product Lifecycle Management Web Services Guide Release 9.3.3 E39310-02 |
|
 Previous |
 Next |
| Agile Product Lifecycle Management Web Services Guide Release 9.3.3 E39310-02 |
|
Previous |
Next |
Agile PLM Engineering Collaboration (EC) Services are a set of business services that supplement PLM's Core Web Services for CAD use cases. Customers and partners can build next generation MCAD and ECAD connectors utilizing Agile PLM Web Services and Engineering Collaboration Services.
Some of the benefits are:
Significantly improves WAN performance for CAD connectors because the bulk of the logic is deployed to the server
Makes it easier for development partners and customers to implement CAD connectors
Provides the unique and interface friendly API name field to access PLM metadata.
The Core service covers most of the basic services, and is applicable in the EC services context. The following sections describe services that are EC specific in detail. The EC Services are designed as document/wrapped style and use consistent request-response types which in turn use the types defined in the Core services data model or extend the one from the Core service data model.
Service
Adds a bookmark for one or multiple objects to a bookmark folder in Agile PLM. If the folder name is omitted in the request, the My Bookmarks folder is used. If a folder is specified, it must be the name of an existing sub folder of My Bookmarks.
Usage
Returns an AddBookmarkResponseType containing the status of the operation.
Syntax
AddBookmarkRequestType request = new AddBookmarkRequestType(); AddBookmarkResponseType response = service.addBookmark(request);
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> <addBookmark xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <generalParameters> <id xsi:nil="true"/> <property> <propertyName>folder-name</propertyName> <propertyValue>Test</propertyValue> </property> </generalParameters> <requests> <classId>1488</classId> <objectNumber>TEST_MFR_PART4751636</objectNumber> <inputParameters> <id>CommonProperties</id> <property> <propertyName>manufacturer_name</propertyName> <propertyValue>ECS</propertyValue> </property> </inputParameters> </requests> </request> </addBookmark> </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> <addBookmarkResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> </response> </addBookmarkResponse> </soapenv:Body> </soapenv:Envelope>
|
Note: Name of the folder to which you add the bookmark (optional). If not set, the main folder is the default folder. |
Service
To publish a complete CAD Model structure to the Agile PLM system. Creates and updates Design objects and structures, parts and part BOMs, and trigger thumbnail generation for structures (if enabled). It is a bulk service that combines the below mentioned services into a single service. Pure metadata update for design, Item and Change limited to Title block, Page 1 to 3 and the Relationship tab. Check-out for the Design object is optional. Structure update and optional metadata update on Design structure, Design files tab, and Design relationships tab. Needs to support options for check-in (yes/no) and check-out (keep checked-in, increment, cancel check-out). Item publish with option to publish the structure or files or both to the item BOM. The request contains objects of all types at the requests level. You must create References (structure or part relations) by having the object's ObjectIdentifierType referenced on the corresponding table row entry. The request must contain all attributes and tables (including their attributes) that need to be created or updated. It may require excluding certain attributes or tables from a previous response of another call (a previous retrieveDesignStructure) to ensure that it contains only required data.
The service supports two steps of a CAD save process. Creates objects (both Designs and optionally Parts) including the Design structure and the Part BOM. If the parameter 'publish-only' is not set to true. Updates the Files tab with uploaded File IDs, creates the thumbnails (by setting the "thumbnail" parameter to true) and publishes the Design's files to the Part attachments (by setting the "PublishAttachments" parameter).
The service also supports the "Modify Item Attachments" call, which allows modifying the attachments of an Item only. The top level object must be an Item (or a subclass of Item) and have Design object references in the attachment table. The service collects the files from the Design object and updates the Item's attachment tab accordingly.
Usage
Returns an array of AgileCreateUpdateObjectsResponse in the response object.
Syntax
CreateUpdateObjectsRequestType request = new CreateUpdateObjectsRequestType(); CreateUpdateObjectsResponseType response = service.createUpdateObjects(request);
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> <createUpdateObjects xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <generalParameters> <id xsi:nil="true" /> <property> <propertyName>strings-only</propertyName> <propertyValue>true</propertyValue> </property> //continued for similar properties </generalParameters> <requests> <agileObject> <objectId> <classId xsi:nil="true" /> <className>Part</className> <objectId xsi:nil="true" /> <objectName>P02681</objectName> </objectId> <table> <tableId> <objectName>P02681</objectName> <tableId>804</tableId> <tableName>PendingChanges</tableName> </tableId> </table> <attribute id="1001"> <String> <value>P02681</value> </String> </attribute> <options> <propertyName>save_option</propertyName> <propertyValue>checkin</propertyValue> </options> </agileObject> // continued for similar agileObjects </requests> //continued for similar requests <filters> <apiName>ChangesClass</apiName> typeCLASS</type> <attribute>1047</attribute> <attribute>1052</attribute> <attribute>3742</attribute> </filters> //continued for similar filters </request> </createUpdateObjects> </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> <createUpdateObjectsResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true" /> <messageName xsi:nil="true" /> <statusCode>SUCCESS</statusCode> <sessionParameters> <id>VersionProperties</id> <property> <propertyName>ECS</propertyName> <propertyValue>9.3.2</propertyValue> </property> <property> <propertyName>Build</propertyName> <propertyValue>Build 09</propertyValue> </property> </sessionParameters> <responses> <agileObject> <objectId> <classId>10141</classId> <className>Part</className> <classDisplayName>Part</classDisplayName> <objectId>6895441</objectId> <objectName>P02681</objectName> <objectVersion>Introductory</objectVersion> <version>4</version> <superClassId>10000</superClassId> </objectId> <table> <tableId> <classId>10141</classId> <className>Part</className> <objectId>6895441</objectId> <objectName>P02681</objectName> <tableId>804</tableId> <tableName>PendingChanges</tableName> <tableDisplayName>Pending Changes</tableDisplayName> </tableId> </table> <attribute apiName="number" id="1001" type="xsd:string"> <String> <value>P02681</value> </String> </attribute> //continued for similar attributes <options> <propertyName>save_option</propertyName> <propertyValue>checkin</propertyValue> </options> </agileObject> </responses> </response> </createUpdateObjectsResponse> </soapenv:Body> </soapenv:Envelope>
Table B-1 createUpdateObjects items
|
Name |
Description |
|
RevisionSequence |
Sequence for revisions (optional). A to Z by default. |
|
VersionsSeparator |
Separator for versions (optional). ' ' space character by default. |
|
Initial Version |
Initial version (optional). '1' by default. |
|
InitialDesignRevision |
Initial Design revision (optional). '-' by default. |
|
InitialPublishRevision |
Initial version for Publish (optional). Empty by default. |
|
PublishAttachmentType |
Attachment type for Publish that goes into the Attachment Type list field of an Item (optional). Any value from the AttachType list. Empty by default. |
|
PublishAttachments |
Attachments to publish (optional). List of attachments are 'any, 'all'. Any by default. |
|
ClusteredObjects |
Flag to force objects updated on all cluster nodes (optional). False by default. |
|
DesignRevisionLogic |
Design revision logic (optional). Options are any combination of 'editable', 'noparantheses', 'publish, or 'increment'. Empty by default. |
|
InitialVersionCheckin |
Flag to check-in on initial version (optional). True by default. |
|
PublishIntroductory |
Flag to publish to introductory item status (optional). True by default. |
|
PublishPartSite |
Site to publish (optional). None by default. |
|
SetLifecyclePhase |
Flag to set the lifecycle phase to true or false (optional). False by default. |
Table B-2 Common Properties
| Name | Description |
|---|---|
|
structure |
Flag to create/update the structure of the Design. False by default. This option requires other Design object references in the structure table. |
|
files |
Flag to update the file references. |
|
item |
Flag to create or update items. Options are 'create', 'update'; 'link'. Update by default. |
|
check-in |
Flag to check-in the objects after processing. |
|
publish |
Flag for publish type. 'None', 'attachment', 'born', 'born_and_attachment. None by default. None indicates it is disabled. |
|
publish_only |
Flag to publish only. False by default. It does not update any attributes. Switches off the 'structure' and 'files' flags. |
|
thumbnail |
Flag to generate thumbnails after structure is complete. False by default. |
|
string_only |
Flag to return string values or actual data types. False by default. |
|
skip_empty |
Flag to omit empty values in the response to reduce the payload. False by default. |
|
attach-drawings |
Flag to control how a CAD drawing's files get attached to an Item. 'None', 'Model,'Self. 'None' does not attach the files to any Item. 'Model' attaches the files to the associated model's Item. 'Self ' attaches the files to the drawing's Item (For this option, you must create an Item for the drawing). |
|
publish-drawings |
Flag to control the publish logic for the Item BOM. 'None' references the drawing allowthrough the model's Item on the BOM. 'Relate' lays the drawing's item on the relationship tab of the model's Item. 'Child" positions the drawing's Item below the model's Item in the BOM. If the parameter 'attach-drawings' is set to 'model', the value of the parameter 'publish-drawings' must be 'none'. Since the drawings' files are attached to the model's Item, linking the drawing's Item may not be useful. |
|
auto-checkout |
Flag to allow or disallow an automatic check-out of Design object. True by default. Its default value is 'true', unless the general parameter 'publish_only" is set to 'true'". In addition, if the parameter is missing from the request, it checks for the value of the parameter 'structure'. If this value is 'true','"auto-checkout' is set to 'false', and to 'true' otherwise. |
Table B-3 Common Properties continued
|
Name |
Description |
|
save_option |
Flag to find the save mode to use. Options are 'save', increment', 'checkin'. Save by default. This is a mandatory Design object parameter. |
|
numbersource |
Uses the autonumber source while creating the object (optional). |
|
delete_structureentries |
Flag to delete structure entries which are not part of the request (optional). Options are true or false. True by default. The structure entries are filtered by the CAX-IDENT column. Entries other than CAX* are never deleted. Deletes CAX* entries only if the flag is set to true. This is a table parameter for the Design Structure, Design Relationships and Item BOM/RedlineBOM table. If flag is true the call assumes a complete target structure is given. |
Service
To trigger the generation of thumbnail images for Design assemblies when the check-in process is complete. The PLM system triggers the generation of thumbnail images automatically when the Design objects are checked-in. The thumbnail generation for assemblies requires a manual trigger to reflect all components.
Usage
The request must contain at least one Agile Object to represent the Design for which the thumbnail generation should be triggered. All the data to identify the Design object must be present in the ObjectIdentifier, including class-id, subclass, number and version.
Syntax
GenerateThumbnailsRequestType request = new GenerateThumbnailsRequestType(); GenerateThumbnailsResponseType generateThumbnailsResponseType = service.generateThumbnails(request);
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> <generateThumbnails xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <requests> <classId>2000008310</classId> <objectNumber>TEST_DESIGN9498672</objectNumber> <objectVersion>0</objectVersion> </requests> </request> </generateThumbnails> </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> <generateThumbnailsResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> </response> </generateThumbnailsResponse> </soapenv:Body> </soapenv:Envelope>
Service
To retrieve a specific Agile object in the Agile PLM system. It could be filtered by class level attributes and table level attributes. If no filter is specified in the request, all attributes for the class and/or the specified tables are returned.
Usage
Returns an array of AgileBusinessObjectType of type Part in the response object.
Syntax
GetFilteredObjectRequestType request = new GetFilteredObjectRequestType(); GetFilteredObjectResponseType response = service.getFilteredObject(request);
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> <getFilteredObject xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <generalParameters> <id xsi:nil="true"/> <property> <propertyName>strings-only</propertyName> <propertyValue>false</propertyValue> </property> </generalParameters> <requests> <classId>2000008297</classId> <objectNumber>TEST_DESIGN9498672</objectNumber> <objectVersion>0</objectVersion> <table> <tableIdentifier>6150</tableIdentifier> <loadCellMetaData xsi:nil="true"/> </table> </requests> <filters> <id>2000008297</id> typeCLASS</type> <attribute>1302</attribute> <attribute>1420</attribute> <attribute>2002</attribute> <attribute>2007</attribute> <attribute>2009</attribute> <attribute>2017</attribute> <attribute>2090</attribute> <attribute>6173</attribute> <attribute>6174</attribute> <attribute>6177</attribute> <attribute>6178</attribute> <attribute>6180</attribute> <attribute>6184</attribute> <attribute>6388</attribute> <attribute>6389</attribute> <attribute>6390</attribute> <attribute>7951</attribute> <attribute>2000008685</attribute> <attribute>2000008717</attribute> </filters> <filters> <id>10000</id> typeCLASS</type> <attribute>1001</attribute> <attribute>1002</attribute> <attribute>1014</attribute> <attribute>1420</attribute> <attribute>1084</attribute> <attribute>12468</attribute> </filters> <filters> <id>931</id> typeCLASS</type> <attribute>1047</attribute> <attribute>1052</attribute> <attribute>3742</attribute> </filters> <filters> <id>6150</id> typeTABLE</type> <attribute>-1</attribute> <attribute>6303</attribute> <attribute>6148</attribute> </filters> <filters> <id>2000007761</id> typeTABLE</type> <attribute>2000007767</attribute> <attribute>2000007768</attribute> <attribute>2000007904</attribute> <attribute>5846</attribute> <attribute>5847</attribute> <attribute>2000008523</attribute> <attribute>2000007770</attribute> </filters> <filters> <id>2000008318</id> typeTABLE</type> <attribute>2000008320</attribute> <attribute>2000008321</attribute> <attribute>2000008325</attribute> <attribute>2000008323</attribute> <attribute>2000008377</attribute> <attribute>2000008324</attribute> </filters> <filters> <id>804</id> typeTABLE</type> <attribute>1026</attribute> <attribute>1149</attribute> <attribute>1028</attribute> </filters> </request> </getFilteredObject> </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> <getFilteredObjectResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> <responses> <agileObject> <objectId> <classId>2000008310</classId> <className>Design</className> <classDisplayName>Design</classDisplayName> <objectId>6519149</objectId> <objectName>TEST_DESIGN9498672</objectName> <objectVersion>1</objectVersion> <version>2</version> <superClassId>2000008297</superClassId> </objectId> <table> <tableId> <classId>2000008310</classId> <className>Design</className> <objectId>6519149</objectId> <objectName>TEST_DESIGN9498672</objectName> <tableId>6150</tableId> <tableName>Files</tableName> <tableDisplayName>Files</tableDisplayName> </tableId> </table> <attribute apiName="number" id="6173" type="xsd:string"> <String> <value>TEST_DESIGN9498672</value> </String> </attribute> <attribute apiName="description" id="6174" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="lifecyclePhase" id="6390" type="ns1:AgileListEntryType" xmlns:ns1="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>6382</id> <apiName>DESIGN</apiName> <value>Design</value> </selection> </value> </SingleList> </attribute> <attribute apiName="version" id="7951" type="xsd:integer"> <Integer> <value>1</value> </Integer> </attribute> <attribute apiName="revision" id="2000008685" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="checkoutStatus" id="6389" type="ns2:AgileListEntryType" xmlns:ns2="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>0</id> <apiName>CHECKED_OUT</apiName> <value>Checked Out</value> </selection> </value> </SingleList> </attribute> <attribute apiName="checkoutUser" id="6180" type="ns3:AgileListEntryType" xmlns:ns3="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>6013686</id> <apiName xsi:nil="true"/> <value>CAD One (cad1)</value> </selection> </value> </SingleList> </attribute> <attribute apiName="checkoutDate" id="6184" type="xsd:date"> <Date> <value>2012-10-10T20:28:30.000Z</value> </Date> </attribute> <attribute apiName="createDate" id="6177" type="xsd:date"> <Date> <value>2012-10-10T20:28:28.000Z</value> </Date> </attribute> <attribute apiName="lastModifiedDate" id="6178" type="xsd:date"> <Date> <value>2012-10-10T20:28:59.000Z</value> </Date> </attribute> <attribute apiName="checkinUser" id="2000008717" type="ns4:AgileListEntryType" xmlns:ns4="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="checkinDate" id="6388" type="xsd:date"> <Date> <value>2012-10-10T20:28:30.000Z</value> </Date> </attribute> <attribute apiName="text01" id="2007" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiText10" id="2017" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text03" id="2009" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="createUser" id="1420" type="ns5:AgileListEntryType" xmlns:ns5="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>6013686</id> <apiName xsi:nil="true"/> <value>CAD One (cad1)</value> </selection> </value> </SingleList> </attribute> <attribute apiName="text12" id="1302" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiList01" id="2090" type="ns6:AgileMultiListEntryType" xmlns:ns6="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value> <selection> <id>2605304</id> <apiName>INTERNAL</apiName> <value>INTERNAL</value> </selection> </value> </MultiList> </attribute> </agileObject> </responses> </response> </getFilteredObjectResponse> </soapenv:Body> </soapenv:Envelope>
Service
To return all types of lists (object lists, dynamic list, and static lists) and localized list values. Applying a search filter limits the number of returns. The service searches the super class if no values are found in the given class.
Usage
Returns an array of AgileGetListValuesResponseType in the response object.
Syntax GetListValuesRequestType request = new GetListValuesRequestType(); GetListValuesResponseType response = service.getListValues(request);
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> <getListValues xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <requests> <classId>2000008310</classId> <attributeId>1539</attributeId> </requests> <requests> <classId>2000008310</classId> <attributeId>1420</attributeId> </requests> </request> </getListValues> </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> <getListValuesResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> <responses> <classId>2000008310</classId> <attributeId>1539</attributeId> <attributeApiName>CADMaterial</attributeApiName> <values> <id xsi:nil="true"/> <property> <propertyValue>ALUMINUM</propertyValue> </property> <property> <propertyValue>BRASS</propertyValue> </property> <property> <propertyValue>CAST IRON</propertyValue> </property> <property> <propertyValue>COMPOSITE</propertyValue> </property> <property> <propertyValue>GLASS</propertyValue> </property> <property> <propertyValue>PLASTIC</propertyValue> </property> <property> <propertyValue>RUBBER</propertyValue> </property> <property> <propertyValue>SEE PARTS</propertyValue> </property> <property> <propertyValue>SILICON</propertyValue> </property> <property> <propertyValue>STEEL</propertyValue> </property> </values> </responses> <responses> <classId>2000008310</classId> <attributeId>1420</attributeId> <attributeApiName>createUser</attributeApiName> <values> <id xsi:nil="true"/> <property> <propertyValue>class: 11605 subclass:11610 id:704 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6072986 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6086790 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054784 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054847 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071278 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054615 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6141383 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6141102 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6141149 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6141248 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6141218 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054805 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054590 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6389782 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6131711 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6013686 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6212345 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024525 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6013713 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6033872 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6000021 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6029252 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6032262 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6029262 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6013770 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024316 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071074 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054868 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6073045 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071455 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6033832 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6070987 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071514 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6033854 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6074149 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054727 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054657 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6177850 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6072488 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054678 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6070868 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6069364 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6177816 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054699 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054889 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071598 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6028732 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6013722 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6072927 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6086942 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6111896 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024325 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024391 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054763 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6072868 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024533 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024605 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071669 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6023622 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024453 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024667 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6024738 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054636 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054826 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6054742 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6019622 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6013756 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6036159 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6029243 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6071736 version:-456</propertyValue> </property> <property> <propertyValue>class: 11605 subclass:11610 id:6072807 version:-456</propertyValue> </property> </values> </responses> </response> </getListValuesResponse> </soapenv:Body> </soapenv:Envelope>
|
Note: Separator = Separator for cascading lists (optional). '|' by default. |
Service
To retrieve all Agile sub classes for a given base class in Agile PLM. The request object specifies the details of lists to be retrieved. If the corresponding flag is set to true in the request, all available autonumber sources for the classId's are returned.
Usage
Returns an array of AgileGetSubclassesResponseType in the response object.
Syntax
GetSubclassesRequestType request = new GetSubclassesRequestType(); GetSubclassesResponseType response = service.getSubclasses(request);
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> <getSubclasses xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <requests> <classId>DesignsClass</classId> <includeAllAutoNumberSource>true</includeAllAutoNumberSource> </requests> <requests> <classId>PartsClass</classId> <includeAllAutoNumberSource>true</includeAllAutoNumberSource> </requests> <requests> <classId>ChangeOrdersClass</classId> <includeAllAutoNumberSource>true</includeAllAutoNumberSource> </requests> </request> </getSubclasses> </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> <getSubclassesResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> <responses> <classId>2000008297</classId> <classes> <nodeId>2000008310</nodeId> <apiName>Design</apiName> typeSUBCLASS</type> <displayName>Design</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> <autoNumbers> <nodeId>2469120</nodeId> <apiName>Node_2469120</apiName> typeAUTONUMBER</type> <displayName>100 - Standard Part</displayName> </autoNumbers> <autoNumbers> <nodeId>2469121</nodeId> <apiName>Node_2469121</apiName> typeAUTONUMBER</type> <displayName>200 - Plastic Part</displayName> </autoNumbers> <autoNumbers> <nodeId>2469122</nodeId> <apiName>Node_2469122</apiName> typeAUTONUMBER</type> <displayName>300 - Sheetmetal Part</displayName> </autoNumbers> <autoNumbers> <nodeId>2000008780</nodeId> <apiName>DesignsNumber</apiName> typeAUTONUMBER</type> <displayName>Designs Number</displayName> </autoNumbers> <autoNumbers> <nodeId>2469124</nodeId> <apiName>Node_2469124</apiName> typeAUTONUMBER</type> <displayName>500 - Casted Part</displayName> </autoNumbers> <autoNumbers> <nodeId>2469125</nodeId> <apiName>Node_2469125</apiName> typeAUTONUMBER</type> <displayName>800 - Electrical Part</displayName> </autoNumbers> <autoNumbers> <nodeId>2469126</nodeId> <apiName>Node_2469126</apiName> typeAUTONUMBER</type> <displayName>900 - Tooling Part</displayName> </autoNumbers> <autoNumbers> <nodeId>2469123</nodeId> <apiName>Node_2469123</apiName> typeAUTONUMBER</type> <displayName>400 - Wire/Cable</displayName> </autoNumbers> </classes> <superClass> <nodeId>2000008297</nodeId> <apiName>DesignsClass</apiName> typeCLASS</type> <displayName>Designs</displayName> </superClass> </responses> <responses> <classId>10000</classId> <classes> <nodeId>2498255</nodeId> <apiName>AssembledDie</apiName> typeSUBCLASS</type> <displayName>Assembled Die</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498253</nodeId> <apiName>GenericPartNumber</apiName> typeAUTONUMBER</type> <displayName>Generic Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2491982</nodeId> <apiName>Assembly</apiName> typeSUBCLASS</type> <displayName>Assembly</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498287</nodeId> <apiName>AssemblyNumber</apiName> typeAUTONUMBER</type> <displayName>Assembly Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499477</nodeId> <apiName>Bag</apiName> typeSUBCLASS</type> <displayName>Bag</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499433</nodeId> <apiName>Bag</apiName> typeAUTONUMBER</type> <displayName>Bag</displayName> </autoNumbers> </classes> <classes> <nodeId>2498289</nodeId> <apiName>BareboardPCB</apiName> typeSUBCLASS</type> <displayName>Bareboard PCB</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2493329</nodeId> <apiName>BulkheadAdapter</apiName> typeSUBCLASS</type> <displayName>Bulkhead Adapter</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2493327</nodeId> <apiName>BulkheadAdapterNumber</apiName> typeAUTONUMBER</type> <displayName>Bulkhead Adapter Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484759</nodeId> <apiName>Capacitor</apiName> typeSUBCLASS</type> <displayName>Capacitor</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2497700</nodeId> <apiName>CapacitorNumber</apiName> typeAUTONUMBER</type> <displayName>Capacitor Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499506</nodeId> <apiName>Case</apiName> typeSUBCLASS</type> <displayName>Case</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499431</nodeId> <apiName>Case</apiName> typeAUTONUMBER</type> <displayName>Case</displayName> </autoNumbers> </classes> <classes> <nodeId>2484777</nodeId> <apiName>Connector</apiName> typeSUBCLASS</type> <displayName>Connector</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499567</nodeId> <apiName>Dialyzer</apiName> typeSUBCLASS</type> <displayName>Dialyzer</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499565</nodeId> <apiName>Dialyzer</apiName> typeAUTONUMBER</type> <displayName>Dialyzer</displayName> </autoNumbers> </classes> <classes> <nodeId>2498303</nodeId> <apiName>Die</apiName> typeSUBCLASS</type> <displayName>Die</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498301</nodeId> <apiName>DieNumber</apiName> typeAUTONUMBER</type> <displayName>Die Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484813</nodeId> <apiName>Diode</apiName> typeSUBCLASS</type> <displayName>Diode</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498334</nodeId> <apiName>DiodeNumber</apiName> typeAUTONUMBER</type> <displayName>Diode Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2493314</nodeId> <apiName>DowtySeal</apiName> typeSUBCLASS</type> <displayName>Dowty Seal</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2493312</nodeId> <apiName>DowtySealNumber</apiName> typeAUTONUMBER</type> <displayName>Dowty Seal Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499612</nodeId> <apiName>ElectricMotor</apiName> typeSUBCLASS</type> <displayName>Electric Motor</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499610</nodeId> <apiName>ElectricMotor</apiName> typeAUTONUMBER</type> <displayName>Electric Motor</displayName> </autoNumbers> </classes> <classes> <nodeId>2499442</nodeId> <apiName>Fiber</apiName> typeSUBCLASS</type> <displayName>Fiber</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499425</nodeId> <apiName>Fiber</apiName> typeAUTONUMBER</type> <displayName>Fiber</displayName> </autoNumbers> </classes> <classes> <nodeId>2499435</nodeId> <apiName>FiberBundle</apiName> typeSUBCLASS</type> <displayName>Fiber Bundle</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499425</nodeId> <apiName>Fiber</apiName> typeAUTONUMBER</type> <displayName>Fiber</displayName> </autoNumbers> </classes> <classes> <nodeId>2498336</nodeId> <apiName>FinishedGood</apiName> typeSUBCLASS</type> <displayName>Finished Good</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2491994</nodeId> <apiName>Hardware</apiName> typeSUBCLASS</type> <displayName>Hardware</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2491992</nodeId> <apiName>HardwareNumber</apiName> typeAUTONUMBER</type> <displayName>Hardware Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2493301</nodeId> <apiName>HexNut</apiName> typeSUBCLASS</type> <displayName>Hex Nut</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2493299</nodeId> <apiName>HexNutNumber</apiName> typeAUTONUMBER</type> <displayName>Hex Nut Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484785</nodeId> <apiName>IC</apiName> typeSUBCLASS</type> <displayName>IC</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2497703</nodeId> <apiName>ICNumber</apiName> typeAUTONUMBER</type> <displayName>IC Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498346</nodeId> <apiName>IPBlockAmp</apiName> typeSUBCLASS</type> <displayName>IP Block Amp</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498344</nodeId> <apiName>IPBlockNumber</apiName> typeAUTONUMBER</type> <displayName>IP Block Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498363</nodeId> <apiName>IPBlockBuffer</apiName> typeSUBCLASS</type> <displayName>IP Block Buffer</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498344</nodeId> <apiName>IPBlockNumber</apiName> typeAUTONUMBER</type> <displayName>IP Block Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498371</nodeId> <apiName>IPBlockDesign</apiName> typeSUBCLASS</type> <displayName>IP Block Design</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498344</nodeId> <apiName>IPBlockNumber</apiName> typeAUTONUMBER</type> <displayName>IP Block Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498379</nodeId> <apiName>IPBlockPLL</apiName> typeSUBCLASS</type> <displayName>IP Block PLL</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498344</nodeId> <apiName>IPBlockNumber</apiName> typeAUTONUMBER</type> <displayName>IP Block Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498387</nodeId> <apiName>IPBlockTiming</apiName> typeSUBCLASS</type> <displayName>IP Block Timing</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498344</nodeId> <apiName>IPBlockNumber</apiName> typeAUTONUMBER</type> <displayName>IP Block Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498395</nodeId> <apiName>IPStructure</apiName> typeSUBCLASS</type> <displayName>IP Structure</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498344</nodeId> <apiName>IPBlockNumber</apiName> typeAUTONUMBER</type> <displayName>IP Block Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499514</nodeId> <apiName>InsertSheet</apiName> typeSUBCLASS</type> <displayName>Insert Sheet</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499512</nodeId> <apiName>InsertSheet</apiName> typeAUTONUMBER</type> <displayName>Insert Sheet</displayName> </autoNumbers> </classes> <classes> <nodeId>2498232</nodeId> <apiName>Kit</apiName> typeSUBCLASS</type> <displayName>Kit</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498230</nodeId> <apiName>KitNumber</apiName> typeAUTONUMBER</type> <displayName>Kit Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484729</nodeId> <apiName>Label</apiName> typeSUBCLASS</type> <displayName>Label</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2497702</nodeId> <apiName>LabelNumber</apiName> typeAUTONUMBER</type> <displayName>Label Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498427</nodeId> <apiName>LeadFrame</apiName> typeSUBCLASS</type> <displayName>Lead Frame</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498425</nodeId> <apiName>PiecePart</apiName> typeAUTONUMBER</type> <displayName>Piece Part</displayName> </autoNumbers> </classes> <classes> <nodeId>2499456</nodeId> <apiName>Liquid</apiName> typeSUBCLASS</type> <displayName>Liquid</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499427</nodeId> <apiName>Liquid</apiName> typeAUTONUMBER</type> <displayName>Liquid</displayName> </autoNumbers> </classes> <classes> <nodeId>2498440</nodeId> <apiName>MaskDesign</apiName> typeSUBCLASS</type> <displayName>Mask Design</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498438</nodeId> <apiName>Mask</apiName> typeAUTONUMBER</type> <displayName>Mask</displayName> </autoNumbers> </classes> <classes> <nodeId>2000008528</nodeId> <apiName>Model</apiName> typeSUBCLASS</type> <displayName>Model</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2000009335</nodeId> <apiName>ModelClassNumber</apiName> typeAUTONUMBER</type> <displayName>Model Class Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499492</nodeId> <apiName>Molding</apiName> typeSUBCLASS</type> <displayName>Molding</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499490</nodeId> <apiName>Molding</apiName> typeAUTONUMBER</type> <displayName>Molding</displayName> </autoNumbers> </classes> <classes> <nodeId>2498449</nodeId> <apiName>OPN</apiName> typeSUBCLASS</type> <displayName>OPN</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498455</nodeId> <apiName>PartNumberGeneric</apiName> typeAUTONUMBER</type> <displayName>Part Number Generic</displayName> </autoNumbers> </classes> <classes> <nodeId>2498481</nodeId> <apiName>OPNFlashMemory</apiName> typeSUBCLASS</type> <displayName>OPN Flash Memory</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498455</nodeId> <apiName>PartNumberGeneric</apiName> typeAUTONUMBER</type> <displayName>Part Number Generic</displayName> </autoNumbers> </classes> <classes> <nodeId>2000008534</nodeId> <apiName>OptionClass</apiName> typeSUBCLASS</type> <displayName>Option Class</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2000009336</nodeId> <apiName>OptionClassNumber</apiName> typeAUTONUMBER</type> <displayName>Option Class Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484751</nodeId> <apiName>Packaging</apiName> typeSUBCLASS</type> <displayName>Packaging</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2497704</nodeId> <apiName>PackagingNumber</apiName> typeAUTONUMBER</type> <displayName>Packaging Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499499</nodeId> <apiName>Pallet</apiName> typeSUBCLASS</type> <displayName>Pallet</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499430</nodeId> <apiName>Pallet</apiName> typeAUTONUMBER</type> <displayName>Pallet</displayName> </autoNumbers> </classes> <classes> <nodeId>10141</nodeId> <apiName>Part</apiName> typeSUBCLASS</type> <displayName>Part</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498521</nodeId> <apiName>ProbeCard</apiName> typeSUBCLASS</type> <displayName>Probe Card</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498515</nodeId> <apiName>ProbeCardNumber</apiName> typeAUTONUMBER</type> <displayName>Probe Card Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498529</nodeId> <apiName>Process</apiName> typeSUBCLASS</type> <displayName>Process</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498516</nodeId> <apiName>ProcessStepNumber</apiName> typeAUTONUMBER</type> <displayName>Process Step Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484744</nodeId> <apiName>RawMaterial</apiName> typeSUBCLASS</type> <displayName>Raw Material</displayName> <abstractClass>false</abstractClass> </classes> <classes> <nodeId>2499449</nodeId> <apiName>Resin</apiName> typeSUBCLASS</type> <displayName>Resin</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499426</nodeId> <apiName>Resin</apiName> typeAUTONUMBER</type> <displayName>Resin</displayName> </autoNumbers> </classes> <classes> <nodeId>2484792</nodeId> <apiName>Resistor</apiName> typeSUBCLASS</type> <displayName>Resistor</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2497701</nodeId> <apiName>ResistorNumber</apiName> typeAUTONUMBER</type> <displayName>Resistor Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499484</nodeId> <apiName>Ribbon</apiName> typeSUBCLASS</type> <displayName>Ribbon</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499429</nodeId> <apiName>Ribbon</apiName> typeAUTONUMBER</type> <displayName>Ribbon</displayName> </autoNumbers> </classes> <classes> <nodeId>2498537</nodeId> <apiName>SKU</apiName> typeSUBCLASS</type> <displayName>SKU</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498517</nodeId> <apiName>SKUNumber</apiName> typeAUTONUMBER</type> <displayName>SKU Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499547</nodeId> <apiName>SlipSheet</apiName> typeSUBCLASS</type> <displayName>Slip Sheet</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499545</nodeId> <apiName>SlipSheet</apiName> typeAUTONUMBER</type> <displayName>Slip Sheet</displayName> </autoNumbers> </classes> <classes> <nodeId>2492901</nodeId> <apiName>Software</apiName> typeSUBCLASS</type> <displayName>Software</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484806</nodeId> <apiName>Switch</apiName> typeSUBCLASS</type> <displayName>Switch</displayName> <abstractClass>false</abstractClass> </classes> <classes> <nodeId>2499470</nodeId> <apiName>Tape</apiName> typeSUBCLASS</type> <displayName>Tape</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499432</nodeId> <apiName>Tape</apiName> typeAUTONUMBER</type> <displayName>Tape</displayName> </autoNumbers> </classes> <classes> <nodeId>2498553</nodeId> <apiName>TestProgram</apiName> typeSUBCLASS</type> <displayName>Test Program</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498518</nodeId> <apiName>TestProgramNumber</apiName> typeAUTONUMBER</type> <displayName>Test Program Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2498565</nodeId> <apiName>Transistor</apiName> typeSUBCLASS</type> <displayName>Transistor</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>12416</nodeId> <apiName>PartNumber</apiName> typeAUTONUMBER</type> <displayName>Part Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2484736</nodeId> <apiName>Tubing</apiName> typeSUBCLASS</type> <displayName>Tubing</displayName> <abstractClass>false</abstractClass> </classes> <classes> <nodeId>2498573</nodeId> <apiName>Wafer</apiName> typeSUBCLASS</type> <displayName>Wafer</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2498519</nodeId> <apiName>WaferNumber</apiName> typeAUTONUMBER</type> <displayName>Wafer Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499557</nodeId> <apiName>Web</apiName> typeSUBCLASS</type> <displayName>Web</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499555</nodeId> <apiName>Web</apiName> typeAUTONUMBER</type> <displayName>Web</displayName> </autoNumbers> </classes> <classes> <nodeId>2499463</nodeId> <apiName>Wrap</apiName> typeSUBCLASS</type> <displayName>Wrap</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499428</nodeId> <apiName>Wrap</apiName> typeAUTONUMBER</type> <displayName>Wrap</displayName> </autoNumbers> </classes> <superClass> <nodeId>10000</nodeId> <apiName>PartsClass</apiName> typeCLASS</type> <displayName>Parts</displayName> </superClass> </responses> <responses> <classId>6000</classId> <classes> <nodeId>2469135</nodeId> <apiName>VER</apiName> typeSUBCLASS</type> <displayName>+VER</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2469134</nodeId> <apiName>DVONumber</apiName> typeAUTONUMBER</type> <displayName>DVO Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2469143</nodeId> <apiName>Baseline</apiName> typeSUBCLASS</type> <displayName>Baseline</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2469142</nodeId> <apiName>BaselineNumber</apiName> typeAUTONUMBER</type> <displayName>Baseline Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2497720</nodeId> <apiName>ChangeTask</apiName> typeSUBCLASS</type> <displayName>Change Task</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2497719</nodeId> <apiName>TaskNumber</apiName> typeAUTONUMBER</type> <displayName>Task Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2485820</nodeId> <apiName>DesignReview</apiName> typeSUBCLASS</type> <displayName>Design Review</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2485819</nodeId> <apiName>DesignReviewNumber</apiName> typeAUTONUMBER</type> <displayName>Design Review Number</displayName> </autoNumbers> </classes> <classes> <nodeId>6141</nodeId> <apiName>ECO</apiName> typeSUBCLASS</type> <displayName>ECO</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>990</nodeId> <apiName>ECONumber</apiName> typeAUTONUMBER</type> <displayName>ECO Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2499037</nodeId> <apiName>IPTicket</apiName> typeSUBCLASS</type> <displayName>IP Ticket</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2499036</nodeId> <apiName>IPValidation</apiName> typeAUTONUMBER</type> <displayName>IP Validation</displayName> </autoNumbers> </classes> <classes> <nodeId>2469150</nodeId> <apiName>Library</apiName> typeSUBCLASS</type> <displayName>Library</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2469149</nodeId> <apiName>LibraryNumber</apiName> typeAUTONUMBER</type> <displayName>Library Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2494900</nodeId> <apiName>PCN</apiName> typeSUBCLASS</type> <displayName>PCN</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2494899</nodeId> <apiName>PCNNumber</apiName> typeAUTONUMBER</type> <displayName>PCN Number</displayName> </autoNumbers> </classes> <classes> <nodeId>2469128</nodeId> <apiName>REV</apiName> typeSUBCLASS</type> <displayName>REV</displayName> <abstractClass>false</abstractClass> <autoNumbers> <nodeId>2469127</nodeId> <apiName>DRONumber</apiName> typeAUTONUMBER</type> <displayName>DRO Number</displayName> </autoNumbers> </classes> <superClass> <nodeId>6000</nodeId> <apiName>ChangeOrdersClass</apiName> typeCLASS</type> <displayName>Change Orders</displayName> </superClass> </responses> </response> </getSubclassesResponse> </soapenv:Body> </soapenv:Envelope>
Service
To retrieve the setting for the preferred language of the current user.
Usage
The request must not contain any AgileObject. It must contain an empty element of type GetUserPreferredLanguageRequest. The service returns the preferred language in the response.
Syntax
GetUserPreferredLanguageRequestType request = new GetUserPreferredLanguageRequestType(); GetUserPreferredLanguageResponseType response = service.getUserPreferredLanguage(request);
Create the request object GetUserPreferredLanguageRequestType for the getUserPreferredLanguage operation.
Create an empty element of type GetUserPreferredLanguageRequest and set it to the request type created above.
Call the WebService and get the preferred language setting from the response.
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> <getUserPreferredLanguage xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <requests/> </request> </getUserPreferredLanguage> </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> <getUserPreferredLanguageResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <ressponse xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> <responses> <language>en</language> <country/> </responses> </ressponse> </getUserPreferredLanguageResponse> </soapenv:Body> </soapenv:Envelope>
Service
To remove a bookmark for one or multiple objects from a bookmark folder in Agile PLM. If the folder name is omitted in the request, the My Bookmarks folder is used. If a folder is specified, it must be an existing sub folder of My Bookmarks.
Usage
Returns an AddBookmarkResponseType containing the status of the operation.
Syntax
RemoveBookmarkRequestType request = new RemoveBookmarkRequestType(); RemoveBookmarkResponseType response = service.removeBookmark(request);
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> <removeBookmark xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <generalParameters> <id xsi:nil="true"/> <property> <propertyName>folder-name</propertyName> <propertyValue>Test</propertyValue> </property> </generalParameters> <requests> <classId>1488</classId> <objectNumber>TEST_MFR_PART4751636</objectNumber> <inputParameters> <id>CommonProperties</id> <property> <propertyName>manufacturer_name</propertyName> <propertyValue>ECS</propertyValue> </property> </inputParameters> </requests> </request> </removeBookmark> </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> <removeBookmarkResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> </response> </removeBookmarkResponse> </soapenv:Body> </soapenv:Envelope>
|
Note: folder-name = Name of the folder from which you remove bookmark (optional). If not set, main folder is default. |
Service
To remove a part assignment from a Design or another part.
Usage
Returns an array of AgileBusinessObjectType of type Part in the response object.
Syntax
RemovePartAssignmentRequestType request = new RemovePartAssignmentRequestType(); RemovePartAssignmentResponseType response = service.removePartAssignment(request);
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> <removePartAssignment xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <request xmlns=""> <requests> <classId>Design</classId> <objectNumber>100-00335.ASM</objectNumber> <objectVersion>1</objectVersion> </requests> </request> </removePartAssignment> </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> <removePartAssignmentResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> <responses> <agileObject> <objectId> <classId>2000008310</classId> <className>Design</className> <classDisplayName>Design</classDisplayName> <objectId>6358582</objectId> <objectName>100-00335.ASM</objectName> <objectVersion>1</objectVersion> <version>16</version> <superClassId>2000008297</superClassId> </objectId> <table> <tableId> <classId>2000008310</classId> <className>Design</className> <objectId>6358582</objectId> <objectName>100-00335.ASM</objectName> <tableId>2000007761</tableId> <tableName>Relationships</tableName> <tableDisplayName>Relationships</tableDisplayName> </tableId> </table> <attribute apiName="number" id="6173" type="xsd:string"> <String> <value>100-00335.ASM</value> </String> </attribute> <attribute apiName="type" id="6175" type="ns1:AgileListEntryType" xmlns:ns1="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>2000008310</id> <apiName>Design</apiName> <value>Design</value> </selection> </value> </SingleList> </attribute> <attribute apiName="description" id="6174" type="xsd:string"> <String> <value>ASM0001-ASM</value> </String> </attribute> <attribute apiName="componentType" id="2000008317" type="ns2:AgileListEntryType" xmlns:ns2="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="lifecyclePhase" id="6390" type="ns3:AgileListEntryType" xmlns:ns3="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="label" id="2000008316" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="version" id="7951" type="xsd:integer"> <Integer> <value>1</value> </Integer> </attribute> <attribute apiName="revision" id="2000008685" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="revisionDate" id="2000008686" type="xsd:date"> <Date> <value xsi:nil="true"/> </Date> </attribute> <attribute apiName="checkoutStatus" id="6389" type="ns4:AgileListEntryType" xmlns:ns4="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>0</id> <apiName>CHECKED_OUT</apiName> <value>Checked Out</value> </selection> </value> </SingleList> </attribute> <attribute apiName="checkoutUser" id="6180" type="ns5:AgileListEntryType" xmlns:ns5="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>6013686</id> <apiName xsi:nil="true"/> <value>CAD One (cad1)</value> </selection> </value> </SingleList> </attribute> <attribute apiName="checkoutDate" id="6184" type="xsd:date"> <Date> <value>2010-09-24T08:30:26.000Z</value> </Date> </attribute> <attribute apiName="checkoutLocation" id="6183" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="createDate" id="6177" type="xsd:date"> <Date> <value>2010-09-24T08:12:12.000Z</value> </Date> </attribute> <attribute apiName="lastModifiedDate" id="6178" type="xsd:date"> <Date> <value>2012-02-22T10:35:10.000Z</value> </Date> </attribute> <attribute apiName="checkinUser" id="2000008717" type="ns6:AgileListEntryType" xmlns:ns6="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>6013686</id> <apiName xsi:nil="true"/> <value>CAD One (cad1)</value> </selection> </value> </SingleList> </attribute> <attribute apiName="checkinDate" id="6388" type="xsd:date"> <Date> <value>2010-09-24T08:14:05.000Z</value> </Date> </attribute> <attribute apiName="thumbnail" id="2000008554" type="ns7:AgileListEntryType" xmlns:ns7="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="approvalStatus" id="2000009374" type="ns8:AgileListEntryType" xmlns:ns8="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="itemChangeStatus" id="2000009487" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="heading01" id="12257" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text01" id="2007" type="xsd:string"> <String> <value>Pro/E Wildfire 3.0</value> </String> </attribute> <attribute apiName="multiText10" id="2017" type="xsd:string"> <String> <value>100-00335.ASM</value> </String> </attribute> <attribute apiName="text03" id="2009" type="xsd:string"> <String> <value>ASM</value> </String> </attribute> <attribute apiName="text04" id="2010" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="createUser" id="1420" type="ns9:AgileListEntryType" xmlns:ns9="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value> <selection> <id>6013686</id> <apiName xsi:nil="true"/> <value>CAD One (cad1)</value> </selection> </value> </SingleList> </attribute> <attribute apiName="list01" id="2020" type="ns10:AgileListEntryType" xmlns:ns10="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="text10" id="2016" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text12" id="1302" type="xsd:string"> <String> <value>100-00335</value> </String> </attribute> <attribute apiName="text19" id="1309" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="heading06" id="12263" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text15" id="1305" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="list03" id="2022" type="ns11:AgileListEntryType" xmlns:ns11="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="list04" id="2023" type="ns12:AgileListEntryType" xmlns:ns12="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="text14" id="1304" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="heading05" id="12262" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiText32" id="1332" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiText33" id="1333" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text06" id="2012" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiText34" id="1334" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiText35" id="1335" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text09" id="2015" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="heading02" id="12258" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text13" id="1303" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="heading03" id="12259" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiList01" id="2090" type="ns13:AgileMultiListEntryType" xmlns:ns13="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value> <selection> <id>2605304</id> <apiName>INTERNAL</apiName> <value>INTERNAL</value> </selection> </value> </MultiList> </attribute> <attribute apiName="multiList02" id="2091" type="ns14:AgileMultiListEntryType" xmlns:ns14="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value/> </MultiList> </attribute> <attribute apiName="multiList03" id="2092" type="ns15:AgileMultiListEntryType" xmlns:ns15="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value/> </MultiList> </attribute> <attribute apiName="notes" id="1080" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text05" id="2011" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="money01" id="8155" type="ns16:AgileMoneyType" xmlns:ns16="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <Money> <value xsi:nil="true"/> </Money> </attribute> <attribute apiName="numeric01" id="12468" type="xsd:double"> <Number> <value xsi:nil="true"/> </Number> </attribute> <attribute apiName="multiList04" id="2000008063" type="ns17:AgileMultiListEntryType" xmlns:ns17="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value/> </MultiList> </attribute> <attribute apiName="heading01" id="12458" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="list02" id="1540" type="ns18:AgileListEntryType" xmlns:ns18="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="list01" id="1539" type="ns19:AgileListEntryType" xmlns:ns19="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <SingleList> <value/> </SingleList> </attribute> <attribute apiName="text01" id="1575" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="multiList01" id="1564" type="ns20:AgileMultiListEntryType" xmlns:ns20="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value/> </MultiList> </attribute> <attribute apiName="multiList02" id="1565" type="ns21:AgileMultiListEntryType" xmlns:ns21="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <MultiList> <value/> </MultiList> </attribute> <attribute apiName="number_Turns" id="2499904" type="xsd:double"> <Number> <value xsi:nil="true"/> </Number> </attribute> <attribute apiName="developer" id="2499905" type="xsd:string"> <String> <value/> </String> </attribute> </agileObject> </responses> </response> </removePartAssignmentResponse> </soapenv:Body> </soapenv:Envelope>
Service
Returns a Design structure with CAD assemblies and parts supporting 4 structure resolution options (latest, as saved, released, published). You can also configure it to return CAD drawings (linked through WhereUsed tab), and external references and forms (linked through Relationships tab). The service is also capable of returning chunked responses to maintain a balance between the client server and server memory load and network payload. By default, it returns all tables and attributes. Specifying corresponding attribute filters, limits the return of only required tables and attributes. The object in the request must be of type Design class or any subclass of it. The chosen structure resolution option affects the versions of the objects under the top level object (the one passed in the request), but not the top level object's version.The top level object's version is always the one that is passed in the request. If no objectVersion is set in the request, the latest version/revision of the object is used. All other objects linked through the relationship tab are determined based on the structure resolution option.
Service
The 'latest' option returns the latest version of all Design objects in the structure. If the Design is checked-out, the service returns the latest non-pending version. But, if the user retrieving the structure and the check-out user are the same, it returns the pending version.
The 'as saved' option returns the version of all Design objects as linked in the structure. If the Design is checked-out, the service returns the latest non-pending version. But, if the user retrieving the structure and the check-out user are the same, it returns the pending version.
The 'released' option returns the latest version of all checked-in Design objects and does not consider checked-out versions from the same user.
The 'published' option returns the latest version of all Design objects published to an item. The revision field on the Design object determines the revision of the linked item. Design objects with empty revision fields are not considered as the latest published version.
Usage
Returns an AgileBusinessObjectType for Design in the response object.
Syntax
AgileECResponseExtType retrieveDesignStructureResponseType = agileStub.retrieveDesignStructure(retrieveDesignStructureRequestType)
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> <retrieveDesignStructureResponse xmlns="http://xmlns.oracle.com/AgileObjects/ECS/V1"> <response xmlns=""> <messageId xsi:nil="true"/> <messageName xsi:nil="true"/> <statusCode>SUCCESS</statusCode> <sessionParameters> <id>VersionProperties</id> <property> <propertyName>ECS</propertyName> <propertyValue>9.3.2</propertyValue> </property> <property> <propertyName>Build</propertyName> <propertyValue>Build 00</propertyValue> </property> </sessionParameters> <responses> <agileObject> <objectId> <classId>2000008310</classId> <className>Design</className> <classDisplayName>Design</classDisplayName> <objectId>6895791</objectId> <objectName>100-01137.SLDASM</objectName> <objectVersion>1</objectVersion> <version>29</version> <superClassId>2000008297</superClassId> </objectId> <table> <tableId> <classId>2000008310</classId> <className>Design</className> <objectId>6895791</objectId> <objectName>100-01137.SLDASM</objectName> <tableId>6150</tableId> <tableName>Files</tableName> <tableDisplayName>Files</tableDisplayName> </tableId> <row rowId="6896005"> <objectReferentId> <classId>2000008310</classId> <className>Design</className> <classDisplayName>Design</classDisplayName> <objectId>6895791</objectId> <objectName>100-01137.SLDASM</objectName> <objectVersion>1</objectVersion> <version>29</version> <superClassId>2000008297</superClassId> </objectReferentId> <attribute apiName="fileName" id="6303" type="xsd:string"> <String> <value>160045.SLDASM</value> </String> </attribute> <attribute apiName="fileCategory" id="2000008509" type="ns1:AgileListEntryType" xmlns:ns1="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>Source</value> </String> </attribute> <attribute apiName="fileSize" id="6148" type="xsd:double"> <String> <value>989696.0</value> </String> </attribute> <attribute apiName="fileid" id="-1" type="xsd:integer"> <String> <value>6895926</value> </String> </attribute> </row> </table> <table> <tableId> <classId>2000008310</classId> <className>Design</className> <objectId>6895791</objectId> <objectName>100-01137.SLDASM</objectName> <tableId>2000008318</tableId> <tableName>Structure</tableName> <tableDisplayName>Structure</tableDisplayName> </tableId> <row rowId="6895995"> <objectReferentId> <classId>2000008310</classId> <className>Design</className> <classDisplayName>Design</classDisplayName> <objectId>6895445</objectId> <objectName>100-01133.SLDPRT</objectName> <objectVersion>1</objectVersion> <version>19</version> <superClassId>2000008297</superClassId> </objectReferentId> <attribute apiName="number" id="2000008320" type="xsd:string"> <String> <value>100-01133.SLDPRT</value> </String> </attribute> <attribute apiName="description" id="2000008321" type="xsd:string"> <String> <value>TEST PART</value> </String> </attribute> <attribute apiName="quantity" id="2000008325" type="xsd:double"> <String> <value>0.0</value> </String> </attribute> <attribute apiName="version" id="2000008323" type="xsd:integer"> <String> <value>1</value> </String> </attribute> <attribute apiName="identifier" id="2000008377" type="xsd:string"> <String> <value>CAX-SW</value> </String> </attribute> <attribute apiName="findNum" id="2000008324" type="xsd:double"> <String> <value>0.0</value> </String> </attribute> </row> </table> <table> <tableId> <classId>2000008310</classId> <className>Design</className> <objectId>6895791</objectId> <objectName>100-01137.SLDASM</objectName> <tableId>2000007761</tableId> <tableName>Relationships</tableName> <tableDisplayName>Relationships</tableDisplayName> </tableId> </table> <attribute apiName="number" id="6173" type="xsd:string"> <String> <value>100-01137.SLDASM</value> </String> </attribute> <attribute apiName="type" id="6175" type="ns2:AgileListEntryType" xmlns:ns2="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>Design</value> </String> </attribute> <attribute apiName="description" id="6174" type="xsd:string"> <String> <value>TEST ASSEMBLY</value> </String> </attribute> <attribute apiName="lifecyclePhase" id="6390" type="ns3:AgileListEntryType" xmlns:ns3="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>In Work</value> </String> </attribute> <attribute apiName="version" id="7951" type="xsd:integer"> <String> <value>1</value> </String> </attribute> <attribute apiName="revision" id="2000008685" type="xsd:string"> <String> <value>Introductory.1</value> </String> </attribute> <attribute apiName="checkoutStatus" id="6389" type="ns4:AgileListEntryType" xmlns:ns4="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>Checked In</value> </String> </attribute> <attribute apiName="checkoutUser" id="6180" type="ns5:AgileListEntryType" xmlns:ns5="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value/> </String> </attribute> <attribute apiName="checkoutDate" id="6184" type="xsd:date"> <String> <value xsi:nil="true"/> </String> </attribute> <attribute apiName="createDate" id="6177" type="xsd:date"> <String> <value>2012-11-20T21:46:47Z</value> </String> </attribute> <attribute apiName="lastModifiedDate" id="6178" type="xsd:date"> <String> <value>2012-11-20T21:50:21Z</value> </String> </attribute> <attribute apiName="checkinUser" id="2000008717" type="ns6:AgileListEntryType" xmlns:ns6="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>CAD One (cad1)</value> </String> </attribute> <attribute apiName="checkinDate" id="6388" type="xsd:date"> <String> <value>2012-11-20T21:50:17Z</value> </String> </attribute> <attribute apiName="text12" id="1302" type="xsd:string"> <String> <value/> </String> </attribute> <attribute apiName="text01" id="2007" type="xsd:string"> <String> <value>SW2011</value> </String> </attribute> <attribute apiName="multiText10" id="2017" type="xsd:string"> <String> <value>160045.SLDASM</value> </String> </attribute> <attribute apiName="text03" id="2009" type="xsd:string"> <String> <value>SLDASM</value> </String> </attribute> <attribute apiName="createUser" id="1420" type="ns7:AgileListEntryType" xmlns:ns7="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>CAD One (cad1)</value> </String> </attribute> <attribute apiName="numeric01" id="12468" type="xsd:double"> <String> <value xsi:nil="true"/> </String> </attribute> <attribute apiName="multiText32" id="1332" type="xsd:string"> <String> <value>GENERIC</value> </String> </attribute> <attribute apiName="text06" id="2012" type="xsd:string"> <String> <value>GENERIC</value> </String> </attribute> <attribute apiName="multiList01" id="2090" type="ns8:AgileMultiListEntryType" xmlns:ns8="http://xmlns.oracle.com/AgileObjects/Core/Common/V1"> <String> <value>INTERNAL</value> </String> </attribute> <options> <propertyName>latest-version</propertyName> <propertyValue>1</propertyValue> </options> <options> <propertyName>resolution</propertyName> <propertyValue>true</propertyValue> </options> </agileObject> <outputParameters xsi:nil="true"/> </responses> </response> </retrieveDesignStructureResponse> </soapenv:Body> </soapenv:Envelope>
Table B-5 Code options
|
Name |
Description |
|
skip_p2_p3_attributes |
Flag to skip page two and page three attributes. False by default. |
|
resolution |
Structure resolution. Options are 'latest', 'released', 'published', 'as-saved'. Latest by default. |
|
structure |
Flag to include structure. True by default. If set to 'false', returns no children of the Design object; returns only the attributes of the top level Design object. If set to "true", returns all Designs having a value starting with "CAX-" in the CAD Ident field. |
|
drawings |
Flag to include drawings. False by default. This option runs through the Where Used tab to check for all drawings. |
|
items |
Flag to include items/parts. False by default. If set to 'true', returns all Design objects linked to the items. |
|
external-refs |
Flag to include external references. False by default. If set to 'true', returns all external references (special CAD objects) linked through the relationship tab and have the parent Design object's number in the Ident field. |
|
structure-depth |
Depth for structure resolution. ' -1' indicating all by default. |
|
retrieve-initial-version-1 |
Flag to retrieve initial version 1. True by default. |
|
merge_latest_checkedin |
Flag to merge latest check-in. True by default. |
|
strings-only |
Flag to return string values or actual data types. False by default. |
|
skip-empty |
Flag to omit empty values in the response to reduce the payload. False by default. |
|
 Copyright © 2010, 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|