Compartilhar via


OpenText eDOCS

OpenText eDOCS is a flexible, collaborative enterprise content management (ECM) system designed to support legal and other professional services organizations. Now you can bring content and processes more together by combining it in your low code solutions to ensure that critical business content is managed and secure throughout the content lifecycle, while remaining easily accessible for day-to-day operations.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Contact
Name One Fox Support
URL https://www.onefox.com/service-desk/
Email servicedesk@onefox.nl
Connector Metadata
Publisher One Fox
Website https://www.opentext.com/products/connectors-for-microsoft-power-automate
Privacy policy https://www.onefox.com/privacy-policy/
Categories Content and Files;Productivity

OpenText eDOCS by One Fox

Empower OpenText eDOCS as the primary repository for all things content related. Together with the OpenText eDOCS Power Automate Connector by One Fox you can streamline content processes across a widespread application landscape and limit information silos.

Pre-requisites

You will need the following to proceed:

  • A license to use this connector purchasable in Azure Marketplace or AppSource.
  • OpenText eDOCS with the REST service online reachable.
  • OpenText eDOCS login credentials.

How to get credentials

Once a license has been purchased an email will be sent with a link to the settings portal and login credentials to this portal. In this portal the connector can be configured and the API key needed to use the connector can be copied.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API key for your company True
Settings name string The configured settings name to use True
eDOCS Username string The username for eDOCS True
eDOCS Password securestring The password for eDOCS True
Override host URL string Override the PPC SAAS host URL

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add reference to folder

Add a reference to a folder in eDOCS

Add trustee(s) to an item

Add one or multiple trustees with corresponding access rights to the item in eDOCS

Advanced search

Search on specified profile metadata in eDOCS

Check in document

Check in the document in eDOCS

Check out document

Check out the document in eDOCS

Create document

Create the document in eDOCS

Create document (V2)

Create the document in eDOCS

Create folder

Create the folder in eDOCS

Create folder (V2)

Create the folder in eDOCS

Create lookup entry

Create the lookup entry in eDOCS

Create lookup entry (V2)

Create the lookup entry in eDOCS

Delete document

Delete the document in eDOCS

Delete document version

Delete the document version in eDOCS

Delete folder

Delete the folder in eDOCS

Get document

Get the document from eDOCS

Get document content

Get the content of the document from eDOCS

Get document properties

Get the properties of the document from eDOCS

Get document version content

Get the content of the document version from eDOCS

Get document versions

Get the versions of the document from eDOCS

Get folder

Get the folder from eDOCS

Get folder children

Get the children of the folder from eDOCS

Get lookup entries

Get all lookup entries for the specified content type from eDOCS

Get trustees of an item

Get the trustees of the item from eDOCS

Override trustee(s) on an item

Override all trustees with corresponding access rights on the item in eDOCS

Remove reference from folder

Remove a reference from a folder in eDOCS

Remove trustee(s) from an item

Remove one or multiple trustees with corresponding existing access rights from the item in eDOCS

Search

Search on profile metadata in eDOCS

Update document

Update the document in eDOCS

Update document (V2)

Update the document in eDOCS

Update document content

Update the content of the document in eDOCS

Update document properties

Update the document properties in eDOCS

Update document properties (V2)

Update the document properties in eDOCS

Update folder

Update the folder in eDOCS

Update folder (V2)

Update the folder in eDOCS

Update lookup entry

Update the lookup entry in eDOCS

Update lookup entry (V2)

Update the lookup entry in eDOCS

Update trustee(s) of an item

Update one or multiple trustees with corresponding existing access rights of the item in eDOCS

Add reference to folder

Add a reference to a folder in eDOCS

Parameters

Name Key Required Type Description
Source ID
sourceId True string

Specify the ID of the document or folder

Parent ID
id True string

Specify the ID of the folder to add the reference to

Add trustee(s) to an item

Add one or multiple trustees with corresponding access rights to the item in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the item

ID
trusteeId True string

Specify the ID of the trustee

Type
trusteeType True string

Specify the type of the trustee

Access Rights
accessRights True array of string

Specify the access rights of the trustee

Search on specified profile metadata in eDOCS

Parameters

Name Key Required Type Description
Query
query True string

