Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction to Web Services

• 1.1 About Web Services
  • 1.1.1 Core Technologies
    • 1.1.1.1 Web Service Description Language (WSDL)
    • 1.1.1.2 XML and XML Schema
    • 1.1.1.3 Simple Object Access Protocol (SOAP)
  • 1.1.2 Web Services Architecture
• 1.2 About Agile e6 Web Services
  • 1.2.1 The Core Web Services
• 1.3 About Agile e6 Web Services Framework
  • 1.3.1 Components of Agile e6 Web Services Framework

2 Getting Started with Web Services

• 2.1 Prerequisites
  • 2.1.1 Operating Environment
  • 2.1.2 Web Services Engines
  • 2.1.3 Standards Compliance
• 2.2 Understanding Web Services Authentication and Performance
  • 2.2.1 The Agile e6 Session Handling
    • 2.2.1.1 The Agile e6 PLM Session Manager
    • 2.2.1.2 The PLM Ticket
• 2.3 Understanding the Agile e6 Web Services Requests
  • 2.3.1 Obtaining the Agile e6 Metadata
• 2.4 Understanding the Agile e6 Web Services Responses
  • 2.4.1 Response Status Code
  • 2.4.2 Whitelist Mechanism for Masks
    • 2.4.2.1 List of Mask Names
    • 2.4.2.2 Configuration Parameters
  • 2.4.3 Exceptions and Warnings
• 2.5 countOnly Query Support

3 Setting Up the Web Services Infrastructure

• 3.1 Installing the Agile e6 Web Services Framework
  • 3.1.1 Creating the WebLogic Agile e6 Domain
• 3.2 Testing Inbound Web Services with JDeveloper HTTP Analyzer
• 3.3 Testing Inbound Web Services with SoapUI

4 Configuring Agile e6 Web Services Security

• 4.1 Setting Up the Web Services Security Policies
  • 4.1.1 Setting Up the Web Services Security
  • 4.1.2 Authenticating a Web Service Client
    • 4.1.2.1 A Sample of HTTP/S Authentication

5 Working with Agile e6 Web Services

• 5.1 Developing the Outbound Web Services Wrapper
  • 5.1.1 The Web Services Wrapper Interface
    • 5.1.1.1 The BPEL Facade
    • 5.1.1.2 Endpoint Configurations for the External Wrapper
    • 5.1.1.3 Session Management Integration
  • 5.1.2 Developing a Custom Wrapper
  • 5.1.3 Calling a Custom Wrapper from Agile e6
  • 5.1.4 Deploying a Custom Wrapper
  • 5.1.5 Web Service Wrapper Log Messages

6 Agile e6 Core Web Services Operations

• 6.1 Bulk Operations
• 6.2 Bulk Processing of Requests
  • 6.2.1 Handling Bulk Requests
• 6.3 BusinessObject Web Service
  • 6.3.1 Binary Data Transfer
  • 6.3.2 Single-request Operations
    • 6.3.2.1 createObject
    • 6.3.2.2 getObjects
    • 6.3.2.3 updateObject
    • 6.3.2.4 deleteObject
    • 6.3.2.5 createRelation
    • 6.3.2.6 updateRelation
    • 6.3.2.7 getRelations
    • 6.3.2.8 deleteRelation
    • 6.3.2.9 setReservation
    • 6.3.2.10 getObjectStructure
  • 6.3.3 Bulk Operations
• 6.4 DocumentManagement Web Service
  • 6.4.1 DFM Support
  • 6.4.2 StreamingFileServices
    • 6.4.2.1 downloadFile
    • 6.4.2.2 uploadFile
  • 6.4.3 DocumentManagement CoreService
    • 6.4.3.1 getFiles
    • 6.4.3.2 getCADAssembly
    • 6.4.3.3 getCADAssemblyNextDataBlock
    • 6.4.3.4 getFMSVault
  • 6.4.4 Bulk Operations
    • 6.4.4.1 getFiles
    • 6.4.4.2 getFMSVault
• 6.5 Internal File Object Service
  • 6.5.1 createUpdateFileObject
• 6.6 Metadata Web Service
  • 6.6.1 Single-request Operations
    • 6.6.1.1 getEntity
    • 6.6.1.2 getEntity Type
    • 6.6.1.3 getEntityRelation
    • 6.6.1.4 getNumberCycles
    • 6.6.1.5 getNumbers
  • 6.6.2 Bulk Operations
• 6.7 Configuration Web Service
  • 6.7.1 getUserContext
  • 6.7.2 setUserContext
  • 6.7.3 Bulk Operations
    • 6.7.3.1 getDefault
    • 6.7.3.2 createDefault
• 6.8 EngineeringCollaborationService Web Service
  • 6.8.1 createUpdateStructure

7 Appendix

• 7.1 SAMPLES
  • 7.1.1 EchoServiceWrapper.java
  • 7.1.2 SampleWrapper.java
  • 7.1.3 Web Services Security