edocs
Module edocs
API
Definitions
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
edocs: Client
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
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
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
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
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
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
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
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
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
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
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
Request this folder be deleted
getProfileForTheFolder
Retrieve the profile data for this folder
updateProfileData
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
Retrieve the security data for this folder
updateSecurityInfo
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
Retrieve the user's security rights for this folder
getFolderReferences
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
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
Request the reference to this folder be deleted from a folder or workspace
getFacetData
Retrieve the facet data for this folder
getHistoryData
Retrieve the history data for this folder
getAvailableDocuments
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
Request this document be deleted
getProfileDataOfDocument
Retrieve the profile data for this document
updateProfileDataOfDocument
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
Retrieve the security data for this document
updateSecurityData
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
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
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
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
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
Request the reference to this document be deleted from a folder or workspace
getAttachments
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
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
Request this attachment be deleted
Parameters
- id string - Resource identification
- attachment string - Attachment identification
- library string - Name of library (lib)
getHistoryDataForDocument
Retrieve the history data for this document
getSavedSearches
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
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
Request this saved search be deleted
getProfileForSavedSearch
Retrieve the profile data for this saved search
getReferencesForSavedSearch
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
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
Request the reference to this saved search be deleted from a workspace
getWorkspaces
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
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
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
Request this workspace be deleted
getProfileDataForWorkspace
Retrieve the profile data for this workspace
repalceProfileDataForWorkspace
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
Retrieve the security data for this workspace
updateSecurityDataForWorkspace
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
Retrieve the user's security rights for this workspace
getCollectionOfFlexFolders
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
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
Request this FlexFolder (subscription) be deleted
getFilePlans
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
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
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
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
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
Retrieve the profile data for this fileplan level
getCollectionOfReferecenForFilePlan
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
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
Request the reference to this fileplan be deleted from a folder or workspace
addRequestToFilePlan
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
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
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
Retrieve the profile data for this box
getRequests
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
Add a request to this fileplan item
Return Type
- json|error - Expected response to a valid request
deleteRequestToFilePlanItem
Request the request to this fileplan item be deleted
getUserSettings
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
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
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
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
Request this setting be deleted
Parameters
- id string - Resource identification
- setting string - Setting identification
- library string - Name of library (lib)
getForms
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
Retrieve a collection of applications and their associated form data
Parameters
- library string - Name of library (lib)
getDefinitionDataForForm
Retrieve the definition data for this form
getColumnDefinitionDataForForm
Retrieve the column definition data for this form
getLookups
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
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
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
Create a URL
deleteURL
Request this url be deleted
getProfileDataForURL
Retrieve the column definition data for this form
Records
edocs: ApiKeysConfig
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
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
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-forwarded
header
- 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
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? -
Import
import ballerinax/edocs;
Metadata
Released date: over 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 3
Current verison: 1
Weekly downloads
Keywords
Content & Files/Documents
Cost/Freemium
Contributors
Dependencies