Specify the query for the search

Start
start string

Specify the start (first item to retrieve) for the search

Limit
limit string

Specify the item limit to retrieve for the search

Returns

The results of the search.

Check in document

Check in the document in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Check out document

Check out the document in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Create document

Create the document in eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the document

Parent ID
parentId string

Specify the parent folder ID of the document

Display Name
displayName True string

Specify the display name of the document

Description
description string

Specify the description of the document

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

File Name
name True string

Specify the file name (with extension) of the document

File Content
content True byte

Specify the file content of the document

Returns

The ID of the document.

Document ID
string

Create document (V2)

Create the document in eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the document

body
body True dynamic

Returns

The ID of the document.

Document ID
string

Create folder

Create the folder in eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the folder

Name
name True string

Specify the name of the folder

Description
description string

Specify the description of the folder

Parent ID
parentId string

Specify the parent folder ID of the folder

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

Returns

The ID of the folder.

Folder ID
string

Create folder (V2)

Create the folder in eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the folder

body
body True dynamic

Returns

The ID of the folder.

Folder ID
string

Create lookup entry

Create the lookup entry in eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the lookup

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

Returns

The ID of the lookup entry.

Lookup Entry ID
string

Create lookup entry (V2)

Create the lookup entry in eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the lookup

body
body True dynamic

Returns

The ID of the lookup entry.

Lookup Entry ID
string

Delete document

Delete the document in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Delete document version

Delete the document version in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Version ID
versionId True string

Specify the version ID

Delete folder

Delete the folder in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the folder

Get document

Get the document from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Content Type
configurationKey True string

Select the content type of the document

Returns

The outputs of this operation are dynamic.

Get document content

Get the content of the document from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Returns

Name Path Type Description
File Name
name string

The file name (with extension) of the document.

File Content
content byte

The file content of the document.

Get document properties

Get the properties of the document from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Content Type
configurationKey True string

Select the content type of the document

Returns

The outputs of this operation are dynamic.

Get document version content

Get the content of the document version from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Version ID
versionId True string

Specify the version ID

Returns

Name Path Type Description
File Name
name string

The file name (with extension) of the document.

File Content
content byte

The file content of the document.

Get document versions

Get the versions of the document from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Returns

The versions of the document.

Versions
array of Version

Get folder

Get the folder from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the folder

Content Type
configurationKey True string

Select the content type of the folder

Returns

The outputs of this operation are dynamic.

Get folder children

Get the children of the folder from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the folder

Returns

The children of the folder.

Get lookup entries

Get all lookup entries for the specified content type from eDOCS

Parameters

Name Key Required Type Description
Content Type
configurationKey True string

Select the content type of the lookup

Filter
filter string

Specify a filter to filter the lookup entries by the specified field

Returns

The outputs of this operation are dynamic.

Get trustees of an item

Get the trustees of the item from eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the item

Returns

The trustees with corresponding access rights of the item.

Override trustee(s) on an item

Override all trustees with corresponding access rights on the item in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the item

ID
trusteeId True string

Specify the ID of the trustee

Type
trusteeType True string

Specify the type of the trustee

Access Rights
accessRights True array of string

Specify the access rights of the trustee

Remove reference from folder

Remove a reference from a folder in eDOCS

Parameters

Name Key Required Type Description
Source ID
sourceId True string

Specify the ID of the document or folder

Parent ID
id True string

Specify the ID of the folder to remove the reference from

Remove trustee(s) from an item

Remove one or multiple trustees with corresponding existing access rights from the item in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the item

Trustee ID's
body True array of string

Specify the ID's of the trustees

Search on profile metadata in eDOCS

Parameters

Name Key Required Type Description
Search Value
name True string

Specify the profile value to search for

Returns

The results of the search.

Update document

Update the document in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Content Type
configurationKey True string

Select the content type of the document

Display Name
displayName True string

Specify the display name of the document

Description
description string

Specify the description of the document

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

File Name
name True string

Specify the file name (with extension) of the document

File Content
content True byte

Specify the file content of the document

Update document (V2)

Update the document in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Content Type
configurationKey True string

Select the content type of the document

body
body True dynamic

Update document content

Update the content of the document in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

