Go to primary content
Agile Product Lifecycle Management Web Services Guide
Release 9.3.6
E71166-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 Recipe & Material Workspace Web Services
1.3.3
Agile PLM Web Service Authentication and Performance
1.3.4
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
1.6
SAML Enabled Web Services
1.6.1
Impact of Framework Changes
1.6.2
WSDL and XSD Changes
1.6.2.1
jaxws: binding changes
1.6.2.2
jaxb:binding changes
1.6.2.3
Global jaxb: binding changes
1.6.2.4
SOAP Encode not supported
1.6.2.5
MTOM Changes in WSDL
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.2.3
Understanding Java Architecture for XML Binding
2.3
Understanding the Element
2.3.1
Obtaining the API Names and Attribute IDs
2.3.2
Special Handling of Elements
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
Product Collaboration
5.2.2
Product Quality Management
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
Checking Out the Attachments
6.5.3.1
Checking Out All the Attachments
6.5.3.2
Checking Out Multiple Attachments from a Folder
6.5.4
Checking In the Attachments
6.5.4.1
Checking In an Attachment with FileId Identification
6.5.5
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 on 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 for a Query
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.2.4
Loading a Project
11.2.5
Updating a Project
11.2.6
loadDeliverablesStatus
11.2.7
Validating a Project
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
11.6
Working with Timesheets
11.6.1
Updating a Timesheet
11.6.2
Retrieving a Timesheet
11.6.3
Exporting a Searched Timesheet
11.6.4
Exporting to aXML
11.7
Working with Calendars
11.7.1
Creating a Calendar
11.7.2
Getting a Calendar
11.7.3
Removing a Calendar
11.7.4
Updating a Calendar
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
A
Core Operations - Agile PLM Web Services
A.1
Admin and Metadata Web Services
A.1.1
getAllClasses
A.1.2
getSubClasses
A.1.3
getNode
A.1.4
getLists
A.1.5
getAttributes
A.1.6
getTableMetadata
A.1.7
getAutoNumbers
A.1.8
getUsers
A.1.9
getUserGroups
A.1.10
convertCurrency
A.1.11
changeLoginPassword
A.1.12
changeApprovalPassword
A.1.13
createTransferAuthority
A.1.14
getTransferAuthority
A.1.15
modifyTransferAuthority
A.1.16
removeTransferAuthority
A.1.17
getAgileClass
A.2
Attachment Web Services
A.2.1
getFileAttachment
A.2.2
addFileAttachment
A.2.3
checkOutAttachment
A.2.4
checkInAttachment
A.2.5
getFileFF
A.2.6
addFileFF
A.2.7
checkOutFF
A.2.8
checkInFF
A.2.9
cancelCheckOutFF
A.2.10
checkInAF
A.2.11
checkOutAF
A.2.12
cancelCheckOutAF
A.2.13
setIncorporate AF
A.2.14
addMarkupRow
A.2.15
removeMarkupRow
A.2.16
updateMarkupRow
A.2.17
loadMarkupTable
A.3
Core Web Services Operations
A.3.1
createObject
A.3.2
getObject
A.3.3
updateObject
A.3.4
deleteObject
A.3.5
undeleteObject
A.3.6
isDeletedObject
A.3.7
sendObject
A.3.8
saveAsObject
A.3.9
checkPrivilege
A.3.10
getSubscriptions
A.3.11
modifySubscriptions
A.3.12
createReferenceObject
A.3.13
getReferenceObject
A.3.14
deleteReferenceObject
A.3.15
updateReferenceObject
A.4
Collaboration Web Services
A.4.1
getWorkflows
A.4.2
getStatus
A.4.3
auditRObject
A.4.4
getApprovers
A.4.5
changeStatus
A.4.6
approveRObject
A.4.7
rejectRObject
A.4.8
setWorkFlow
A.4.9
addApprovers
A.4.10
removeApprovers
A.4.11
commentRObject
A.4.12
getReviewers
A.4.13
acknowledgeRObject
A.4.14
getAllReviewers
A.4.15
addReviewers
A.4.16
removeReviewers
A.5
Doc Publishing Web Services
A.5.1
loadXMLSchema
A.5.2
loadXMLData
A.6
Folder Web Services
A.6.1
getFolder
A.6.2
createFolder
A.6.3
renameFolder
A.6.4
deleteFolder
A.6.5
addChildNode
A.6.6
getChildNode
A.6.7
removeChildNode
A.7
PC Web Services
A.7.1
setIncorporate
A.7.2
getRevisions
A.7.3
undoRedline
A.7.4
isRedlineModified
A.7.5
isIncorporated
A.8
PG&C Web Services
A.8.1
getRollupData
A.8.2
triggerExtractRollupDataforObject
A.8.3
triggerExternalRollup
A.8.4
getObjectComposition
A.8.5
appendUpdateRow
A.8.6
getObjectCompositionSubstance
A.8.7
appendUpdateSubstanceRow
A.8.8
activateComposition
A.8.9
deleteExtractedData
A.8.10
updateObjectRollupResult
A.8.11
setCalculatedComplianceForObjectSpec
A.8.12
setCalculatedComplianceForDeclarationObjectSpec
A.8.13
setNeedRollupForDeclaration
A.8.14
setCalculateOverallCompliance
A.8.15
setCalculatedComplianceForDeclarationPartSpecSubstance
A.9
Project Web Services
A.9.1
createBaseline
A.9.2
removeBaseline
A.9.3
getBaselines
A.9.4
delegateOwnership
A.9.5
substituteResource
A.9.6
isLocked
A.9.7
setLock
A.9.8
reschedule
A.9.9
assignUsersFromPool
A.9.10
loadProject
A.9.11
updateProject
A.9.12
loadDeliverablesStatus
A.9.13
validateProject
A.9.14
Retrieving Project Summary
A.9.15
createCalendar
A.9.16
getCalendar
A.9.17
updateCalendar
A.9.18
removeCalendar
A.9.19
logorChangeTimesheeet
A.9.20
retrieveTimesheet
A.9.21
exportSearchedTimesheet
A.9.22
exporttoAXML
A.9.23
getResourcePoolConsumption
A.9.24
getParentObjsForRefObj
A.10
Reports Web Services
A.10.1
loadReportSchema
A.10.2
loadReportData
A.11
Search Web Services
A.11.1
quickSearch
A.11.2
advancedSearch
A.11.3
advancedSearchReferenceObject
A.11.4
getSearchableAttributes
A.11.5
getSearchableClasses
A.12
Query Web Services
A.12.1
createQuery
A.12.2
loadQuery
A.12.3
executeSavedQuery
A.12.4
saveAsQuery
A.12.5
updateQuery
A.12.6
deleteQuery
A.13
Tables Web Services
A.13.1
isReadOnlyTable
A.13.2
clearTable
A.13.3
copyTable
A.13.4
addRows
A.13.5
updateRows
A.13.6
removeRows
A.13.7
loadTable
A.13.8
isFlagSet
A.13.9
addrowstoReferenceObject
A.13.10
getNotifications
A.13.11
deleteNotifications
A.13.12
getMyWorkFlowRoutings
B
Operations - EC Web Services
B.1
addBookmark
B.2
createUpdateObjects
B.3
generateThumbnails
B.4
getFilteredObject
B.5
getListValues
B.6
getSubclasses
B.7
getUserPreferredLanguage
B.8
removeBookmark
B.9
removesPartAssignment
B.10
retrieveDesignStructure
C
Operations - RMW Web Services
C.1
CFMBOWWebServices
C.1.1
processBO
C.2
CFMCampaignService
C.2.1
changeLifeCyclePhase
C.2.2
getReservedInventory
C.2.3
getReservedEquipment
C.3
CFMEditWebService
C.3.1
edit
C.4
CFMExternalAttachmentWebService
C.4.1
addAttachment
C.4.2
editAttachment
C.4.3
removeAttachment
C.5
CFMInventoryService
C.5.1
changestatus
C.6
CFMSampleService
C.6.1
addResults
C.6.2
getSamples
C.7
CFMSearchWebService
C.7.1
search
C.8
CFMWorkflowService
C.8.1
takeActionOnState
C.9
CFMWorkrequestService
C.9.1
create
C.9.2
closeOut
C.9.3
updateEquipmentActivity
C.9.4
updateInventoryConsumption
C.9.5
updateResourceInformation
C.9.6
getWorkRequestRecipe
C.9.7
updateWorkRequestRecipe
C.9.8
recordParameterResults
D
Working with Java Sample Code
D.1
Building Stubs and Compiling the Samples
D.2
Executing the Samples using ant Task
D.3
Executing the Samples using a Java IDE
D.4
Understanding the Code
D.5
Helper Methods
D.5.1
getRowOrFileId Method
D.6
Troubleshooting
