Skip Headers
Oracle® Health Sciences Life Sciences Warehouse Application Programming Interface Guide
Release 2.4
E53659-01
Home
Book List
Contact Us
Next
PDF
·
Mobi
·
ePub
1/43
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
Tips
1.2.1
Committing APIs
1.2.2
Get Attribute Values for Namespace Objects
1.3
Calling APIs from Outside the Oracle Life Sciences Data Hub
1.3.1
Security Setup Required
1.3.2
Calling the Security API Package
1.3.3
Calling APIs from SAS
1.3.4
Using a Permanent Schema for Deploying Programs that Call APIs
1.4
Calling APIs from Defined Programs
1.5
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
Load Sets
7.1
Define and Modify Load Sets
7.1.1
Create a Load Set
7.1.2
Check Out a Load Set Definition
7.1.3
Modify a Load Set
7.1.4
Check In a Load Set Definition
7.1.5
Remove a Load Set
7.1.6
Synchronize Table Descriptors in a Load Set
8
Parameter Sets
8.1
Create and Modify Parameter Sets
8.1.1
Create a Parameter Set Definition
8.1.2
Check Out a Parameter Set Definition
8.1.3
Modify a Parameter Set Definition
8.1.4
Modify a Parameter Set Detail
8.1.5
Check In a Parameter Set Definition
8.1.6
Remove a Parameter Set Definition
9
Planned Outputs
9.1
Create and Modify Planned Outputs
9.1.1
Create a Planned Output
9.1.2
Get a New Position Number
9.1.3
Get a Planned Output Object
9.1.4
Modify a Planned Output
9.1.5
Identify whether a SAS Object
9.1.6
Remove a Planned Output Object
10
Programs
10.1
Create and Modify Programs
10.1.1
Create a Program
10.1.2
Copy Objects Into a Program
10.1.3
Modify a Program
10.1.4
Check In a Program Definition
10.1.5
Check Out a Program Definition
10.1.6
Remove a Program
10.1.7
Create a Planned Output for a Log File
10.1.8
Assign a Planned Output
10.1.9
Modify a Manual Validation Flag Value
11
Report Sets
11.1
Create and Modify Report Set Entries
11.1.1
Create a Report Set Entry
11.1.2
Add and Modify an Entry
11.1.3
Copy a Report Set Entry into Another
11.1.4
Modify a Report Set Entry
11.1.5
Move a Report Set Entry into Another
11.1.6
Reorder Report Set Entries in a Parent Report Set
11.1.7
Find if a Report Set is Checked Out
11.1.8
Check Unique and Strict Numbering in a Report Set
11.1.9
Identify if a Report Set Contains Child Entries
11.1.10
Find if a User has Modify Permission
11.1.11
Remove an Object from a Report Set Entry
11.1.12
Remove a Report Set Entry
11.1.13
Get a Report Set Name
11.1.14
Get a Title
11.1.15
Get a Chapter Number
11.1.16
Get a Parent Number
11.1.17
Get a List of Report Set Entry Titles
11.1.18
Get All RSE Titles in a Report Set
11.1.19
Get Attribute Values Derived from a Parent
11.1.20
Get the Lowest Entry Number
11.1.21
Get the Total Number of Report Set Entries
11.1.22
Create a Narrative
11.1.23
Update a Narrative
11.1.24
Delete a Narrative
11.1.25
Check if Copying Retains Valid Numbering in a Target Report Set
11.1.26
Check if a Move Retains Valid Numbering in a Target Report Set
11.1.27
Check if a Move Retains Valid Numbering in the Parent Report Set
11.1.28
Check if Removal Retains Valid Numbering in a Parent Report Set
11.1.29
Check if Reordering Retains Valid Numbering in a Parent Report Set
11.1.30
Unassign a Planned Output
11.2
Create and Modify Report Sets
11.2.1
Create a Report Set
11.2.2
Check Out a Report Set
11.2.3
Undo a Report Set Checkout
11.2.4
Copy Objects Into a Report Set
11.2.5
Get a Summary Output Validation Status
11.2.6
Modify a Report Set
11.2.7
Move Objects into a Report Set
11.2.8
Remove Objects from a Report Set
11.2.9
Check In a Report Set
11.2.10
Remove a Report Set Definition
11.2.11
Remove a Report Set
11.3
Create and Modify Overlay Template Definitions
11.3.1
Create an Overlay Template Definition
11.3.2
Modify an Overlay Template Definition File Definition
11.3.3
Get an Overlay Template Definition File as a BLOB
11.3.4
Remove an Overlay Template Definition File Definition
11.4
Report Set Overlay Template
11.4.1
Create an Overlay Template
11.4.2
Check Out an Overlay Template
11.4.3
Undo an Overlay Template Checkout
11.4.4
Copy Objects Into an Overlay Template
11.4.5
Modify an Overlay Template
11.4.6
Check In an Overlay Template
11.4.7
Remove an Overlay Template
12
Software Source Codes
12.1
Create and Modify Source Code
12.1.1
Create a Source Code Object
12.1.2
Get a Source Code CLOB
12.1.3
Modify Source Code
12.1.4
Set the Primary Flag to Yes
12.1.5
Update a Shareable Flag
12.1.6
Remove a Source Code Object
13
Tables
13.1
Create and Modify Tables
13.1.1
Create a Table Definition
13.1.2
Create a Table Instance
13.1.3
Create a Temporary Blob
13.1.4
Create a Table Column
13.1.5
Create a Table Constraint
13.1.6
Modify a Table Definition
13.1.7
Modify a Table Descriptor
13.1.8
Modify a Table Instance
13.1.9
Reorder a Column
13.1.10
Upload a Table Descriptor or Column
13.1.11
Check In a Table Object
13.1.12
Remove a Single Object
14
Parameters
14.1
Define and Modify Parameters
14.1.1
Create a Parameter
14.1.2
Check Out a Parameter
14.1.3
Check In a Parameter
14.1.4
Get Displayed Parameter Values
14.2
Define Parameter Relations
14.2.1
Create a Parameter Relation Collection
14.2.2
Get Parameter Instances for Value Passing
14.2.3
Remove Parameter Relations
15
Variables
15.1
Create and Modify Variables
15.1.1
Create a Variable
15.1.2
Check Out a Variable
15.1.3
Modify a Variable
15.1.4
Check In a Variable
15.1.5
Remove a Variable
16
Work Areas
16.1
Define and Modify Work Areas
16.1.1
Create a Work Area
16.1.2
Install a Work Area
16.1.3
Check In a Work Area
16.1.4
Modify a Work Area
16.1.5
Clone a Work Area
16.1.6
Copy Objects into a Work Area
16.1.7
Clone an Object
16.1.8
Remove a Work Area
16.1.9
Get the Usage Intent RC of a Work Area
16.1.10
Update a Work Area's Usage Intent
16.1.11
Install a Program
17
Workflows
17.1
Create and Modify Workflows
17.1.1
Create a Workflow
17.1.2
Check Out a Workflow Definition
17.1.3
Create a Workflow Transition
17.1.4
Create a Workflow Structure Instance
17.1.5
Modify a Workflow
17.1.6
Modify a Workflow
17.1.7
Check In a Workflow Definition
17.1.8
Remove a Transition
17.1.9
Remove a Workflow Activity
17.1.10
Remove a Workflow Instance
17.1.11
Remove a Workflow Definition
18
Workflow Notifications
18.1
Create and Modify Notifications
18.1.1
Create a Notification
18.1.2
Create a Notification Recipient
18.1.3
Create a Notification Link
18.1.4
Check Out a Notification Definition
18.1.5
Modify a Notification Definition
18.1.6
Modify a Notification Instance
18.1.7
Send a Notification
18.1.8
Check In a Notification Definition
18.1.9
Remove a Notification Link
18.1.10
Remove a Notification Recipient
18.1.11
Remove a Notification
Part III Common APIs
19
Setup Utilities
19.1
Initialize APIs
19.1.1
Initialize a Package
19.1.2
Verify Whether an API is Enabled
19.1.3
Enable an API
19.1.4
Disable an API
19.2
Define and Modify Adapters
19.2.1
Create an Adapter Domain
19.2.2
Modify an Adapter Domain
19.2.3
Create an Adapter Area
19.2.4
Modify an Adapter Area
19.2.5
Populate a Tech Type Table
19.2.6
Modify a Tech Type Table
19.3
Host Definition Constants
19.4
Get Factory Support
19.4.1
Get a Naming Version Object
19.4.2
Get a User ID
19.4.3
Get a User Name
19.5
Get Factory Utilities
19.5.1
Get a Base Object Type
19.5.2
Get a Company ID
19.6
Get Factory Validations
19.6.1
Validate a Namespace
19.6.2
Validate a Reference
19.7
Get Data from Naming Tables
19.7.1
Get the Latest Version
19.7.2
Get a Maximum Version
19.7.3
Get the Type of a Naming Object
19.7.4
Get an Object's Naming Version
19.7.5
Get an Object's Subtype ID
19.7.6
Get an Object's Checkout Status
19.7.7
Get Checkout Properties
19.7.8
Get a Naming Object's Parent
19.7.9
Get a Parent Naming Object
19.7.10
Get the Latest Version of the Parent Object
19.7.11
Get the Naming Status of a Parent Object
19.7.12
Get the Validation Status of a Parent Object
19.7.13
Get a Definition Object
19.7.14
Get a Lookup Meaning
19.7.15
Find Whether an Object is an Instance
19.7.16
Find Whether Checked Out By Current User
19.7.17
Find Whether a Checkout is User-Specific
19.7.18
Find Whether Checkout is Implicit
19.8
Read Messages
19.8.1
Get a Message
19.8.2
Get a Message Count
19.8.3
Initialize a Message Stack
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
Submit an Execution Setup for Compound Objects
20.1.12
Upgrade an Execution Setup
20.1.13
Upgrade All Execution Setups
20.1.14
Make an Execution Setup Active
20.1.15
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
Get a Table Instance ID
21.1.4
Create a Table Descriptor from a Table Instance
21.1.5
Create a Table Instance from a Table Descriptor
21.1.6
Modify a Mapping Column
21.1.7
Modify a Mapping at the Table Descriptor Level
21.1.8
Get a PRREF_ID for an Executable in a Workflow
21.1.9
Get a PRREF_ID for an Object in a Work Area
21.1.10
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
Part IV Oracle Health Sciences Data Management Workbench APIs
28
Introduction to Oracle DMW APIs
28.1
Set Up Study Environment
28.1.1
Initialize a Study and Lifecycle
28.2
Create or Modify an Expression
28.3
Using APIs to Create Custom Programs
29
Clinical Data Models
29.1
Create and Modify Clinical Data Models
29.1.1
Create a Study Clinical Data Model
29.1.2
Create a Study Clinical Data Model from a Library Model
29.1.3
Modify a Model's Name and Description
29.1.4
Check Out a Clinical Data Model
29.1.5
Check In a Clinical Data Model
29.1.6
Undo a Clinical Data Model Checkout
29.1.7
Install a Study Clinical Data Model
29.1.8
Promote a Clinical Data Model to Quality Control or Production
29.1.9
Remove a Clinical Data Model
29.1.10
Upgrade a Clinical Data Model to the Latest Library Model Version
29.1.11
Copy the Subject and/or Subject/Visit Table
29.1.12
Add a Table to a Clinical Data Model
29.1.13
Modify Table in Clinical Data Model
29.1.14
Remove Table from Clinical Data Model
29.1.15
Add Column to a Table in a Clinical Data Model
29.1.16
Modify a Column in a Clinical Data Model Table
29.1.17
Remove Column from Clinical Data Model Table
29.1.18
Add a Constraint to a Clinical Data Model Table
29.1.19
Modify a Constraint in a Clinical Data Model Table
29.1.20
Remove Constraint from a Clinical Data Model Table
29.1.21
Reorder Columns in a Clinical Data Model Table
30
Codelists
30.1
Create and Modify Codelists
30.1.1
Create a Codelist
30.1.2
Modify a Codelist
30.1.3
Remove a Codelist
30.1.4
Check In a Codelist
30.1.5
Check Out a Codelist
30.1.6
Add Values to a Codelist
30.1.7
Remove Values from a Codelist
30.1.8
Get Codelist Details for a Given Column
31
Flags and Actions
31.1
Flag-Related APIs
31.1.1
Set Flag
31.1.2
Get Flag
31.1.3
Get Flags on Data
31.1.4
Delete Flag
31.2
Flag Name-Related APIs
31.2.1
Get Flag Name Definition, Version 1
31.2.2
Get Flag Name Definition, Version 2
31.2.3
Get Flag Name Definitions
31.3
Get Flag States
31.4
Clinical Data Model Category-Related APIs
31.4.1
Create Model Flag Category Mapping
31.4.2
Get Categories for Model
31.5
Action-Related APIs
31.5.1
Create Discrepancy Action
31.5.2
Get Disc Action, Version 1
31.5.3
Get Disc Action, Version 2
31.5.4
Update Discrepancy Action
31.5.5
Delete Discrepancy Action
32
Transformations
32.1
Create and Modify Transformation Maps
32.1.1
Create Transformation Maps
32.1.2
Modify Transformation Maps
32.1.3
Mark Table Maps Not Used
32.1.4
Mark Column Maps Not Used
32.1.5
Check In Transformation Maps
32.1.6
Check Out Transformation Maps
32.1.7
Undo Checkout Transformation Map
32.1.8
Auto Map Tables
32.1.9
Accept Table Mappings
32.1.10
Auto Map Columns
32.1.11
Accept Column Mappings
32.1.12
Upgrade Transformation Map
32.1.13
Install Transformation Map
32.1.14
Remove Transformation Map
32.1.15
Validate Transformation Maps
32.1.16
Update Validation Status
32.1.17
Execute Transformation Map
32.1.18
Create Staging Table
32.1.19
Validate Expression
33
Validation Checks
33.1
Create and Modify Validation Checks and Batches
33.1.1
Create a Validation Check Batch
33.1.2
Modify a Validation Check Batch
33.1.3
Remove Validation Check Batch
33.1.4
Create a Validation Check
33.1.5
Update a Validation Check
33.1.6
Install a Validation Check Batch
33.1.7
Submit a Validation Check Batch
33.1.8
Check In a Validation Check Batch
33.1.9
Check Out a Validation Check Batch
33.1.10
Undo Checkout For a Validation Check Batch
33.1.11
Update Validation Status of a Validation Check Batch
33.1.12
Upgrade a Validation Check Batch
33.1.13
Remove Validation Check(s)
33.1.14
Enable or Disable Validation Checks
33.1.15
Reorder Validation Checks
Part V Oracle DMW Public Views
34
Public Views
34.1
Clinical Data Model Views
34.1.1
DME_DATAMODEL_V
34.1.2
DME_TABLES_V
34.1.3
DME_COLUMNS_V
34.1.4
DME_CONSTRAINT_V
34.1.5
DME_CONSTRAINT_COLS_V
34.1.6
DME_LOV_VALUES_V
34.1.7
DME_SDTM_COL_IDENTIFIERS_V
34.1.8
DME_SDTM_TAB_IDENTIFIERS_V
34.2
Codelist Views
34.2.1
DME_PUB_CODELIST_V
34.2.2
DME_PUB_CODELIST_VALUES_V
34.3
Discrepancy Views
34.3.1
DME_PUB_DISCREPANCIES_V'
34.4
Validation Checks Views
34.4.1
DME_PUB_VC_BATCHES_V
34.4.2
DME_PUB_VC_DETAILS_V
34.5
Transformation Views
34.5.1
DME_PUB_DF_XFORM_MAP_V
34.5.2
DME_PUB_DF_MAP_ENTITY_V
34.5.3
DME_PUB_XFM_SOURCE_TABLES_V
34.5.4
DME_PUB_XFM_SOURCE_COLUMNS_V
34.5.5
DME_ PUB_XFM_TARGET_TABLES_V
34.5.6
DME_ PUB_XFM_TARGET_COLUMNS_V
34.5.7
DME_ PUB_XFM_AUTOMAPS_V
34.5.8
DME_PUB_XFM_COL_AUTOMAPS_V
34.5.9
DME_PUB_XFM_CUSTOM_PROGRAMS_V
34.5.10
DME_PUB_XFM_EXPR_STDFUNC_V
34.5.11
DME_PUB_XFM_EXPR_STATIC_PKGS_V