Skip Headers
Oracle® Life Sciences Data Hub Application Programming Interface Guide
Release 2.2
Part Number E18794-01
Home
Book List
Contact Us
Next
View PDF
Contents
List of Examples
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Finding Information and Patches on My Oracle Support
Finding Oracle Documentation
Related Documents
Conventions
Part I Essential Information
1
Using Application Programming Interfaces
1.1
About APIs
1.2
Calling APIs from Outside the Oracle Life Sciences Data Hub
1.2.1
Security Setup Required
1.2.2
Calling the Security API Package
1.2.3
Calling APIs from SAS
1.2.4
Using a Permanent Schema for Deploying Programs that Call APIs
1.3
Calling APIs from Defined Programs
1.4
Code Example Using Security and Error Message APIs
2
Reference Information
2.1
CDR Naming Version Object Type
2.2
CDR Base Object Type
2.3
CDR Object-Specific Database Object Types
2.4
Retrieving Reference Codelist Names and Values
2.5
Retrieving the Instance Domain ID
2.6
Standard Parameters
Part II Object APIs
3
Application Areas
3.1
Define and Modify Application Areas
3.1.1
Create an Application Area
3.1.2
Modify an Application Area
3.1.3
Remove an Application Area
3.1.4
Copy Objects into an Application Area
3.1.5
Move Objects into an Application Area
4
Business Areas
4.1
Define and Modify Business Areas
4.1.1
Create a Business Area
4.1.2
Modify a Business Area
4.1.3
Check out a Business Area
4.1.4
Undo a Business Area Checkout
4.1.5
Check in a Business Area
4.1.6
Remove a Business Area
4.2
Create and Modify Business Area Hierarchies
4.2.1
Create a Business Area Hierarchy
4.2.2
Modify a Hierarchy and a Hierarchy Column
4.2.3
Reorder a Hierarchy Column
4.2.4
Remove a Hierarchy Column
4.2.5
Remove a Business Area Hierarchy
4.3
Create and Modify Business Area Joins
4.3.1
Create a Join
4.3.2
Modify a Join and a Join Column
4.3.3
Remove a Join Column
4.3.4
Remove a Join
4.4
Public APIs and Naming Views for Generic Visualization Adapter (GVA)
4.4.1
Initialize a Generic Visualization Business Area Instance
4.4.2
Reset a Generic Visualization Business Area
4.4.3
Get Possible Blinding Types of a Business Area Instance
4.4.4
Get Snapshot Labels Common to all Tables in a BA Instance for a Given Blinding AccessType
4.4.5
Naming Views
5
Data Marts
5.1
Define and Modify Work Areas
5.1.1
Create a Data Mart
5.1.2
Check In a DataMart Definition
5.1.3
Modify a Data Mart
5.1.4
Check Out a Data Mart
5.1.5
Remove a Data Mart
6
Domains
6.1
Define and Modify Domains
6.1.1
Create a Domain
6.1.2
Modify a Domain
6.1.3
Copy a Domain
6.1.4
Move Objects into a Domain
6.1.5
Copy Objects into a Domain
6.1.6
Copy Objects into a Domain and Check in
6.1.7
Remove a Domain
7
Setup Utilities
7.1
Initialize APIs
7.1.1
Initialize a Package
7.1.2
Verify Whether an API is Enabled
7.1.3
Enable an API
7.1.4
Disable an API
7.2
Define and Modify Adapters
7.2.1
Create an Adapter Domain
7.2.2
Create an Adapter Area
7.2.3
Populate a Tech Type Table
7.3
Host Definition Constants
7.4
Get Factory Support
7.4.1
Get a Naming Version Object
7.4.2
Get a User ID
7.4.3
Get a User Name
7.5
Get Factory Utilities
7.5.1
Get a Base Object Type
7.5.2
Get a Company ID
7.6
Get Factory Validations
7.6.1
Validate a Namespace
7.6.2
Validate a Reference
7.7
Get Data from Naming Tables
7.7.1
Get the Latest Version
7.7.2
Get a Maximum Version
7.7.3
Get the Type of a Naming Object
7.7.4
Get an Object's Naming Version
7.7.5
Get an Object's Subtype ID
7.7.6
Get an Object's Checkout Status
7.7.7
Get Checkout Properties
7.7.8
Get a Naming Object's Parent
7.7.9
Get a Parent Naming Object
7.7.10
Get the Latest Version of the Parent Object
7.7.11
Get the Naming Status of a Parent Object
7.7.12
Get the Validation Status of a Parent Object
7.7.13
Get a Definition Object
7.7.14
Get a Lookup Meaning
7.7.15
Find Whether an Object is an Instance
7.7.16
Find Whether Checked Out By Current User
7.7.17
Find Whether a Checkout is User-Specific
7.7.18
Find Whether Checkout is Implicit
7.8
Read Messages
7.8.1
Get a Message
7.8.2
Get a Message Count
7.8.3
Initialize a Message Stack
8
Load Sets
8.1
Define and Modify Load Sets
8.1.1
Create a Load Set
8.1.2
Check Out a Load Set Definition
8.1.3
Modify a Load Set
8.1.4
Check in a Load Set Definition
8.1.5
Remove a Load Set
9
Parameter Sets
9.1
Create and Modify Parameter Sets
9.1.1
Create a Parameter Set Definition
9.1.2
Check out a Parameter Set Definition
9.1.3
Modify a Parameter Set Definition
9.1.4
Modify a Parameter Set Detail
9.1.5
Check in a Parameter Set Definition
9.1.6
Remove a Parameter Set Definition
10
Planned Outputs
10.1
Create and Modify Planned Outputs
10.1.1
Create a Planned Output
10.1.2
Get a New Position Number
10.1.3
Get a Planned Output Object
10.1.4
Modify a Planned Output
10.1.5
Identify whether a SAS Object
10.1.6
Remove a Planned Output Object
11
Programs
11.1
Create and Modify Programs
11.1.1
Create a Program
11.1.2
Copy Objects Into a Program
11.1.3
Modify a Program
11.1.4
Check In a Program Definition
11.1.5
Check Out a Program Definition
11.1.6
Remove a Program
11.1.7
Create a Planned Output for a Log File
11.1.8
Assign a Planned Output
11.1.9
Modify a Manual Validation Flag Value
12
Report Sets
12.1
Create and Modify Report Set Entries
12.1.1
Create a Report Set Entry
12.1.2
Add and Modify an Entry
12.1.3
Copy a Report Set Entry into Another
12.1.4
Modify a Report Set Entry
12.1.5
Move a Report Set Entry into Another
12.1.6
Reorder Report Set Entries in a Parent Report Set
12.1.7
Find if a Report Set is Checked Out
12.1.8
Check Unique and Strict Numbering in a Report Set
12.1.9
Identify if a Report Set Contains Child Entries
12.1.10
Find if a User has Modify Permission
12.1.11
Remove an Object from a Report Set Entry
12.1.12
Remove a Report Set Entry
12.1.13
Get a Report Set Name
12.1.14
Get a Title
12.1.15
Get a Chapter Number
12.1.16
Get a Parent Number
12.1.17
Get a List of Report Set Entry Titles
12.1.18
Get All RSE Titles in a Report Set
12.1.19
Get Attribute Values Derived from a Parent
12.1.20
Get the Lowest Entry Number
12.1.21
Get the Total Number of Report Set Entries
12.1.22
Create a Narrative
12.1.23
Update a Narrative
12.1.24
Delete a Narrative
12.1.25
Check if Copying Retains Valid Numbering in a Target Report Set
12.1.26
Check if a Move Retains Valid Numbering in a Target Report Set
12.1.27
Check if a Move Retains Valid Numbering in the Parent Report Set
12.1.28
Check if Removal Retains Valid Numbering in a Parent Report Set
12.1.29
Check if Reordering Retains Valid Numbering in a Parent Report Set
12.1.30
Unassign a Planned Output
12.2
Create and Modify Report Sets
12.2.1
Create a Report Set
12.2.2
Check Out a Report Set
12.2.3
Undo a Report Set Checkout
12.2.4
Copy Objects Into a Report Set
12.2.5
Get a Summary Output Validation Status
12.2.6
Modify a Report Set
12.2.7
Move Objects into a Report Set
12.2.8
Remove Objects from a Report Set
12.2.9
Check In a Report Set
12.2.10
Remove a Report Set Definition
12.2.11
Remove a Report Set
12.3
Create and Modify Overlay Template Definitions
12.3.1
Create an Overlay Template Definition
12.3.2
Modify an Overlay Template Definition File Definition
12.3.3
Get an Overlay Template Definition File as a BLOB
12.3.4
Remove an Overlay Template Definition File Definition
12.4
Report Set Overlay Template
12.4.1
Create an Overlay Template
12.4.2
Check Out an Overlay Template
12.4.3
Undo an Overlay Template Checkout
12.4.4
Copy Objects Into an Overlay Template
12.4.5
Modify an Overlay Template
12.4.6
Check In an Overlay Template
12.4.7
Remove an Overlay Template
13
Software Source Codes
13.1
Create and Modify Source Code
13.1.1
Create a Source Code Object
13.1.2
Get a Source Code CLOB
13.1.3
Modify Source Code
13.1.4
Set the Primary Flag to Yes
13.1.5
Update a Shareable Flag
13.1.6
Remove a Source Code Object
14
Tables
14.1
Create and Modify Tables
14.1.1
Create a Table Definition
14.1.2
Create a Table Instance
14.1.3
Create a Temporary Blob
14.1.4
Create a Table Column
14.1.5
Create a Table Constraint
14.1.6
Modify a Table Definition
14.1.7
Modify a Table Descriptor
14.1.8
Modify a Table Instance
14.1.9
Reorder a Column
14.1.10
Upload a Table Descriptor or Column
14.1.11
Check in a Table Object
14.1.12
Remove a Single Object
15
Parameters
15.1
Define and Modify Parameters
15.1.1
Create a Parameter
15.1.2
Check Out a Parameter
15.1.3
Check In a Parameter
15.1.4
Get Displayed Parameter Values
15.2
Define Parameter Relations
15.2.1
Create a Parameter Relation Collection
15.2.2
Get Parameter Instances for Value Passing
15.2.3
Remove Parameter Relations
16
Variables
16.1
Create and Modify Variables
16.1.1
Create a Variable
16.1.2
Check Out a Variable
16.1.3
Modify a Variable
16.1.4
Check In a Variable
16.1.5
Remove a Variable
17
Work Areas
17.1
Define and Modify Work Areas
17.1.1
Create a Work Area
17.1.2
Install a Work Area
17.1.3
Check in a Work Area
17.1.4
Modify a Work Area
17.1.5
Clone a Work Area
17.1.6
Copy Objects into a Work Area
17.1.7
Clone an Object
17.1.8
Remove a Work Area
17.1.9
Get the Usage Intent RC of a Work Area
17.1.10
Update a Work Area's Usage Intent
17.1.11
Install a Program
18
Workflows
18.1
Create and Modify Workflows
18.1.1
Create a Workflow
18.1.2
Check Out a Workflow Definition
18.1.3
Create a Workflow Transition
18.1.4
Create a Workflow Structure Instance
18.1.5
Modify a Workflow
18.1.6
Modify a Workflow
18.1.7
Check in a Workflow Definition
18.1.8
Remove a Transition
18.1.9
Remove a Workflow Activity
18.1.10
Remove a Workflow Instance
18.1.11
Remove a Workflow Definition
19
Workflow Notifications
19.1
Create and Modify Notifications
19.1.1
Create a Notification
19.1.2
Create a Notification Recipient
19.1.3
Create a Notification Link
19.1.4
Check Out a Notification Definition
19.1.5
Modify a Notification Definition
19.1.6
Modify a Notification Instance
19.1.7
Send a Notification
19.1.8
Check in a Notification Definition
19.1.9
Remove a Notification Link
19.1.10
Remove a Notification Recipient
19.1.11
Remove a Notification
Part III Common APIs
20
Execution Setups
20.1
Create and Modify Execution Setups
20.1.1
Create an Execution Setup
20.1.2
Check Out an Execution Setup
20.1.3
Modify an Execution Setup
20.1.4
Modify a Parameter
20.1.5
Modify an Execution Setup Parameter
20.1.6
Load Parameter Details
20.1.7
Copy an Execution Setup
20.1.8
Check In an Execution Setup
20.1.9
Submit an Execution Setup
20.1.10
Submit an Execution Setup for Instances
20.1.11
Upgrade an Execution Setup
20.1.12
Upgrade All Execution Setups
20.1.13
Make an Execution Setup Active
20.1.14
Remove an Execution Setup
21
Mappings
21.1
Create and Modify Mappings
21.1.1
Map a Column
21.1.2
Map a Table Descriptor to a Table Instance
21.1.3
Create a Table Descriptor from a Table Instance
21.1.4
Create a Table Instance from a Table Descriptor
21.1.5
Modify a Mapping Column
21.1.6
Modify a Mapping at the Table Descriptor Level
21.1.7
Get a PRREF_ID for an Executable in a Workflow
21.1.8
Get a PRREF_ID for an Object in a Work Area
21.1.9
Get a PRREF_ID for a Program in a Report Set
22
Outputs
22.1
Generate Outputs
22.1.1
Submit a Print Request
22.1.2
Get an Output's BLOB
22.1.3
Get an Output's CLOB
23
Version Labels
23.1
Modify Version Labels
23.1.1
Update a Version Label
24
Classification
24.1
Classify Objects
24.1.1
Classify an Object
24.1.2
Declassify an Object
24.2
Classify Subtypes
24.2.1
Get a Subtype Classification Level
24.2.2
Get an Object Classification Value
24.2.3
Get a Parent Term
24.3
Create and Modify Classification Hierarchy Values
24.3.1
Insert a Classification Value
24.3.2
Update a Classification Value
24.3.3
Delete a Classification Value
25
Job Execution
25.1
Create and Execute Output Jobs
25.1.1
Create a Binary Output
25.1.2
Upload an Output BLOB
25.1.3
Upload an Output Clob
25.1.4
Upload a LOB to a Temporary Table
25.1.5
Download a Job Output BLOB
25.1.6
Queue a Job
25.1.7
Wait for a Job to Complete
25.1.8
Generate an XML Payload
25.2
Retrieve Information about Ongoing Jobs
25.2.1
Get an Ongoing Job ID
25.2.2
Get Currently Executing Parameters
25.2.3
Get Information About a Job
25.2.4
Get Job Information (Overloaded)
25.3
Set Execution Statuses
25.3.1
Set a User-specific Completion Status
25.3.2
Set a Customized Output Title
25.3.3
Set a Customized Output Subtitle
25.3.4
Set an Output Parameter
25.3.5
Get a Completion Status
25.4
Submit Messages
25.4.1
Submit a Message
25.5
Create Submission Records
25.5.1
Start a Job
25.5.2
Create a Submission
25.5.3
Create a Submission from a Job
25.5.4
Add a Job Log
26
Security Policy
26.1
Create and Modify Security Policies
26.1.1
Create a Subtype
26.1.2
Copy a Subtype
26.1.3
Modify a Subtype
26.1.4
Assign Roles to a Subtype Operation
26.1.5
Assign Operations to a Subtype Role
26.1.6
Remove a Subtype
26.1.7
Create a Role
26.1.8
Modify a Role
26.1.9
Add a Group Role
26.1.10
Get Roles for a User
26.1.11
Remove a Role
26.1.12
Remove a Group Role
26.1.13
Create a User Group
26.1.14
Add Users to a Group
26.1.15
Remove Users from a Role in a User Group
26.1.16
Assign a User Group to an Object
26.1.17
Copy a User Group
26.1.18
Copy a User Group with its Users
26.1.19
Modify a User Group
26.1.20
Remove All Group Roles from a User Group
26.1.21
Remove All Users in a Group
26.1.22
Revoke a User Group From an Object
26.1.23
Undo a Revoke a User Group Action
26.1.24
Remove a User Group
26.1.25
Unassign a User Group From an Object
26.1.26
Unassign Roles from an Operation on an Object's Subtype
26.1.27
Unassign Operations on an Object Subtype's Role
27
Validation
27.1
Validate Objects
27.1.1
Update an Object's Validation Status
27.2
Create and Modify Validation Supporting Documents
27.2.1
Create a Validation Supporting Document
27.2.2
Update a Validation Supporting Document
27.2.3
Obsolete a Validation Supporting Document