Table of Contents

Connections

Commands

Connections

Oracle Content and Experience

Oracle Content and Experience Cloud connection

Inputs

Input

Type

Detail

Notes

Instance Domain

TextField

The domain of your instance when opened in the browser, for example dev-example.cec.ocp.oraclecloud.com

IDCS Domain

TextField

The domain of your IDCS Console, for example idcs-abcdefg01234567890.identity.oraclecloud.com

Primary Audience Domain

TextField

The primary audience domain of your Oracle Content and Experience Cloud resource, for example 1230ABCDEF012345.cec.ocp.oraclecloud.com

OAuth Client ID

TextField

The client id of the OAuth token used to query the Oracle Content and Experience Cloud REST API

OAuth Client Secret

TextField

The client secret of the OAuth token used to query the Oracle Content and Experience Cloud REST API

Commands

Copy File

Copy a specified file to a specified destination folder.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Destination ID

TextField

The globally unique identifier (GUID) of the destination folder.

Version

TextField

The version number of the file to copy. If the version is not specified, the latest version is used.

Duplicate Resolution

DropdownField

Specify the TimeStampSuffix option. The name of the copied file is given a 6-digit suffix from the system timestamp if selected.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Copy Folder

Copy a specified file to a specified destination folder.

Inputs

Input

Type

Detail

Notes

Folder ID

TextField

Globally unique identifier (GUID) for the folder.

Destination ID

TextField

The globally unique identifier (GUID) of the destination folder.

Duplicate Resolution

DropdownField

Specify the TimeStampSuffix option. The name of the copied file is given a 6-digit suffix from the system timestamp if selected.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this folder.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Create Folder

Create a new subfolder in the specified destination folder.

Inputs

Input

Type

Detail

Notes

Folder ID

TextField

Globally unique identifier (GUID) for the parent folder.

Folder Name

TextField

The name of the newly created folder.

Description

TextField

The description for the newly created folder

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this folder.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Delete File

Delete the specified file.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Version

TextField

The version number of the file to delete. If the version is not specified, the latest version is used.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Delete Folder

Delete the specified folder.

Inputs

Input

Type

Detail

Notes

Folder ID

TextField

Globally unique identifier (GUID) for the parent folder.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this folder.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Download File

Download the specified file.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Version

TextField

The version number of the file to download. If the version is not specified, the latest version is used.

Range

TextField

The standard HTTP Range header allows clients to stream parts of the file rather than the entire file.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Downloaded File

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Get File Information

Get file information for the specified file.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Version

TextField

The version number of the file to query. If the version is not specified, the latest version is used.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Include Renditions

BooleanField

When true, detailed information about existing renditions associated with the file is returned

Include Only Existing Renditions

BooleanField

This parameter is ignored unless includeRenditions is true. By default, only information about existing renditions is returned. When false, detailed information about all supported renditions with the file is returned. The exists field will indicate if a rendition has been created.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Get Folder

Get folder information for the specified folder.

Inputs

Input

Type

Detail

Notes

Folder ID

TextField

Globally unique identifier (GUID) for the folder.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this folder.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Move File

Move a specified file and its versions to a specified destination folder. The moved file retains its globally unique identifier and all date and ownership information.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Destination ID

TextField

The globally unique identifier (GUID) of the destination folder.

Duplicate Resolution

DropdownField

Specify the TimeStampSuffix option. The name of the copied file is given a 6-digit suffix from the system timestamp if selected.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Move Folder

Move a specified folder and its contents to a specified destination folder. The moved folder retains its globally unique identifier and all date and ownership information.

Inputs

Input

Type

Detail

Notes

Folder ID

TextField

Globally unique identifier (GUID) for the folder.

Destination ID

TextField

The globally unique identifier (GUID) of the destination folder.

DuplicateResolution

DropdownField

Specify the TimeStampSuffix option. The name of the copied file is given a 6-digit suffix from the system timestamp if selected.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this folder.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Reserve File

Reserve the specified file. A file reservation lets other users (or processes) know that the file is in use.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Search Folders or Files

Search for a folder or file by fulltext or querytext.

Inputs

Input

Type

Detail

Notes

Folder ID

TextField

Globally unique identifier (GUID) for the folder. If excluded, will search the home directory

Fulltext Search

TextField

Search string used to match folders or files. It will search these locations: itemName, contents, extension, ownerName, lastModifiedName, and folderDescription. Takes precedence over querytext

Querytext Search

TextField

Search string used to search for folders or files using the targets listed below. It can replace fulltext, taking advantage of multiple targets at the same time. The format is searchField<operation>searchValue.

Limit

TextField

Specify the maximum number of items to return. If set, we will not paginate to the end of the results.

Offset

TextField

Specify the point at which to begin the list of items from the complete set of items returned for the action. If you do not specify an offset, the returned items begin with the first item in the item list.

Order By

TextField

Order the resulting items using the specified field and sort order. You can use the name, size, lastModifiedName, and lastModifiedDate fields, and a sort order of ascending (asc) or descending (desc). For example, name:asc

Include Metadata

BooleanField

If true, results in metadata associated with items returned by the search results being added to the response

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this folder.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Unreserve File

Remove the reservation from the specified file. A file reservation lets other users (or processes) know that the file is in use.

Inputs

Input

Type

Detail

Notes

File ID

TextField

Globally unique identifier (GUID) for the file.

Reserved By User ID

TextField

Globally unique identifier (GUID) of the user who reserved the file.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Upload File

Upload a new file using a multipart request to specify destination and file information.

Inputs

Input

Type

Detail

Notes

File

FileField

The file to upload.

File Name

TextField

Optionally specify the name that the file will have on the server. By default the current name of the file will be used.

Parent ID

TextField

The globally unique identifier (GUID) of the folder to upload the file to.

Duplicate Resolution

DropdownField

Specify the TimeStampSuffix option. The name of the copied file is given a 6-digit suffix from the system timestamp if selected.

Metadata Values

MapField

You can use this parameter to set metadata values to a collection already assigned to any parent folder.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Upload File Version

Upload a new revision to a file using a multipart request to specify information for the target file and input file.

Inputs

Input

Type

Detail

Notes

File

FileField

The file to upload.

File ID

TextField

Globally unique identifier (GUID) for the file.

Metadata Values

MapField

You can use this parameter to set metadata values to a collection already assigned to any parent folder.

Applink ID

TextField

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted.

Access Token

TextField

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if Applink ID is used.

Access Code

TextField

Access code needed to use protected public links.

Link ID

TextField

Public link ID of a public link authorizing the current user to access this file.

Outputs

Output

Output Type

Notes

Oracle Response

File

Exit Codes

Code

Type

Detail

0

Success

Success

1

Error

Failed to run the command

Did this answer your question?