edocs
Module edocs
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_edocs_1.1.0.png)
ballerinax/edocs Ballerina library
Overview
This is a generated connector from eDocs API v1.0.0 OpenAPI Specification.
The eDocs API allows interaction with the resources stored on an eDOCS DM Server. Refer to API documentation
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![](/images/permalink.svg)
edocs: Client![](/images/permalink.svg)
This is a generated connector from eDocs OpenAPI Specification. An API that allows interaction with the resources stored on an eDOCS DM Server.
Constructor![](/images/permalink.svg)
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, ClientConfiguration clientConfig)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
getLibraries![](/images/permalink.svg)
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![](/images/permalink.svg)
function connect(ConnectBody payload) returns json|error
Connect 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![](/images/permalink.svg)
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![](/images/permalink.svg)
function addNewFolder(string library, ProfileData payload) returns json|error
Add 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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Request this folder be deleted
getProfileForTheFolder![](/images/permalink.svg)
Retrieve the profile data for this folder
updateProfileData![](/images/permalink.svg)
function updateProfileData(string id, string library, ProfileData payload) returns Response|error
Replace 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![](/images/permalink.svg)
Retrieve the security data for this folder
updateSecurityInfo![](/images/permalink.svg)
function updateSecurityInfo(string id, string library, SecurityData payload) returns Response|error
Replace 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![](/images/permalink.svg)
Retrieve the user's security rights for this folder
getFolderReferences![](/images/permalink.svg)
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![](/images/permalink.svg)
function addReferenceToFolder(string id, string library, IdReferencesBody payload) returns json|error
Add 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![](/images/permalink.svg)
Request the reference to this folder be deleted from a folder or workspace
getFacetData![](/images/permalink.svg)
Retrieve the facet data for this folder
getHistoryData![](/images/permalink.svg)
Retrieve the history data for this folder
getAvailableDocuments![](/images/permalink.svg)
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![](/images/permalink.svg)
Request this document be deleted
getProfileDataOfDocument![](/images/permalink.svg)
Retrieve the profile data for this document
updateProfileDataOfDocument![](/images/permalink.svg)
function updateProfileDataOfDocument(string id, string library, ProfileData payload) returns Response|error
Replace the profile data for this document
Parameters
- id string - Resource identification
- library string - Name of library (lib)
- payload ProfileData -
getSecurityDataOfDocument![](/images/permalink.svg)
Retrieve the security data for this document
updateSecurityData![](/images/permalink.svg)
function updateSecurityData(string id, string library, SecurityData payload) returns json|error
Replace 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![](/images/permalink.svg)
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![](/images/permalink.svg)
function deleteSpecificVersionofSpecificDocument(string id, string 'version, string library) returns Response|error
Request this version of the document be deleted
Parameters
- id string - Resource identification
- 'version string - Version identification
- library string - Name of library (lib)
getCollectionOfReferences![](/images/permalink.svg)
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![](/images/permalink.svg)
function addReferencesToFoldersAndWorkspaces(string id, string library, IdReferencesBody1 payload) returns json|error
Add 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![](/images/permalink.svg)
Request the reference to this document be deleted from a folder or workspace
getAttachments![](/images/permalink.svg)
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![](/images/permalink.svg)
function getContentOfAttachment(string id, string attachment, string library) returns Response|error
Retrieve the contents of this attachment
Parameters
- id string - Resource identification
- attachment string - Attachment identification
- library string - Name of library (lib)
deleteAttachment![](/images/permalink.svg)
Request this attachment be deleted
Parameters
- id string - Resource identification
- attachment string - Attachment identification
- library string - Name of library (lib)
getHistoryDataForDocument![](/images/permalink.svg)
Retrieve the history data for this document
getSavedSearches![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Request this saved search be deleted
getProfileForSavedSearch![](/images/permalink.svg)
Retrieve the profile data for this saved search
getReferencesForSavedSearch![](/images/permalink.svg)
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![](/images/permalink.svg)
function addReferenceToSavedSearch(string id, string library, IdReferencesBody2 payload) returns json|error
Add 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![](/images/permalink.svg)
Request the reference to this saved search be deleted from a workspace
getWorkspaces![](/images/permalink.svg)
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![](/images/permalink.svg)
function addNewWorkspace(string library, ProfileData payload) returns json|error
Add 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![](/images/permalink.svg)
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![](/images/permalink.svg)
Request this workspace be deleted
getProfileDataForWorkspace![](/images/permalink.svg)
Retrieve the profile data for this workspace
repalceProfileDataForWorkspace![](/images/permalink.svg)
function repalceProfileDataForWorkspace(string id, string library, ProfileData payload) returns Response|error
Replace 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![](/images/permalink.svg)
Retrieve the security data for this workspace
updateSecurityDataForWorkspace![](/images/permalink.svg)
function updateSecurityDataForWorkspace(string id, string library, SecurityData payload) returns Response|error
Replace 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![](/images/permalink.svg)
Retrieve the user's security rights for this workspace
getCollectionOfFlexFolders![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Request this FlexFolder (subscription) be deleted
getFilePlans![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getHistoryDataForFilePlan(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns Response|error
Retrieve 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![](/images/permalink.svg)
Retrieve the profile data for this fileplan level
getCollectionOfReferecenForFilePlan![](/images/permalink.svg)
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![](/images/permalink.svg)
function addReferenceToFilePlan(string id, string library, IdReferencesBody3 payload) returns json|error
Add 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![](/images/permalink.svg)
Request the reference to this fileplan be deleted from a folder or workspace
addRequestToFilePlan![](/images/permalink.svg)
function addRequestToFilePlan(string id, string library, IdRequestsBody payload) returns json|error
Add 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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getHistoryDataForBox(string id, string library, int 'start, int max, string? 'ascending, string? 'descending, string? filter) returns Response|error
Retrieve 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![](/images/permalink.svg)
Retrieve the profile data for this box
getRequests![](/images/permalink.svg)
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![](/images/permalink.svg)
Add a request to this fileplan item
Return Type
- json|error - Expected response to a valid request
deleteRequestToFilePlanItem![](/images/permalink.svg)
Request the request to this fileplan item be deleted
getUserSettings![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function replaceConfigurables(string id, string setting, string library, IdSettingBody payload) returns json|error
Replace 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![](/images/permalink.svg)
Request this setting be deleted
Parameters
- id string - Resource identification
- setting string - Setting identification
- library string - Name of library (lib)
getForms![](/images/permalink.svg)
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![](/images/permalink.svg)
Retrieve a collection of applications and their associated form data
Parameters
- library string - Name of library (lib)
getDefinitionDataForForm![](/images/permalink.svg)
Retrieve the definition data for this form
getColumnDefinitionDataForForm![](/images/permalink.svg)
Retrieve the column definition data for this form
getLookups![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Create a URL
deleteURL![](/images/permalink.svg)
Request this url be deleted
getProfileDataForURL![](/images/permalink.svg)
Retrieve the column definition data for this form
Records![](/images/permalink.svg)
edocs: ApiKeysConfig![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- file string? -
- data record {}? -
edocs: CollectionResponse![](/images/permalink.svg)
Collection of items based on the provided criteria
Fields
- data CollectionresponseData? -
edocs: CollectionresponseData![](/images/permalink.svg)
Fields
- set CollectionresponseDataSet? - Information defining the items in the collection
- list anydata[]? - Individual items items in the collection
edocs: CollectionresponseDataSet![](/images/permalink.svg)
Information defining the items in the collection
Fields
- 'start int? -
- max int? -
- 'ascending string? -
- 'descending string? -
- filter string? -
- total int? -
edocs: ConnectBody![](/images/permalink.svg)
Fields
- data ConnectData? -
edocs: ConnectData![](/images/permalink.svg)
Fields
- userid string? -
- password string? -
- library string? -
edocs: DownloadResponse![](/images/permalink.svg)
Fields
- file string? -
edocs: Error![](/images/permalink.svg)
Fields
- code int -
- message string -
edocs: IdReferencesBody![](/images/permalink.svg)
Fields
- data record {}? -
edocs: IdReferencesBody1![](/images/permalink.svg)
Fields
- data record {}? -
edocs: IdReferencesBody2![](/images/permalink.svg)
Fields
- data record {}? -
edocs: IdReferencesBody3![](/images/permalink.svg)
Fields
- data record {}? -
edocs: IdRequestsBody![](/images/permalink.svg)
Fields
- data record {}? -
edocs: IdSettingBody![](/images/permalink.svg)
Fields
- data record {}? -
edocs: ProfileData![](/images/permalink.svg)
Fields
- data record {}? -
edocs: SearchData![](/images/permalink.svg)
Fields
- data record {}? -
edocs: SecurityData![](/images/permalink.svg)
Fields
- data record {}? -
edocs: UploadData![](/images/permalink.svg)
Fields
- file string? -
- data record {}? -
edocs: UrlsBody![](/images/permalink.svg)
Fields
- data UrlsData? -
edocs: UrlsData![](/images/permalink.svg)
Fields
- DISPLAYNAME string? -
- URL_ADDRESS string? -
- _restapi UrlsDataRestapi? -
edocs: UrlsDataRestapi![](/images/permalink.svg)
Fields
- ref UrlsDataRestapiRef? -
edocs: UrlsDataRestapiRef![](/images/permalink.svg)
Fields
- 'type string? -
- id string? -
- lib string? -
Import
import ballerinax/edocs;
Metadata
Released date: over 2 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 2
Current verison: 0
Weekly downloads
Keywords
Content & Files/Documents
Cost/Freemium
Contributors
Dependencies