Module edocs
ballerinax/edocs Ballerina library
1.5.2
Overview
The eDocs API v1.0.0 connector(https://www.opentext.com/products-and-solutions/industries/legal/legal-content-management-edocs) OpenAPI Specification.
The eDocs API allows interaction with the resources stored on an eDOCS DM Server. Refer to API documentation
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an OpenText account
- Obtain an API key by following this guide
Clients
edocs: Client
Isolated
This is a generated connector from eDocs OpenAPI Specification. An API that allows interaction with the resources stored on an eDOCS DM Server.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an OpenText account and obtain an API key.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
getLibraries
Isolated FunctionRemote Function
Get a collection of available libraries
Parameters
- configuration string? (default ()) - Retrieve DM Server configuration information (if available)
Return Type
- json|error - Expected response to a valid request
connect
Isolated FunctionRemote Function
function connect(ConnectBody payload) returns json|errorConnect to the DM Server and get key information in the response
Parameters
- payload ConnectBody - Credentials to connect to library
Return Type
- json|error - Expected response to a valid request
getFolders
Isolated FunctionRemote Function
function getFolders(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of available folders
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of available folders
addNewFolder
Isolated FunctionRemote Function
function addNewFolder(string library, ProfileData payload) returns json|errorAdd a new folder
Parameters
- library string - Name of library (lib)
- payload ProfileData - Profile data needed to create a folder
Return Type
- json|error - Expected response to a valid request
getPublicFolders
Isolated FunctionRemote Function
function getPublicFolders(string library, string? libs, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of public folders
Parameters
- library string - Name of library (lib)
- libs string? (default ()) - Comma delimited list of multiple libraries
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of public folders
getRecentEdits
Isolated FunctionRemote Function
function getRecentEdits(string library, string? libs, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of recently edited items
Parameters
- library string - Name of library (lib)
- libs string? (default ()) - Comma delimited list of multiple libraries
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of recently edited items
getCheckedOutItems
Isolated FunctionRemote Function
function getCheckedOutItems(string library, string? libs, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of checked out items
Parameters
- library string - Name of library (lib)
- libs string? (default ()) - Comma delimited list of multiple libraries
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of checked out items
getDeletedItems
Isolated FunctionRemote Function
function getDeletedItems(string library, string? libs, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of deleted items
Parameters
- library string - Name of library (lib)
- libs string? (default ()) - Comma delimited list of multiple libraries
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of deleted items
getTemplates
Isolated FunctionRemote Function
function getTemplates(string library, string? libs, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of system defined templates
Parameters
- library string - Name of library (lib)
- libs string? (default ()) - Comma delimited list of multiple libraries
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of system defined templates
getFolder
Isolated FunctionRemote Function
function getFolder(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of content from this folder
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of folder content
deleteFolder
Isolated FunctionRemote Function
Request this folder be deleted
getProfileForTheFolder
Isolated FunctionRemote Function
Retrieve the profile data for this folder
updateProfileData
Isolated FunctionRemote Function
function updateProfileData(string id, string library, ProfileData payload) returns Response|errorReplace the profile data for this folder
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload ProfileData - Profile data that needs to be replaced.
getSecurityInfo
Isolated FunctionRemote Function
Retrieve the security data for this folder
updateSecurityInfo
Isolated FunctionRemote Function
function updateSecurityInfo(string id, string library, SecurityData payload) returns Response|errorReplace the security data for this folder
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload SecurityData - Security data that needs to replaced for this folder
getSecurityRights
Isolated FunctionRemote Function
Retrieve the user's security rights for this folder
getFolderReferences
Isolated FunctionRemote Function
function getFolderReferences(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of references to this folder
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of references
addReferenceToFolder
Isolated FunctionRemote Function
function addReferenceToFolder(string id, string library, IdReferencesBody payload) returns json|errorAdd a reference to this folder into folders and workspaces
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload IdReferencesBody - Reference information
Return Type
- json|error - Expected response to a valid request
deleteReferenceFromFolder
Isolated FunctionRemote Function
Request the reference to this folder be deleted from a folder or workspace
getFacetData
Isolated FunctionRemote Function
Retrieve the facet data for this folder
getHistoryData
Isolated FunctionRemote Function
Retrieve the history data for this folder
getAvailableDocuments
Isolated FunctionRemote Function
function getAvailableDocuments(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of available documents
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of documents
deleteDocumentById
Isolated FunctionRemote Function
Request this document be deleted
getProfileDataOfDocument
Isolated FunctionRemote Function
Retrieve the profile data for this document
updateProfileDataOfDocument
Isolated FunctionRemote Function
function updateProfileDataOfDocument(string id, string library, ProfileData payload) returns Response|errorReplace the profile data for this document
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload ProfileData -
getSecurityDataOfDocument
Isolated FunctionRemote Function
Retrieve the security data for this document
updateSecurityData
Isolated FunctionRemote Function
function updateSecurityData(string id, string library, SecurityData payload) returns json|errorReplace the security data for this document
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload SecurityData - Security data that needs to be replaced for this document.
Return Type
- json|error - Expected response to a valid request
getVersionsOfDocument
Isolated FunctionRemote Function
function getVersionsOfDocument(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of versions for this document
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of versions for this document
deleteSpecificVersionofSpecificDocument
Isolated FunctionRemote Function
function deleteSpecificVersionofSpecificDocument(string id, string 'version, string library) returns Response|errorRequest this version of the document be deleted
Parameters
- id string - Resource identification
- 'version string - Version identification
- library string - Name of library (lib)
getCollectionOfReferences
Isolated FunctionRemote Function
function getCollectionOfReferences(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of references to this document
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of references to this document
addReferencesToFoldersAndWorkspaces
Isolated FunctionRemote Function
function addReferencesToFoldersAndWorkspaces(string id, string library, IdReferencesBody1 payload) returns json|errorAdd a reference to this document into folders and workspaces
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload IdReferencesBody1 - Reference information
Return Type
- json|error - Expected response to a valid request
deleteReference
Isolated FunctionRemote Function
Request the reference to this document be deleted from a folder or workspace
getAttachments
Isolated FunctionRemote Function
function getAttachments(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of attachments for this document
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of attachments for this document
getContentOfAttachment
Isolated FunctionRemote Function
function getContentOfAttachment(string id, string attachment, string library) returns Response|errorRetrieve the contents of this attachment
Parameters
- id string - Resource identification
- attachment string - Attachment identification
- library string - Name of library (lib)
deleteAttachment
Isolated FunctionRemote Function
Request this attachment be deleted
Parameters
- id string - Resource identification
- attachment string - Attachment identification
- library string - Name of library (lib)
getHistoryDataForDocument
Isolated FunctionRemote Function
Retrieve the history data for this document
getSavedSearches
Isolated FunctionRemote Function
function getSavedSearches(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Get a collection of available saved searches
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of saved searches
getSearches
Isolated FunctionRemote Function
function getSearches(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of results that satisfy the saved search criteria
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of search results
deleteSearch
Isolated FunctionRemote Function
Request this saved search be deleted
getProfileForSavedSearch
Isolated FunctionRemote Function
Retrieve the profile data for this saved search
getReferencesForSavedSearch
Isolated FunctionRemote Function
function getReferencesForSavedSearch(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of references to this saved search
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of references to this saved search
addReferenceToSavedSearch
Isolated FunctionRemote Function
function addReferenceToSavedSearch(string id, string library, IdReferencesBody2 payload) returns json|errorAdd a reference to this saved search into workspaces
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload IdReferencesBody2 - Reference information
Return Type
- json|error - Expected response to a valid request
deleteReferenceFromSavedSearch
Isolated FunctionRemote Function
Request the reference to this saved search be deleted from a workspace
getWorkspaces
Isolated FunctionRemote Function
function getWorkspaces(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Get a collection of available workspaces
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of workspaces
addNewWorkspace
Isolated FunctionRemote Function
function addNewWorkspace(string library, ProfileData payload) returns json|errorAdd a new workspace
Parameters
- library string - Name of library (lib)
- payload ProfileData - Profile data for new workspace.
Return Type
- json|error - Expected response to a valid request
getWorkspaceById
Isolated FunctionRemote Function
function getWorkspaceById(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of content from this workspace
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of content from this workspace
deleteWorkspaces
Isolated FunctionRemote Function
Request this workspace be deleted
getProfileDataForWorkspace
Isolated FunctionRemote Function
Retrieve the profile data for this workspace
repalceProfileDataForWorkspace
Isolated FunctionRemote Function
function repalceProfileDataForWorkspace(string id, string library, ProfileData payload) returns Response|errorReplace the profile data for this workspace
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload ProfileData - Profile data that needs to be replaced in workspace
getSecurityDataForWorkspace
Isolated FunctionRemote Function
Retrieve the security data for this workspace
updateSecurityDataForWorkspace
Isolated FunctionRemote Function
function updateSecurityDataForWorkspace(string id, string library, SecurityData payload) returns Response|errorReplace the security data for this workspace
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload SecurityData - Security data that needs to replaced in workspace.
getUserSecurityRightsForWorkspace
Isolated FunctionRemote Function
Retrieve the user's security rights for this workspace
getCollectionOfFlexFolders
Isolated FunctionRemote Function
function getCollectionOfFlexFolders(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Get a collection of available FlexFolders
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of FlexFolders
getFlexFolder
Isolated FunctionRemote Function
function getFlexFolder(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of content from this FlexFolder
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of content from this FlexFolder
deleteFlexFolder
Isolated FunctionRemote Function
Request this FlexFolder (subscription) be deleted
getFilePlans
Isolated FunctionRemote Function
function getFilePlans(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of available first level terms
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of fileplans
getCollectionOfFilePlans
Isolated FunctionRemote Function
function getCollectionOfFilePlans(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of recently used fileplans
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of recently used fileplans
getFavoriteGroupFilePlans
Isolated FunctionRemote Function
function getFavoriteGroupFilePlans(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of group favourite fileplans
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of group favourite fileplans
getFilePlansById
Isolated FunctionRemote Function
function getFilePlansById(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of available items of this fileplan level
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of fileplan items
getHistoryDataForFilePlan
Isolated FunctionRemote Function
function getHistoryDataForFilePlan(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns Response|errorRetrieve the history data for this fileplan level
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
getFilePlansData
Isolated FunctionRemote Function
Retrieve the profile data for this fileplan level
getCollectionOfReferecenForFilePlan
Isolated FunctionRemote Function
function getCollectionOfReferecenForFilePlan(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of reference for this fileplan
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of references to this fileplan
addReferenceToFilePlan
Isolated FunctionRemote Function
function addReferenceToFilePlan(string id, string library, IdReferencesBody3 payload) returns json|errorAdd a reference to this fileplan into folders and workspaces
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload IdReferencesBody3 - Reference information for fileplan
Return Type
- json|error - Expected response to a valid request
deleteReferencesToFilePlan
Isolated FunctionRemote Function
Request the reference to this fileplan be deleted from a folder or workspace
addRequestToFilePlan
Isolated FunctionRemote Function
function addRequestToFilePlan(string id, string library, IdRequestsBody payload) returns json|errorAdd a request to this fileplan item
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload IdRequestsBody - Request information
Return Type
- json|error - Expected response to a valid request
getBoxes
Isolated FunctionRemote Function
function getBoxes(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of content from this box
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of boxes
getHistoryDataForBox
Isolated FunctionRemote Function
function getHistoryDataForBox(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns Response|errorRetrieve the history data for this box
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
getProfileDataForBox
Isolated FunctionRemote Function
Retrieve the profile data for this box
getRequests
Isolated FunctionRemote Function
function getRequests(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of requests
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of requests
addRequestToFilePlanItem
Isolated FunctionRemote Function
Add a request to this fileplan item
Return Type
- json|error - Expected response to a valid request
deleteRequestToFilePlanItem
Isolated FunctionRemote Function
Request the request to this fileplan item be deleted
getUserSettings
Isolated FunctionRemote Function
function getUserSettings(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Access to user settings
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of user settings
getSettingsById
Isolated FunctionRemote Function
function getSettingsById(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of this setting
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of this setting
getConfigurableAttributes
Isolated FunctionRemote Function
function getConfigurableAttributes(string id, string setting, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve the configurable attributes of this setting
Parameters
- id string - Resource identification
- setting string - Setting identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of attributes of this setting
replaceConfigurables
Isolated FunctionRemote Function
function replaceConfigurables(string id, string setting, string library, IdSettingBody payload) returns json|errorReplace the configurable attributes of this setting
Parameters
- id string - Resource identification
- setting string - Setting identification
- library string - Name of library (lib)
- payload IdSettingBody -
Return Type
- json|error - Expected response to a valid request
deleteSettting
Isolated FunctionRemote Function
Request this setting be deleted
Parameters
- id string - Resource identification
- setting string - Setting identification
- library string - Name of library (lib)
getForms
Isolated FunctionRemote Function
function getForms(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Access to form defenitions
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of forms
getApplications
Isolated FunctionRemote Function
Retrieve a collection of applications and their associated form data
Parameters
- library string - Name of library (lib)
getDefinitionDataForForm
Isolated FunctionRemote Function
Retrieve the definition data for this form
getColumnDefinitionDataForForm
Isolated FunctionRemote Function
Retrieve the column definition data for this form
getLookups
Isolated FunctionRemote Function
function getLookups(string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Get a collection of available tables
Parameters
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of tables
getEntriesFromTable
Isolated FunctionRemote Function
function getEntriesFromTable(string 'table, string 'key, string profile, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve a collection of entries from this table
Parameters
- 'table string - Table identification
- 'key string - Key identification
- profile string - Profile identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of entries from this table
getDefenitionForThisTable
Isolated FunctionRemote Function
function getDefenitionForThisTable(string 'table, string 'key, string profile, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns CollectionResponse|error?Retrieve the definition for this table
Parameters
- 'table string - Table identification
- 'key string - Key identification
- profile string - Profile identification
- library string - Name of library (lib)
- 'start int (default 0) - (zero-based) Index of first item to retrieve
- max int (default 10) - Maximum number of items to retrieve
- 'ascending string? (default ()) - Retrieve items in ascending order by this field
- 'descending string? (default ()) - Retrieve items in descending order by this field
- filter string? (default ()) - Restrict items to retrieve based on this criteria
Return Type
- CollectionResponse|error? - Collection of definition for this table
createURL
Isolated FunctionRemote Function
Create a URL
deleteURL
Isolated FunctionRemote Function
Request this url be deleted
getProfileDataForURL
Isolated FunctionRemote Function
Retrieve the column definition data for this form
Records
edocs: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xDmDst string - You can obtain a X-DM-DST by connecting to a DM Server. It can be found under "HEADERS" in the response body.
edocs: AttachmentData
Fields
- file? string -
- data? record {} -
edocs: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
edocs: CollectionResponse
Collection of items based on the provided criteria
Fields
- data? CollectionresponseData -
edocs: CollectionresponseData
Fields
- set? CollectionresponseDataSet - Information defining the items in the collection
- list? anydata[] - Individual items items in the collection
edocs: CollectionresponseDataSet
Information defining the items in the collection
Fields
- 'start? int -
- max? int -
- 'ascending? string -
- 'descending? string -
- filter? string -
- total? int -
edocs: ConnectBody
Fields
- data? ConnectData -
edocs: ConnectData
Fields
- userid? string -
- password? string -
- library? string -
edocs: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
edocs: DownloadResponse
Fields
- file? string -
edocs: Error
Fields
- code int -
- message string -
edocs: IdReferencesBody
Fields
- data? record {} -
edocs: IdReferencesBody1
Fields
- data? record {} -
edocs: IdReferencesBody2
Fields
- data? record {} -
edocs: IdReferencesBody3
Fields
- data? record {} -
edocs: IdRequestsBody
Fields
- data? record {} -
edocs: IdSettingBody
Fields
- data? record {} -
edocs: ProfileData
Fields
- data? record {} -
edocs: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
edocs: SearchData
Fields
- data? record {} -
edocs: SecurityData
Fields
- data? record {} -
edocs: UploadData
Fields
- file? string -
- data? record {} -
edocs: UrlsBody
Fields
- data? UrlsData -
edocs: UrlsData
Fields
- DISPLAYNAME? string -
- URL_ADDRESS? string -
- _restapi? UrlsDataRestapi -
edocs: UrlsDataRestapi
Fields
- ref? UrlsDataRestapiRef -
edocs: UrlsDataRestapiRef
Fields
- 'type? string -
- id? string -
- lib? string -