File Name
name True string

Specify the file name (with extension) of the document

File Content
content True byte

Specify the file content of the document

Update document properties

Update the document properties in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Content Type
configurationKey True string

Select the content type of the document

Display Name
displayName True string

Specify the display name of the document

Description
description string

Specify the description of the document

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

Update document properties (V2)

Update the document properties in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the document

Content Type
configurationKey True string

Select the content type of the document

body
body True dynamic

Update folder

Update the folder in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the folder

Content Type
configurationKey True string

Select the content type of the folder

Name
name True string

Specify the name of the folder

Description
description string

Specify the description of the folder

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

Update folder (V2)

Update the folder in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the folder

Content Type
configurationKey True string

Select the content type of the folder

body
body True dynamic

Update lookup entry

Update the lookup entry in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the lookup entry

Content Type
configurationKey True string

Select the content type of the lookup

Name
name string

Select the name of the field

Value
value string

Specify the value of the field

Update lookup entry (V2)

Update the lookup entry in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the lookup entry

Content Type
configurationKey True string

Select the content type of the lookup

body
body True dynamic

Update trustee(s) of an item

Update one or multiple trustees with corresponding existing access rights of the item in eDOCS

Parameters

Name Key Required Type Description
ID
id True string

Specify the ID of the item

ID
trusteeId True string

Specify the ID of the trustee

Type
trusteeType True string

Specify the type of the trustee

Access Rights
accessRights True array of string

Specify the access rights of the trustee

Triggers

When a document is created

When a document has been created in eDOCS

When a document is deleted

When a document has been deleted in eDOCS (in case of queue for deletion)

When a folder is created

When a folder has been created in eDOCS

When a folder is deleted

When a folder has been deleted in eDOCS (in case of queue for deletion)

When a folder is updated

When a folder has been updated in eDOCS

When an item is deleted

When a folder or document has been deleted in eDOCS (in case of hard delete)

When document content is updated

When a document file content has been updated in eDOCS

When document properties are updated

When document properties have been updated in eDOCS

When a document is created

When a document has been created in eDOCS

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the document that has been created in eDOCS.

Document ID
integer

When a document is deleted

When a document has been deleted in eDOCS (in case of queue for deletion)

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the document that has been deleted in eDOCS.

Document ID
integer

When a folder is created

When a folder has been created in eDOCS

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the folder that has been created in eDOCS.

Folder ID
integer

When a folder is deleted

When a folder has been deleted in eDOCS (in case of queue for deletion)

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the folder that has been deleted in eDOCS.

Folder ID
integer

When a folder is updated

When a folder has been updated in eDOCS

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the folder that has been updated in eDOCS.

Folder ID
integer

When an item is deleted

When a folder or document has been deleted in eDOCS (in case of hard delete)

Returns

The ID of the folder or document that has been deleted in eDOCS.

Item ID
integer

When document content is updated

When a document file content has been updated in eDOCS

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the document that had a file content update in eDOCS.

Document ID
integer

When document properties are updated

When document properties have been updated in eDOCS

Parameters

Name Key Required Type Description
Parent ID
id integer

Specify the parent folder ID for which to trigger

Parent Depth
depth integer

Specify the max depth the parent should be searched for (where 1 is direct parent, when not provided the default will be used)

Column
column string

Specify the column in the PROFILE table

Value
value string

Specify the value that should be in this column

Returns

The ID of the document of which the properties have been updated in eDOCS.

Document ID
integer

Definitions

ResultItem

Name Path Type Description
ID
id string

The ID of the item.

Name
name string

The name of the item.

Type
type string

The type of the item.

Version

Name Path Type Description
Version ID
versionId string

The ID of the version.

Version Label
versionLabel string

The label of the version.

Modified Date
modifiedDate date-time

The modification date of the version.

Created By
createdBy string

The typist of the version.

Modified By
modifiedBy string

The author of the version.

File Name
fileName string

The file name of the version.

TrusteeRead

Name Path Type Description
ID
trusteeId string

The ID of the trustee.

Type
trusteeType string

The type of the trustee.

Access Rights
accessRights array of string

The access rights of the trustee.

string

This is the basic data type 'string'.

integer

This is the basic data type 'integer'.