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.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
CreateDocument (string contentType, CreateDocumentParameterBody body) |
Create document |
UpdateDocument (string id, string contentType, UpdateDocumentParameterBody body) |
Update document |
UpdateDocumentProperties (string id, string contentType, DocumentMetadata body) |
Update document properties |
Update document content |
|
Get document |
|
Get document properties |
|
Get document content |
|
Delete document |
|
CreateFolder (string contentType, CreateFolderParameterBody body) |
Create folder |
UpdateFolder (string id, string contentType, UpdateFolderParameterBody body) |
Update folder |
Get folder |
|
Delete folder |
|
Get folder children |
|
Add reference to folder |
|
Remove reference from folder |
|
Search |
|
Advanced search |
|
Get all content types |
|
Get content type fields |
|
Get content type schema |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Create document
Description: Create the document in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.CreateDocument (string contentType, CreateDocumentParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
contentType |
string (Content Type) |
Select the content type of the document |
True |
|
body |
|
|
True |
Returns:
Type:string
Summary: Document ID
Description: The ID of the document.
Summary: Update document
Description: Update the document in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.UpdateDocument (string id, string contentType, UpdateDocumentParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
|
contentType |
string (Content Type) |
Select the content type of the document |
True |
|
body |
|
|
True |
Returns:
Summary: Update document properties
Description: Update the document properties in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.UpdateDocumentProperties (string id, string contentType, DocumentMetadata body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
|
contentType |
string (Content Type) |
Select the content type of the document |
True |
|
body |
|
|
True |
Returns:
Summary: Update document content
Description: Update the content of the document in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.UpdateDocumentContent (string id, File body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
|
body |
|
|
True |
Returns:
Summary: Get document
Description: Get the document from eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetDocument (string id, string contentType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
|
contentType |
string (Content Type) |
Select the content type of the document |
True |
Returns:
Type:GetDocumentResponse
Summary: Get document properties
Description: Get the properties of the document from eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetDocumentProperties (string id, string contentType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
|
contentType |
string (Content Type) |
Select the content type of the document |
True |
Returns:
Type:GetDocumentPropertiesResponse
Summary: Get document content
Description: Get the content of the document from eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetDocumentContent (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
Returns:
Type:GetDocumentContentResponse
Summary: Delete document
Description: Delete the document in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.DeleteDocument (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the document |
True |
Returns:
Summary: Create folder
Description: Create the folder in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.CreateFolder (string contentType, CreateFolderParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
contentType |
string (Content Type) |
Select the content type of the folder |
True |
|
body |
|
|
True |
Returns:
Type:string
Summary: Folder ID
Description: The ID of the folder.
Summary: Update folder
Description: Update the folder in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.UpdateFolder (string id, string contentType, UpdateFolderParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the folder |
True |
|
contentType |
string (Content Type) |
Select the content type of the folder |
True |
|
body |
|
|
True |
Returns:
Summary: Get folder
Description: Get the folder from eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetFolder (string id, string contentType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the folder |
True |
|
contentType |
string (Content Type) |
Select the content type of the folder |
True |
Returns:
Type:GetFolderResponse
Summary: Delete folder
Description: Delete the folder in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.DeleteFolder (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the folder |
True |
Returns:
Summary: Get folder children
Description: Get the children of the folder from eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetFolderChildren (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (ID) |
Specify the ID of the folder |
True |
Returns:
Type:array of (ResultItem)
Summary: Children
Description: The children of the folder.
Summary: Add reference to folder
Description: Add a reference to a folder in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.AddReferenceToFolder (string sourceId, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
sourceId |
string (Source ID) |
Specify the ID of the document or folder |
True |
|
id |
string (Parent ID) |
Specify the ID of the folder to add the reference to |
True |
Returns:
Summary: Remove reference from folder
Description: Remove a reference from a folder in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.RemoveReferenceFromFolder (string sourceId, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
sourceId |
string (Source ID) |
Specify the ID of the document or folder |
True |
|
id |
string (Parent ID) |
Specify the ID of the folder to remove the reference from |
True |
Returns:
Summary: Search
Description: Search on profile metadata in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.SimpleSearch (SimpleSearchParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:array of (ResultItem)
Summary: Results
Description: The results of the search.
Summary: Advanced search
Description: Search on specified profile metadata in eDOCS
Syntax:
OpenTexteDOCSbyOneFox.AdvancedSearch (AdvancedSearchParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:array of (ResultItem)
Summary: Results
Description: The results of the search.
Summary: Get all content types
Description: Get the content types configured for eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetContentTypes (string type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
string (Content Type) |
Specify the type of the content type |
True |
Returns:
Type:array of (DynamicField)
Summary: Content Types
Description: The configured content types for eDOCS.
Summary: Get content type fields
Description: Get the content type fields configured for eDOCS
Syntax:
OpenTexteDOCSbyOneFox.GetContentTypeFields (string name)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
name |
string (Content Type) |
Specify the content type of the item |
True |
Returns:
Type:array of (DynamicField)
Summary: Fields
Description: The fields of the content type.
Summary: Get content type schema
Description: Get the schema of the configured content type
Syntax:
OpenTexteDOCSbyOneFox.GetContentTypeSchema (string name)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
name |
string (Content Type) |
Specify the name of the content type |
True |
Returns:
Type:GetContentTypeSchemaResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
query |
string Query |
Specify the query for the search |
start |
string Start |
Specify the start (first item to retrieve) for the search |
limit |
string Limit |
Specify the item limit to retrieve for the search |
Summary:
Description:
Properties:
Name |
Type |
Summary |
parentId |
string Parent ID |
Specify the parent folder ID of the document |
metadata |
|
|
file |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Specify the name of the folder |
description |
string Description |
Specify the description of the folder |
parentId |
string Parent ID |
Specify the parent folder ID of the folder |
fieldValues |
array of (FieldValuesItem) Fields |
Specify the fields of the folder |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Select the name of the field |
value |
string Value |
Specify the value of the field |
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Specify the display name of the document |
description |
string Description |
Specify the description of the document |
fieldValues |
array of (FieldValuesItem) Fields |
Specify the fields of the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Select the name of the field |
value |
string Value |
Specify the value of the field |
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
The display name of the item. |
value |
string Value |
The value of the item. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string File Name |
Specify the file name (with extension) of the document |
content |
string(byte) File Content |
Specify the file content of the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
schema |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string File Name |
The file name (with extension) of the document. |
content |
string(byte) File Content |
The file content of the document. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
The display name of the document. |
description |
string Description |
The description of the document. |
createdDate |
string(date-time) Created Date |
The created date of the document. |
modifiedDate |
string(date-time) Modified Date |
The modified date of the document. |
fields |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string ID |
The ID of the document. |
parentId |
string Parent ID |
The ID of the parent folder of the document. |
metadata |
|
|
file |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
The display name of the document. |
description |
string Description |
The description of the document. |
createdDate |
string(date-time) Created Date |
The created date of the document. |
modifiedDate |
string(date-time) Modified Date |
The modified date of the document. |
fields |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string File Name |
The file name (with extension) of the document. |
content |
string(byte) File Content |
The file content of the document. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string ID |
The ID of the folder. |
parentId |
string Parent ID |
The ID of the parent folder of the folder. |
name |
string Name |
The name of the folder. |
description |
string Description |
The description of the folder. |
createdDate |
string(date-time) Created Date |
The created date of the folder. |
modifiedDate |
string(date-time) Modified Date |
The modified date of the folder. |
fields |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string ID |
The ID of the item. |
name |
string Name |
The name of the item. |
type |
string Type |
The type of the item. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Search Value |
Specify the profile value to search for |
Summary:
Description:
Properties:
Name |
Type |
Summary |
metadata |
|
|
file |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Specify the name of the folder |
description |
string Description |
Specify the description of the folder |
fieldValues |
array of (FieldValuesItem) Fields |
Specify the fields of the folder |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Select the name of the field |
value |
string Value |
Specify the value of the field |