Table of Contents

Connections

Commands

Connections

Oracle DRM

Connection for Oracle Data Relationship Management via basic authentication.

Inputs

Input

Type

Detail

Notes

Web Services URL

TextField

The full URL for your Oracle DRM Web Services (i.e. http://drmobe:28080/oracle-epm-drm-webservices/DrmService)

Service URL

TextField

URL for the API Adapter configured for a Data Relationship Management application. For example: http://localhost:5240/Oracle/Drm/APIAdapter

Product Version

TextField

Version number for the Data Relationship Management application

Username

TextField

The username of the user that commands will be run under

Password

TextField

The password for the user

UICultureName

DropdownField

Identifies the language used for localized labels and messages returned by the Data Relationship Management application

CultureName

DropdownField

Identifier for formatting date, time, and decimal values which are sent to or retrieved from a Data Relationship Management application. Any standard specific culture can be specified.

Time Zone ID

DropdownField

Identifier for formatting date, time, and decimal values which are sent to or retrieved from a Data Relationship Management application. Any standard specific culture can be specified.

Commands

Get Export Definition

Returns an export definition.

Inputs

Input

Type

Detail

Notes

Export Name

TextField

The export name to run.

Access Level

DropdownField

Access level of the export to run.

Outputs

Output

Output Type

Notes

Export Definition

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Get Export Names

Gets a list of all of the export names available

Inputs

None

Outputs

Output

Output Type

Notes

Export Names

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Get Import Names

Gets a list of all of the import names available

Inputs

None

Outputs

Output

Output Type

Notes

Import Names

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Run Compare Export

Starts a compare export job and returns the results.

Inputs

Input

Type

Detail

Notes

Export Name

TextField

The export name to run.

From Version

TextField

The from version name field.

To Version

TextField

The to version name field.

Access Level

DropdownField

Access level of the export to run.

Runtime Parameters

GroupField

Parameter values used by the export.

Outputs

Output

Output Type

Notes

Export Content

File

Job Info

Json

Job Status

String

Content Size

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Run Export

Starts an export job by export name and returns the results.

Inputs

Input

Type

Detail

Notes

Export Name

TextField

The export name to run.

From Version

TextField

The from version name field.

To Version

TextField

The to version name field.

Access Level

DropdownField

Access level of the export to run.

Runtime Parameters

GroupField

Parameter values used by the export.

Outputs

Output

Output Type

Notes

Export Content

File

Job Info

Json

Job Status

String

Content Size

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Run Hierarchy Export

Starts a hierarchy export job by export name and returns the results.

Inputs

Input

Type

Detail

Notes

Export Name

TextField

The export name to run.

Version

TextField

Version name field.

Access Level

DropdownField

Access level of the export to run.

Include All Hierarchies

BooleanField

Flag indicating that the export should include all hierarchies.

Runtime Parameters

GroupField

Parameter values used by the export.

Outputs

Output

Output Type

Notes

Export Content

File

Job Info

Json

Job Status

String

Content Size

Integer

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Run Import

Starts a job to import given an import definition and returns the results when complete.

Inputs

Input

Type

Detail

Notes

Import Data

FileField

The data to pass to the import job.

Import Name

TextField

The import name to run.

Version

TextField

Version name field. This field value will be used as the name of the version.

Version Description

TextField

Version description field. This field value will be used as the description of the version.

Access Level

DropdownField

Access level of the export to run.

Runtime Parameters

GroupField

Parameter values used by the export.

Outputs

Output

Output Type

Notes

Job Info

Json

Job Status

String

Content Size

Integer

Import Results

Json

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Error running command

2

Error

Failed to authenticate with Oracle DRM Web Services

Did this answer your question?