Skip Headers
Agile Product Lifecycle Management Web Services Guide
Release 9.3.3
E39310-01
Next
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
1
Introduction to Agile PLM Web Services
1.1
About Service Oriented Architecture (SOA)
1.2
Web Services - Benefits
1.2.1
Core Technologies
1.2.1.1
Web Services Description Language
1.2.1.2
XML and XML Schema
1.2.1.3
Simple Object Access Protocol
1.2.2
Web Services Architecture
1.3
About Agile PLM Web Services
1.3.1
Agile PLM Core Web Services
1.3.2
Agile PLM EC Services
1.3.3
Agile Recipe & Material Workspace Web Services
1.3.4
Agile PLM Web Service Authentication and Performance
1.3.5
Impact on Existing Agile PLM Extensions and Services
1.4
Casual User Interface Integration Examples
1.4.1
User Interface Integration - MS Word
1.4.2
User Interface Integration - MS Excel
1.4.3
User Interface Integration - Portals and Agile Web Client
1.4.4
User Interface Integration - Mobile ADF
1.4.5
CAD Integration through EC Services
1.5
Building Casual User Interfaces
1.5.1
Developing User Interfaces for MS Office
1.5.2
Developing User Interfaces for Oracle WebCenter and ADF
2
Getting Started with Agile Web Services
2.1
Operational Environment
2.1.1
Standards Compliance
2.1.2
Web Service Engines
2.2
Generating and Initializing the Stubs
2.2.1
Generating Agile Stubs
2.2.2
Initializing the Client Stubs
2.3
Understanding the MessageElement
2.3.1
Obtaining the API Names and Attribute IDs
2.3.2
Special Handling of MessageElements
2.3.2.1
Unit of Measure
2.3.2.2
Multilist and List
2.3.2.3
List of Objects
2.3.2.4
Money
2.3.2.5
Date
2.3.2.6
User/Supplier/ Customer/Analyst
2.4
Agile Attributes without API Names
2.4.1
Item Constants
2.4.2
User Constants
2.5
Understanding the Web Services Request-Response
2.5.1
Response Status Code
2.5.2
Exceptions and Warnings
2.5.2.1
Working with Warnings
3
Working with Business Objects
3.1
Getting an Object
3.1.1
Special Handling in the getObject Operation
3.2
Creating an Object
3.3
Creating a Reference Object
3.4
Saving As a New Object
3.4.1
Special Handling in the saveAsObject Operation
3.5
Deleting and Undeleting an Object
3.5.1
Checking the Delete Status
3.6
Deleting a Reference Object
3.7
Updating an Object
3.8
Updating a Reference Object
3.9
Getting the Status of an Object
3.10
Getting the AutoNumbers
3.11
Getting all the Classes
3.12
Getting the Subclasses of a Class
3.13
Getting Agile Classes
4
Subscribing to Agile PLM Objects
4.1
Subscribe Privilege
4.2
Subscription Notifications
4.2.1
Getting Subscriptions for an Object
4.2.2
Modifying the Subscriptions of an Object
5
Working with Tables
5.1
About Tables
5.2
Operations Supported on Tables
5.2.1
PC
5.2.2
PQM
5.3
Loading a Table
5.3.1
Special Handling in the loadTable Operation
5.3.2
Working with the Readonly Tables
5.3.3
Retrieving the Metadata of a Table
5.4
Adding Rows to a Table
5.4.1
Special Handling in the addRows Operation
5.4.1.1
Adding a Site to the Sites Tab of an Item
5.4.1.2
Adding Suppliers to the Suppliers Tab of an Item
5.4.1.3
Adding Suppliers to a Manufacturer Part
5.4.1.4
Adding Manufacturer Part to AML of an Item
5.4.1.5
Adding Manufacturer Part to the Relationships Tab
5.4.1.6
Adding Affected Item to a Change
5.4.1.7
Adding Site Specific Item to the BOM Tab
5.4.1.8
Adding Site Specific AML to the Manufacturers Tab
5.4.1.9
Adding Material to Item Table
5.4.1.10
Adding Rows to the Relationship Table of a Reference Object
5.5
Updating Rows in a Table
5.6
Removing Rows from a Table
5.7
Clearing a Table
5.8
Copying Tables
5.9
Redlining a Table
6
Working with File Folders and Attachments
6.1
Agile File Folders
6.2
Managing File Folders
6.2.1
Creating a File Folder
6.2.2
Checking Out a File Folder
6.2.3
Setting the Version of File Folder Files
6.2.4
Canceling a File Folder Checkout
6.2.5
Checking In a File Folder
6.2.6
Deleting the File Folders
6.3
Getting a File from a File Folder
6.3.1
Getting a File from a File Folder using a Download URL
6.3.2
Getting a File from a Version of File Folder
6.4
Adding Files to a File Folder Object
6.4.1
Adding Files in a File Folder
6.5
Managing Attachments
6.5.1
Getting Attachments of an Object
6.5.1.1
Getting a Specific Attachment and a File Folder
6.5.1.2
Getting a Specific Attachment using a URL
6.5.2
Adding Attachments to an Object
6.5.2.1
Adding attachments by File Reference
6.5.2.2
Adding Multiple Attachments into Single Folder
6.5.3
Adding Files using SOAP Attachment
6.5.4
Checking Out the Attachments
6.5.4.1
Checking Out All the Attachments
6.5.4.2
Checking Out Multiple Attachments from a Folder
6.5.5
Checking In the Attachments
6.5.5.1
Checking In an Attachment with FileId Identification
6.5.6
Deleting the Attachments
7
Managing Workflows
7.1
About Agile PLM Workflows
7.1.1
How the Status of a Change Affects Workflow Functionality
7.2
Getting the Status of a Workflow
7.3
Getting the Workflow of a Routable Object
7.4
Setting a Workflow
7.5
Checking User Privileges
7.6
Adding and Removing Approvers
7.7
Getting Approvers
7.8
Approving a Routable Object
7.9
Rejecting a Routable Object
7.10
Commenting a Change
7.11
Auditing a Change
7.12
Changing the Workflow Status of an Object
8
Working with Queries
8.1
Creating a Query
8.2
Creating a New Query from an Existing Query Object
8.3
Loading a Query
8.4
Executing a Saved Query
8.5
Updating a Saved Query
8.6
Deleting a Query
9
Working with Searches
9.1
Agile PLM Searches
9.2
Specifying Search Criteria
9.2.1
Search Conditions
9.2.2
Search Operation Keywords
9.2.3
Specifying Search Attributes
9.2.4
Getting the Searchable Attributes
9.2.5
Using Relational Operators
9.2.5.1
Using Unicode Escape Sequences
9.2.5.2
Using Between, Not Between, In, and Not In Operators
9.2.5.3
Using the Nested Criteria to Search for Values in Object Lists
9.2.5.4
Searching for Words or Phrases Contained in Attachments
9.2.6
Using Logical Operators
9.2.7
Using Wildcard Characters with the Like Operator
9.2.8
Using Parentheses in Search Criteria
9.3
Using SQL Syntax to Specify Search Criteria
9.3.1
Using SQL Wildcards
9.4
Setting Result Attributes for a Search
9.4.1
Specifying Result Attributes
9.5
Examples of Searches
9.5.1
Quick Search
9.5.2
Advanced Search
9.5.3
Getting the Searchable Attributes
10
Working with Folders
10.1
Loading a Folder
10.2
Creating a Folder
10.3
Working with Folder Elements
10.3.1
Adding Folder Elements
10.3.2
Removing Folder Elements
10.3.3
Getting Folder Elements
10.4
Deleting a Folder
10.5
Renaming a Folder
11
Working with Projects
11.1
Differences in the Behavior of Projects Objects
11.2
Working with Project Baselines
11.2.1
Creating Baselines
11.2.2
Getting Baselines
11.2.3
Removing Baselines
11.3
Substituting Project Resources
11.4
Delegating Ownership of a Project to Another User
11.5
Locking and Unlocking Projects
11.5.1
Checking Projects Lock Status
12
Publishing Documents
12.1
Document Publishing Web Services Operations
12.1.1
Loading XML Schema of Objects
12.1.2
Loading XML Data of Objects
13
Working with Reports
13.1
Generating Assembly Cost Reports for Sourcing Projects
13.2
Understanding Assembly Cost Report Parameters
14
Managing Users and User Profiles
14.1
Handling User Passwords
14.2
Managing Transfer Authorities
15
Working with Recipe & Material Workspace
15.1
Performing Searches
15.1.1
Using Operators
15.1.2
Searching with Sorting
15.1.3
Searching with Multiple Criteria Values
15.2
Editing User Data
15.3
Processing Business Objects
15.4
Using the cfmXML Schema
15.4.1
Sample cfmXML message 1
15.4.1.1
LoginInfo
15.4.1.2
SessionInfo
15.4.1.3
PageInfo
15.4.1.4
Response
15.4.2
Sample cfmXML message 2
15.4.2.1
SearchCriteria
15.4.2.2
Attribute
15.4.2.3
Relationship
15.4.2.4
ObjectKey
15.4.2.5
SearchInfo
15.4.3
Sample cfmXML message 3
15.4.3.1
Payload
15.4.3.2
Object
15.4.3.3
AdditionalInfo
16
Core Operations - Agile PLM Web Services
16.1
Admin and Metadata Web Services
16.1.1
getAllClasses
16.1.2
getSubClasses
16.1.3
getNode
16.1.4
getLists
16.1.5
getAttributes
16.1.6
getTableMetadata
16.1.7
getAutoNumbers
16.1.8
getUsers
16.1.9
getUserGroups
16.1.10
convertCurrency
16.1.11
changeLoginPassword
16.1.12
changeApprovalPassword
16.1.13
createTransferAuthority
16.1.14
getTransferAuthority
16.1.15
modifyTransferAuthority
16.1.16
removeTransferAuthority
16.1.17
getAgileClass
16.2
Attachment Web Services
16.2.1
getFileAttachment
16.2.2
addFileAttachment
16.2.3
checkOutAttachment
16.2.4
checkInAttachment
16.2.5
getFileFF
16.2.6
addFileFF
16.2.7
checkOutFF
16.2.8
checkInFF
16.2.9
cancelCheckOutFF
16.3
Core Web Services Operations
16.3.1
createObject
16.3.2
getObject
16.3.3
updateObject
16.3.4
deleteObject
16.3.5
undeleteObject
16.3.6
isDeletedObject
16.3.7
sendObject
16.3.8
saveAsObject
16.3.9
checkPrivilege
16.3.10
getSubscriptions
16.3.11
modifySubscriptions
16.3.12
createReferenceObject
16.3.13
getReferenceObject
16.3.14
deleteReferenceObject
16.3.15
updateReferenceObject
16.4
Collaboration Web Services
16.4.1
getWorkflows
16.4.2
getStatus
16.4.3
auditRObject
16.4.4
getApprovers
16.4.5
changeStatus
16.4.6
approveRObject
16.4.7
rejectRObject
16.4.8
setWorkFlow
16.4.9
addApprovers
16.4.10
removeApprovers
16.4.11
commentRObject
16.4.12
getReviewers
16.4.13
acknowledgeRObject
16.4.14
getAllReviewers
16.4.15
addReviewers
16.4.16
removeReviewers
16.5
Doc Publishing Web Services
16.5.1
loadXMLSchema
16.5.2
loadXMLData
16.6
Folder Web Services
16.6.1
getFolder
16.6.2
createFolder
16.6.3
deleteFolder
16.6.4
addChildNode
16.6.5
getChildNode
16.6.6
removeChildNode
16.7
PC Web Services
16.7.1
setIncorporate
16.7.2
getRevisions
16.7.3
undoRedline
16.7.4
isIncorporated
16.8
Project Web Services
16.8.1
createBaseline
16.8.2
removeBaseline
16.8.3
getBaselines
16.8.4
delegateOwnership
16.8.5
substituteResource
16.8.6
isLocked
16.8.7
setLock
16.8.8
reschedule
16.8.9
assignUsersFromPool
16.9
Reports Web Services
16.9.1
loadReportSchema
16.9.2
loadReportData
16.10
Search Web Services
16.10.1
quickSearch
16.10.2
advancedSearch
16.10.3
advancedSearchReferenceObject
16.10.4
getSearchableAttributes
16.10.5
getSearchableClasses
16.11
Query Web Services
16.11.1
createQuery
16.11.2
loadQuery
16.11.3
executeSavedQuery
16.11.4
saveAsQuery
16.11.5
updateQuery
16.11.6
deleteQuery
16.12
Tables Web Services
16.12.1
isReadOnlyTable
16.12.2
clearTable
16.12.3
copyTable
16.12.4
addRows
16.12.5
updateRows
16.12.6
removeRows
16.12.7
loadTable
16.12.8
isFlagSet
16.12.9
addrowstoReferenceObject
16.12.10
getNotifications
16.12.11
deleteNotifications
16.12.12
getMyWorkFlowRoutings
A
Operations - EC Web Services
A.1
addBookmark
A.2
createUpdateObjects
A.3
generateThumbnails
A.4
getFilteredObject
A.5
getListValues
A.6
getSubclasses
A.7
getUserPreferredLanguage
A.8
removeBookmark
A.9
removesPartAssignment
A.10
retrieveDesignStructure
B
Operations - RMW Web Services
B.1
CFMBOWWebServices
B.1.1
processBO
B.2
CFMCampaignService
B.2.1
changeLifeCyclePhase
B.2.2
getReservedInventory
B.2.3
getReservedEquipment
B.3
CFMEditWebService
B.3.1
edit
B.4
CFMExternalAttachmentWebService
B.4.1
addAttachment
B.4.2
editAttachment
B.4.3
removeAttachment
B.5
CFMInventoryService
B.5.1
changestatus
B.6
CFMSampleService
B.6.1
addResults
B.6.2
getSamples
B.7
CFMSearchWebService
B.7.1
search
B.8
CFMWorkflowService
B.8.1
takeActionOnState
B.9
CFMWorkrequestService
B.9.1
create
B.9.2
closeOut
B.9.3
updateEquipmentActivity
B.9.4
updateInventoryConsumption
B.9.5
updateResourceInformation
B.9.6
getWorkRequestRecipe
B.9.7
updateWorkRequestRecipe
B.9.8
recordParameterResults
C
Working with Java Sample Code
C.1
Building Stubs and Compiling the Samples
C.2
Executing the Samples using ant Task
C.3
Executing the Samples using a Java IDE
C.4
Understanding the Code
C.5
AddFileSOAPAttachment Method
C.6
Helper Methods
C.6.1
getRowId Method
C.6.1.1
getFileId Method
C.7
Troubleshooting
