Qodex.ai
Qodex.ai
Introduction
Core Viewing Viewer Service
viewers
Return all available viewersLoads the named `viewer`
Return the service rootReturn the service version informationReturn the service health check
Magellan Risk Guard
api/v1
Process documents/images for extraction/identification of PII, PSI and threat/riskGet version of Risk Guard Service
Active Documents Visibility REST Services
entitlementServices/v1/companies/{companyId}
Get available and entitled mailboxesGet list of available partner companies referencesGet entitled Trading Addresses
visibilityServices/v1-documentLifecycles
Visibility - Get document lifecycleVisibility - Get business related lifecycles
visibilityServices/v1
Get list of key namesVisibility - Get envelope lifecyclesVisibility - Get file lifecycles
The LiveSite Content Services (LSCS) REST API Documentation
document
Performs document searches.Gets document content by using the alphanumeric assetId.Gets document content by using the area-relative path of a document in TeamSite.
contexts-{order}
Gets all deployment contexts for a default project.Use the following resource to get all deployment contexts for a default project by given order (asc or desc) based upon the deployment time.
contexts
Gets all deployment contexts for a default project.Use the following resource to get all deployment contexts for a default project by given order (asc or desc) based upon the deployment time.
admin
XML response only. Clients can retrieve the operational status of the LSCS service asset content from LSCS using the admin/status resource.XML Response only. Clients can retrieve more detailed diagnostic information using the admin/diags resource.
Gets the list of all deployed projects.Clients can retrieve the list of all deployed extended attributes, including their type and whether they are faceted or multi-valued, using the metadata-info resource.
Exstream CE Design API (21.2.0)
api/v1-import
Fetch import historyImport a package that was previously exported
api/v1-links/{domain}-multiple
Create multiple resource linksDelete multiple resource links
api/v1-links/{domain}
Fetch links to/from a resourceCreate a resource linkDelete a resource linkFetch resources that are linked to/from another resource
api/v1-resources/{domain}-{id}-content-{type}
Get additional resource contentUpdate additional resource content
api/v1-resources/{domain}-{id}-content
Fetch resource contentUpdate resource content
api/v1-resources/{domain}-{id}-lock
Lock resourceUnlock resource
api/v1-resources/{domain}-{id}
Fetch resource informationUpate resource informationDelete a resourceDisassociate (demote) resource from a domainHide resourceAssociate (promote) resource to a domainRevert to an older resource versionShow/Unhide resourceUpdate the workflow state of a resource
api/v1-resources/{domain}
Fetch resourcesCreate a new resourceCreate resource from fileFetch the history information of a resource
api/v1-themes/{domain}-{themeId}
Fetch themeFetch theme with options payloadUpdate themeUpdate a theme to be based on the latest approved version of its template
api/v1-themes/{domain}
Create a theme
api/v1
Export a resource and its references into a ZIP file
OpenText Core Signature API
brandings-{uuid}
Retrieve a Branding customizationUpdate a Branding customizationPartially update a Branding customizationDelete a Branding customization
brandings
Retrieve a list of Branding customizationsCreate a Branding customization
defaults/signing-flow-customizations-{uuid}
Retrieve a Signing Flow customizationUpdate a Signing Flow customizationPartially update a Signing Flow customizationDelete a Signing Flow customization
defaults/signing-flow-customizations
Retrieve a list of Signing Flow customizationsCreate a Signing Flow customization
document-attachments-{uuid}
Retrieve a Document AttachmentDelete a Document Attachment
document-attachments
Retrieve a list of Document AttachmentsCreate a Document Attachment
documents-{uuid}
Retrieve a DocumentDelete a Document
documents
Retrieve a list of DocumentsCreate a Document
events
Retrieve a list of EventsRetrieve an Event
signature-requests-{uuid}
Retrieve a signature requestCancel a signature requestResend a signature request
signature-requests
Retrieve a list of signature requestsCreate a signature request
templates-{uuid}
Retrieve a TemplateDelete a Template
templates
Retrieve a list of TemplatesCreate a Template
webhooks-{uuid}
Retrieve a WebhookUpdate a WebhookPartially update a WebhookDelete a Webhook
webhooks
Retrieve a list of WebhooksCreate a Webhook
Retrieve a list of allowed file types for uploadSearch documentsQuick create a signature request
OpenText Messaging Email REST API
mra/v1/outbound/emails
Submit a email requestGet Email status
OpenText Connected Workspaces REST API
v1-businessworkspacetypes/{workspace_type_id}
Get business workspace typeGet widgets of business workspace type
v1-externalsystems/{ext_system_id}
Get workspace node IDCreate document in workspace
v1-nodes-{id}
Get business workspace rootGet business workspace types
v1-nodes
Create business workspace template
v1
Authenticate userGet business workspace
v2-businessworkspaces-{bw_id}-relateditems
Get related items of business workspaceAdd relation to the business workspaceDelete relation of a business workspace
v2-businessworkspaces-{bw_id}-icons
Add icon to business workspaceUpdate icon of business workspaceDelete icon of business workspace.
v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}
Get member of roleDelete member of role
v2-businessworkspaces-{bw_id}-roles-{role_id}-members
Get members of roleAdd member to role
v2-businessworkspaces-{bw_id}-roles-{role_id}
Get role of business workspaceUpdate role of business workspaceDelete role of business workspace
v2-businessworkspaces-{bw_id}-roles
Get roles of a business workspaceAdd role to business workspace
v2-businessworkspaces-{bw_id}
Get business workspaceSearch for business workspaces to link
v2-businessworkspaces
Search for business workspacesCreate business workspace
v2-forms
Get business object search formGet business workspace create form
v2
Search for business object typesGet business objectsGet business workspace typesGet configured volumesGenerate reference numberGet picker info
Core Transformation Publication Service
publications-{id}-artifacts-content
Return published artifactsReturn published artifact variants
publications-{id}-artifacts
Return available artifact descriptorsReturns artifact descriptor for the named artifactReturns artifact descriptor for the named artifact
publications-{id}
Return a publicationRemoves a publication
publications
Create a new publicationReturns all publications
Return the service rootReturn the service version informationReturn the service health check
Community Provisioning Services REST API's
v2/onboarding/tradingPartnerProvisionings
Create Trading Partner ProvisioningGet Provisioning Status
Webroot Unity API - OpenAPI Definition (Production)
api-status-site
Returns agent status information for all endpoints matching the specified criteria.Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.
api-status-gsm
Returns agent status information for all endpoints matching the specified criteria.Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.
api-status-reporting/gsm/{gsmKey}-sites-{keyCode}
Returns a site-level summary report of endpoint usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of endpoints.Returns an endpoint-level summary report of endpoint usage for a GSM master keycode by a site keycode. For each endpoint the report includes information like the endpoint's hostname, machine identifier, and its activation state. Returns a site-level summary report of DNSP usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of devices.Returns a site-level summary report of WSAT usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of users.
api-status-reporting/gsm/{gsmKey}-sites
Returns a site-level summary report of endpoint usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of endpoints.Returns a site-level summary report of DNSP usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of devices.Returns a site-level summary report of WSAT usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of users.
api-status-reporting/gsm/{gsmKey}
Returns a GSM-level summary report of endpoint usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and endpoints.Returns an endpoint-level summary report of endpoint usage for a GSM master keycode. For each endpoint the report includes information like the endpoint's hostname, machine identifier, and its activation state Returns a GSM-level summary report of DNSP usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and devices.Returns a GSM-level summary report of WSAT usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and users.
api-usage
Returns usage information for a site keycode.Returns usage information for a master keycode.
api-console-access/gsm/{gsmKey}
Initiates the process for requesting admin access to a GSM console. **IMPORTANT**: Before initiating an access request it is the responsibility of the requestor to inform the owner of the target GSM console that a designated person (whose e-mail addressRetrieves the status of a GSM add admin access request.
api-console-gsm/{gsmKey}-sites-{siteId}-admins
Gets the list of admins on a given GSM site.Adds admins to a site or modifies access permissions of site admins.Gets information about a site admin.
api-console-gsm/{gsmKey}-sites-{siteId}-policies
Gets the list of policies on a given GSM site.Gets information about a site policy.
api-console-gsm/{gsmKey}-sites-{siteId}-groups-{groupId}-endpoints
Gets the list of endpoints on a given group.Applies a new policy to a group of endpoints.Deactivates all endpoints in a group.Issues an agent command to a group of endpoints.
api-console-gsm/{gsmKey}-sites-{siteId}-groups-{groupId}
Gets information about a group.Edits a group under a given GSM site.Deletes a group under a given GSM site.Gets a list of executed commands on a given group.Gets threat history information for endpoints on a group.
api-console-gsm/{gsmKey}-sites-{siteId}-groups
Gets the list of groups on a given GSM site.Creates a group under a given GSM site.
api-console-gsm/{gsmKey}-sites-{siteId}-endpoints-{endpointId}
Gets information about an endpoint.Gets a list of executed commands on a given endpoint.Gets threat history information for a given endpoint.
api-console-gsm/{gsmKey}-sites-{siteId}-endpoints
Gets the list of endpoints on a given GSM site.Moves endpoints to a different group.Applies a new policy to the specified endpoints.Reactivates a list of endpoints, or all endpoints on a site.Deactivates a list of endpoints, or all endpoints on a site.Issues an agent command to a list of endpoints, or to all endpoints on a site.
api-console-gsm/{gsmKey}-sites-{siteId}-blockedurls
Retrieves per-day summary counts of the number of recorded URL actions on endpoints in the given site.Retrieves a list of recorded URL actions on endpoints in the given site.
api-console-gsm/{gsmKey}-sites-{siteId}-dnsp-mappings-{mappingId}
Returns detailed information for a specified mapping of a DNS Protection policy.Edits a specified mapping of a DNS Protection policy.Deletes a specified mapping of a DNS Protection policy.
api-console-gsm/{gsmKey}-sites-{siteId}-dnsp-mappings
Returns the defined mappings of DNS Protection Policies for a GSM parent keycode, filtered by the given site.Creates a mapping for a DNS Protection policy for a GSM site.
api-console-gsm/{gsmKey}-sites-{siteId}-dnsp
Returns information about DNS requests that were blocked by the DNS Protection service.Returns information about DNS requests that were seen by the DNS Protection service for one or more specified categories.Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for a specific site under a given GSM.
api-console-gsm/{gsmKey}-sites-{siteId}-wsat/campaigns
Returns information on activity seen for Webroot Security Awareness Training (WSAT) phishing campaigns associated to a given site.Returns information on activity seen for Webroot Security Awareness Training (WSAT) training campaigns associated to a given site.
api-console-gsm/{gsmKey}-sites-{siteId}
Gets information about a GSM site.Edits information for a site under a given GSM console.Gets a URL to the Webroot web console that, when used in a browser, automatically logs the authenticated user in to the corresponding Endpoint Protection Console.Deactivates a site under a given GSM console.Suspends a site under a given GSM console.Resumes a site under a given GSM console.Converts a trial site under a given GSM console into a full license.Gets a list of executed commands on a given GSM site.Gets threat history information for endpoints on a GSM site.
api-console-gsm/{gsmKey}-sites
Gets the list of sites associated with a given GSM console.Creates a new site under a given GSM console.
api-console-gsm/{gsmKey}-admins
Gets the list of admins on a given GSM console.Gets information about a GSM admin.
api-console-gsm/{gsmKey}-policies
Gets the list of global policies on a given GSM console.Gets information about a GSM policy.
api-console-gsm/{gsmKey}-dnsp-policies
Returns a list of available DNS Protection policies and their respective identifier for a GSM parent keycode.Returns detailed information for one specified DNS Protection policy.
api-console-gsm/{gsmKey}-dnsp
Returns a list of available DNS Protection categories and their respective identifier.Returns a list of available DNS Protection block reasons and their respective identifiers.Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for each site under a given GSM.
api-console-gsm/{gsmKey}
Gets information about a given GSM console.Looks up information about a specific GSM site which is associated with a given site keycode. You can use this method to query site details using a site keycode and to retrieve the site's identifier for follow-up calls.Gets a URL to the Webroot web console that, when used in a browser, automatically logs the authenticated user in to the corresponding GSM Console.
api-ecom-licenses-{licenseId}
Gets the details for an individual license, child license, or trial license by its licenseId.Updates (renew license, increase seats etc.) a license, child license, or trial license by its license id.Cancels an individual license by its license id.Adds a trial module (e.g. DNS Protection or WSAT) to a given license id.Cancels an individual module for a given license id and module code (e.g. "DNS" for DNS Protection or "WSAT" for Webroot Security Awareness Training).
api-ecom-licenses-{keycode}
Gets the details for an individual license, child license, or trial license by its keycode.Updates (renew license, increase seats etc.) a license, child license, or trial license by its keycode.Cancels an individual license by its keycode.Gets all child licenses by a given parent keycode.Adds a trial module (e.g. DNS Protection or WSAT) to a given keycode.Cancels an individual module for a given keycode and module code (e.g. "DNS" for DNS Protection or "WSAT" for Webroot Security Awareness Training).
api-ecom-licenses
Creates one or multiple licenses. Returns order details along with the license id and keycode created for each item in the order.Creates a trial license.
api-ecom-shop-carts-{vendorOrderCode}-customers
Creates end customer (shipping) and/or reseller customer records to associate to a given cart. Note that a billing customer is associated when the cart is created and cannot be modified.Gets the customers associated to a cart.
api-ecom-shop-carts-{vendorOrderCode}
Gets a cart by its vendorOrderCode. The response will also include the cart’s items and customers, if present.
api-ecom-shop-carts
Creates a new shopping cart. Carts act as a container for pending orders.
api-ecom-shop-products/{keycode}
Gets a license by its keycode.Gets information about the order status for a keycode.Creates a request to cancel a particular product.Gets all child licenses of a parent license, but without billing information which is maintained by the parent license.
api-ecom-shop-trials
Creates a trial license for a given product.Creates trial modules for a given parent keycode.
api-ecom-shop
Creates an order by processing a cart.
api-ecom
Gets orders by vendor order code.
api-health
Empty action that can be used to ping for the availability of the service.Retrieves version information of the running service environment.
api-notifications/subscriptions-{subscriptionId}
Gets information about a specific subscription.Edits the information of a specific subscription.Unsubscribes from a specific subscription.Retrieves the latest notifications for a specific subscription.Generates a position token which can be used to start fetching notifications.Suspends calls to the subscription's webhook *DeliveryUrl* for informing about new notifications.Resumes calls to the subscription's webhook *DeliveryUrl* for informing about new notifications.
api-notifications/subscriptions
Gets information about the active subscriptions associated with the authenticated caller.Creates a new subscription.Gets a list of available event types that can be subscribed to, with information on required scope permissions and subscription domains for each event type.
Workflow REST API
administration/privileges-{privilegeName}-groups
Delete a specific privilege for group(s)Add a specific privilege for group(s)
administration/privileges-{privilegeName}-roles
Delete a specific privilege for role(s)Add a specific privilege for role(s)
administration/privileges-{privilegeName}-users
Delete a specific privilege for user(s)Add a specific privilege for user(s)
administration/privileges
List privileges
designtime/models-{modelId}
Delete a non-executable process modelRetrieve process model content
designtime/models
Get non-executable process modelsCreate a non-executable process model
models
Convert process model content from json to xml or vice versaValidate process model content
process-instances-adhoc-subprocesses/{adhocSubprocessId}-activities
List of enabled activities for adhoc sub processExecute activities in adhoc sub process
process-instances-adhoc-subprocesses/{adhocSubprocessId}
Complete adhoc sub process
process-instances-administration/failedasync-jobs
List failed async jobsRecover failed async job
process-instances-executions
List of executions for a process instanceList of executions for a process instance.Broadcast signal or message to a process instance
process-instances-{processInstanceId}-comments-{commentId}
Delete a comment on a process instanceGet a comment on a process instance
process-instances-{processInstanceId}-comments
Get comments on a process instanceCreate new comment on a process instance
process-instances-{processInstanceId}-variables-{variableName}
Delete a variable on a process instanceGet a variable for a process instanceUpdate a single variable on a process instance
process-instances-{processInstanceId}-variables
List variables for a process instanceCreate variables on a process instance
process-instances-{processInstanceId}
Delete a process instanceGet a process instanceActivate or suspend a process instanceList of adhoc sub processes for a process instanceGet diagram for a process instanceInject activity in a process instance
process-instances
List process instancesCreate a process instanceBroadcast signal to create process instances
runtime/models
Get executable process modelsCreate a new executable process modelRetrieve executable process model contentDelete an executable process model
tasks-{taskId}-assignments
Delete assignments on a taskGet an assignments for a taskCreate an assignment on a taskUpdate an assignment on a task
tasks-{taskId}-attachments-{attachmentId}
Delete an attachment on a taskGet an attachment on a task
tasks-{taskId}-attachments
List attachments on a taskCreate a new attachment on a task.
tasks-{taskId}-comments-{commentId}
Delete a comment on a taskGet a comment on a task
tasks-{taskId}-comments
Get comments on a taskCreate a new comment on a task
tasks-{taskId}-variables-{variableName}
Delete a variable on a taskGet a variable for a taskUpdate a single variable on a task
tasks-{taskId}-variables
List variables for a taskCreate variables on a task
tasks-{taskId}
Get a taskAct on a taskUpdate a task
tasks
Get tasksCreate a sub task
Get workflow version information
OpenText Messaging SMS REST API
mra/v1/outbound/sms
Submit SMS requestGet SMS status
Content Storage Service API
v2-tenant/{tenantId}
Upload content for a tenantGet total storage used for a tenant
v2-content-{id}-publicShareUrl-{urlId}
Delete a sharable linkUpdate a sharable linkRetrieve sharable link object
v2-content-{id}-publicShareUrl
Create a new sharable-link for download
v2-content-{id}
Get details of a specific contentDownload content
v2-content
Tenant user upload content
v2
Upload content with upload URL
Get all services of Content Storage Service
OpenText Business Workspaces REST API
v1-businessworkspacetypes/{workspace_type_id}
Get business workspace typeGet widgets of business workspace type
v1-nodes-{id}
Get business workspace rootGet business workspace types
v1-nodes
Create business workspace template
v1
Authenticate userGet business workspace
v2-businessworkspaces-{bw_id}-relateditems
Get related items of business workspaceAdd relation to the business workspaceDelete relation of a business workspace
v2-businessworkspaces-{bw_id}-icons
Add widget icon to business workspaceUpdate icon of business workspaceDelete widget icon of business workspace.
v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}
Get member of roleDelete member of role
v2-businessworkspaces-{bw_id}-roles-{role_id}-members
Get members of roleAdd member to role
v2-businessworkspaces-{bw_id}-roles-{role_id}
Get role of business workspaceUpdate role of business workspaceDelete role of business workspace
v2-businessworkspaces-{bw_id}-roles
Get roles of a business workspaceAdd role to business workspace
v2-businessworkspaces-{bw_id}
Get business workspaceSearch for business workspaces to link
v2-businessworkspaces
Search for business workspacesCreate business workspace
v2-forms/businessworkspaces
Get business workspace create formGet business workspace metadata update form
v2
Get business workspace typesGet configured volumesGenerate reference numberGet picker info
Core Case Administration API
api/v1/case-definitions-{caseDefinitionId}-stages
Create a new lifecycle stageAdd a lifecycle task to a stage
api/v1/case-definitions-{caseDefinitionId}
Create a custom attributeUpdate a case type general settingPublish a case definition
api/v1/case-definitions
Create a case definition with default attributes.
Cartographer Api Endpoints
mp/rest/v1-map
Add map versionMap commentsReserve mapGet map reservation infoUn-reserve mapGet tuples
mp/rest/v1-xbm
Download mapGet map versions
mp/rest/v1
Map detailsGet mapsGet solutions
xref/xrefselfserveapp/rest/xrefSelfServeExternalApi/v1
Get Xref Table detailsGet Xref Tables
Get Auth token
Search Visibility Transactions
/graphql
OpenText Messaging Push REST API
Submit a file to a Parser
Workflow Job REST API
external-jobs-{jobId}
Get a single external worker jobComplete an external worker jobComplete an external worker job with an errorFail an external worker job
external-jobs
List external worker jobsAcquire external worker jobs
timer-jobs-{jobId}
Get a timer jobMove a timer jobUpdate a timer jobDelete a timer job
timer-jobs
List timer jobs
Core Case Application API
api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-documents
Get case documentsAdd documents to case instanceRemove documents from case instance
api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-comments
Get comments on caseAdd comments on caseDelete comments on case
api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}
Delete a caseAssign, claim, revoke, cancel, or resolve a caseGet case details which includes lifecycle stages, tasks etcEdit Case Data including default attributes, custom attributes and input formsGet Input forms
api/v1-case-definitions/{caseDefinitionId}/cases
Create a new case using the caseDefinitionId
api/v1
List cases with paging and sortingList User Cases
Password Management Services REST API's
v1/accounts/credentials
Initiate Reset CredentialReset CredentialsGet Credentials reset request details by Id
Workflow History REST API
historic-process-instances
List historic process instancesGet a historic process instance
historic-task-instances
List historic task instancesGet a historic task instance
List process activity instances audit logList historic activity instancesList process instances audit logList process task instances audit logGet workflow version information
Core Capture Services
session-tables
Returns a list of available tables for the given environment.Returns the table identified by tableId for the given environment.
session-doctypes
Returns the list of available Document Types for the given environment.Returns the Document Type identified by docType for the given environment.
session-files-{fileId}
Retrieves the file identified by the fileId.Appends or retries a stage file chunk.Deletes a stage file.
session-files
Creates a stage file.Deletes all stage files.
session-services
Retrieves a list of the Real-Time Services that are available.Convert Images Service.Process Image Service.Full Page OCR Service.Read BarCodes ServiceClassify Service.Classify Extract Page Service.Classify Extract Document Service.Extract Page Service.Extract Document Service.UIMData Service.Process Image Pipeline Service.Learning Service
session
Retrieves the Session resource.Deletes your session data.Creates and exports a batch.
The Home Document is an entry point to the Core Capture Services.Provides product version information.
OpenText Messaging Fax REST API
mra/v1-outbound/faxes
Submit a fax requestGet fax status
mra/v1-inbound/documents
Retrieve a fax documentDelete a fax document
TGCommunity Services REST API's
v1/companies-{companyId}-users-{userId}
Retrieve UserUpdate UserDelete User
v1/companies-{companyId}-users-{userLoginId}/roles
Retrieve User RolesUpdate User Roles
v1/companies-{companyId}-users
Search UsersCreate User
v1/companies-{companyId}
Retrieve CompanySearch trading community
v1/companies
Search Company
Content Server Rest API
v1-auth
Get Current User InfoAuthenticate user
v1-nodes-{id}-categories-{category_id}
Get category info for a nodeUpdate a category on a nodeRemove a category from a nodeGet category-related actions for a category on a node
v1-nodes-{id}-categories
List categories on a nodeApply a category to a nodeGet category-related actions for a node
v1-nodes-{id}-content
Get contentGet content with a specified filename
v1-nodes-{id}-thumbnails-{size}
Get thumbnail info according to sizeGet thumbnail content according to size
v1-nodes-{id}-thumbnails
Get thumbnail info
v1-nodes-{id}-versions-{version_number}-content
Download versionDownload version in specified name
v1-nodes-{id}-versions-{version_number}-thumbnails-{thumbnail_type}
Get info on the specified size of a version thumbnailDownload version thumbnail in specified size
v1-nodes-{id}-versions-{version_number}-thumbnails
Get info on available version thumbnails
v1-nodes-{id}-versions-{version_number}
Get specified versionUpdate versionDelete versionGet actions for a versionGet categories for specified version
v1-nodes-{id}-versions
List versionsAdd versionGet latest version
v1-nodes-{id}-output
Get output for a WebReportRun a WebReport that has a destination type other than 'browser' or 'desktop'
v1-nodes-{id}
Get a nodeUpdate a node | Move a node | Change the Versions Control setting for a FolderDelete a nodeGet actionsGet info on addable node typesGet ancestorsGet auditGet columnsGet facetsGet subnodesGet destination data for a WebReport
v1-nodes
Create node | Copy a node
v1-forms-nodes-categories
Alpaca form for creating a category on a nodeAlpaca form for updating a category on a node
v1-forms-nodes-properties
Alpaca form detailing the general properties of a nodeAlpaca form detailing the specific properties of a node
v1-forms-nodes-versions-properties
Alpaca form detailing the general properties of a versionAlpaca form detailing the specific properties of a version
v1-forms-nodes-versions
Alpaca form for displaying the categories on a versionAlpaca form for creating a version on a nodeAlpaca form for updating a version on a node
v1-forms-nodes
Alpaca form for copying a nodeAlpaca form for creating a nodeAlpaca form for filing a nodeAlpaca form for moving a nodeAlpaca form for renaming nodeAlpaca form for running a WebReportAlpaca form(s) for updating a node
v1-forms
Alpaca forms detailing the specific properties of a workflowAlpaca forms detailing the specific properties of a workflowAlpaca form for a user
v1-members-{id}
Get user info | Get group infoUpdate user | Update groupDelete user | Delete GroupGet profile photo
v1-members
Search for user | Search for groupCreate group | Create user
v1-validation/nodes
Check a list of namesCheck for enforced required attributesCheck for name collisions
v1-volumes-{type}
Get volume infoGet subnodes of the specified volume
v1-volumes
Get available volumes
v1-webreports/{nickname}
Get output for a WebReportRun a WebReport that has a destination type other than 'browser' or 'desktop'Get parameters info
v1
Get API InfoBulk node actionsInsertable PropertiesGet CS and REST API InfoGet Current Regions InfoGet Current Slices InfoCategories tabTKL Attribute Valid Values
v2-nodes-{id}-categories-{category_id}-inheritance
Enable category inheritance for the node's childrenDisable category inheritance for the node's children
v2-nodes-{id}-categories-{category_id}
Get category info for a nodeUpdate a category on a nodeRemove a category from a node
v2-nodes-{id}-categories
List categories on a nodeApply a category to a nodeUpgrade categories on a node
v2-nodes-{id}-content
Get contentGet content with a specified filename
v2-nodes-{id}-releases
List releases and revisionsCreate release
v2-nodes-{id}-permissions-owner
Get owner permissionsUpdate or Restore the owner permissions
v2-nodes-{id}-permissions-group
Get owner group permissionsUpdate or Restore the owner group permissions
v2-nodes-{id}-permissions-public
Get public access permissionsUpdate the public access permissions
v2-nodes-{id}-permissions-custom
Add an Assigned Access permissionUpdate an Assigned Access permission for the specified user/group
v2-nodes-{id}-permissions
Get all node permissionsGet the effective permissions for the specified user/group
v2-nodes-{id}-versions-{version_number}-renditions
List/Get rendition(s) for a specified versionReplace renditionDelete renditionDownload rendition
v2-nodes-{id}-versions-{version_number}
Get specified versionUpdate versionDelete versionGet categories for specified versionPromote versionLock versionUnlock version
v2-nodes-{id}-versions-renditions
List all renditions for all available versionsAdd rendition
v2-nodes-{id}-versions
List versionsAdd versionPurge versions
v2-nodes-{id}
Get a node | Get a virtual folderUpdate a node | Move a node | Change the Versions Control setting for a Folder | Reserve/Unreserve a node | Collect/Uncollect a nodeDelete a nodeUpdate a node's nicknameGet auditUpdate collectionList the templatesGet subnodesGet node propertiesCreate revisionUpdate System Attributes
v2-nodes-actions
Get actionsGet actions
v2-nodes
Create node | Copy a node
v2-draftprocesses
Creates a draft process.Initiates a process from a draft process
v2-members-{id}-members
Lists the members of a groupAdd members to a groupRemove members from a group
v2-members-{id}
Get user info | Get group infoUpdate user | Update groupDelete user | Delete group
v2-members-favorites-tabs-{id}
Update a Favorites TabRemove a Favorites TabGet Favorites in a Tab
v2-members-favorites-tabs
Get Favorites TabAdd a Favorites TabGet unsorted Favorites
v2-members-favorites-{id}
Add a FavoriteUpdate a FavoriteRemove a Favorite
v2-members-favorites
Get Favorites
v2-members
Search for user | Search for groupCreate user | Create groupSearch for groups where currently logged in user is a memberGet recently accessed listGet recent targetsGet assignmentsGet Reserved Items
v2-notifications/interests/nodes/{id}
Get the notification interests on a nodeSet the notification interests on a node
v2-processes-{process_id}-subprocesses/{subprocess_id}
Sends on a processReads workflow activities
v2-processes-{process_id}
Deletes the processChanges the process status
v2-processes
Initiates a workflowLoads the workflow map definition
v2-search-template-settings/display
Get Display Options from the user's default templateSets Display Options from the user's default template
v2-search-template
Sets the display options for the specified template ID
v2-search
Returns search resultsReturns search resultsGet information on available search Slices, Personal Search Forms, recent Search Forms, and System Search Forms for the user
v2-volumes
Get available volumesGet volume infoGet subnodes of the specified volume
v2
Creates a Instance for Document TemplateExport System Settings to a report fileList facets on a nodeAlpaca Forms for instance creation from templateAutofile a documentGet a node by nicknamePersonalize particular perspective for specific userDefault Values of child TKL attributesImport admin settings from an XML file
Content Metadata Service API
categories-{id}
get category by idupdate category detailspatch category details
categories
List all the categoriesCreate a new categoryget category by name
groups-{groupId}-members-{groupMemberId}
Get group member detailsRemove member from group
groups-{groupId}-members
Get group membershipUpdate group membershipAdd a new group memberRemove all members from group
groups-{groupId}
Get group detailsUpdate groupDelete groupPatch group
groups
List all groupsCreate a new group
instances-{category}/{type}-{id}-linked-parents-{folderId}
Get linked parent detailsDelete linked parent
instances-{category}/{type}-{id}-linked-parents
List linked parentsAdd linked parent to an object
instances-{category}/{type}-{id}-acl
Get ACL associated with object instanceChange ACL associated with object instanceUpdate permits for an ACL associated with an object
instances-{category}/{type}-{id}-parent
Get parent instance detailsChange parent for object instance
instances-{category}/{type}-{id}-policies-{RetentionId}
Get a policy of an objectUpdate qualification date, base_date or policy replacement of an item policyDelete policy for an object
instances-{category}/{type}-{id}-policies
List all policies of an objectAttach a policy to an object
instances-{category}/{type}-{id}-holds
List all holds of an objectAttach a hold to an object
instances-{category}/{type}-{id}-hold/{RetentionId}
Get a hold of an objectReplace existing hold to be a new holdDelete hold for an object
instances-{category}/{type}-{id}-case-node/{caseNodeId}
Get case instance detailsCreate case instance childList case role groups
instances-{category}/{type}-{id}
Get object instance detailsUpdate instance detailsDelete object instanceUpdate instance detailsCopy an object instanceGet effective permissions of the objectRequest instance to send to searchGet history of changes on an object instanceGet relations based on source relation typeGet relations based on target relation type
instances-{category}/{type}
List object instancesCreate new instance
instances-file/{type}/{id}-lock
Lock the file instanceDelete the lock on a file
instances-file/{type}/{id}-contents-{renditionId}
Get rendition detail of the fileUpdate a renditionDelete renditionPatch file rendition
instances-file/{type}/{id}-contents
List all renditions associated with a fileAdd new rendition to fileReplace existing rendition of file
instances-file/{type}/{id}
Delete all versions of an objectCheck if user privilege to download the content associated with file typeMake current to latest versionList all versions of the fileCheck in as next versionCheck in as current version
instances-case/{type}
Create case instanceGet case node instance children
instances-folder/{type}/{id}-items
List object instances under the folderCreate object instances under the folder
instances-folder/{type}/{id}
Get the count of immediate children in the folder
instances
Add history of changes on an object instance
localizations-{id}
Get localization detailsUpdate localization detailsDelete localization
localizations
List all localizationsUpdate all localizationsCreate a new localizationDelete all localizations
bundles-{id}
Get bundleDelete bundle
bundles-{bundleId}/deployments
Get all bundlesInstall bundle into tenantDelete bundle deployment
bundles
Get all bundlesCreate bundle using zip file or json
permissions-{id}
Get permission detailsUpdate permission detailsDelete permissionPatch permission details
permissions
List all the permissionsCreate a new permission
retention-itemPolicy
For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filtersFor backward compatibility, it is old API for setting all item objects for null qualification date and base date on given policy id
retention
List all CMS objects with policies or holds based on the filtersSet all item objects for null qualification date and base date on given policy idRemove same hold id for all CMS objectsDispose a list of CMS objects which is from RPS approval listFor backward compatibility, it is old API for disposing a list of CMS objects which is from RPS approval list
type-definitions-{typeName}-attributes-{attributeId}
Get type attribute detailsUpdate type attribute detailsDelete type attribute
type-definitions-{typeName}-attributes
List all the attributes associated with a typeCreate new type attribute
type-definitions-{typeName}-index-definitions-{indexId}
Get type index definition detailsUpdate type index definition detailsDelete type index definition details
type-definitions-{typeName}-index-definitions
List all the index definitions associated with a typeCreate new type index definition
type-definitions-{typeName}-required-traits-{requiredTraitId}
Get required trait detailsDelete the required trait definition
type-definitions-{typeName}-required-traits
Get list of all the required traits associated with the type definitionsAssociate a new required trait with a type definition
type-definitions-{typeName}-policies
Get list of retention policies from a type-definitionUpdating type definition with one or more new policiesDelete one or more type-definitions policy provided in request body
type-definitions-{typeName}
Get type definition detailsUpdate type definitionDelete type definitionPatch to update/activate/deactivate type definitionGet type and inherited types attributes detailsReturn true if type has at least one instance, false otherwise
type-definitions
List all type definitionsGet history of changes on type definitionCreate a new custom type definition for the given category
trait-definitions-{systemName}-attributes-{attributeId}
Get trait attribute detailsUpdate trait attribute detailsDelete trait attribute
trait-definitions-{systemName}-attributes
List all the attributes associated with a traitCreate new trait attribute
trait-definitions-{systemName}-index-definitions-{indexId}
Get trait index definition detailsUpdate trait index definition detailsDelete trait index definition details
trait-definitions-{systemName}-index-definitions
List all the index definitions associated with a traitCreate new index definition for trait
trait-definitions-{systemName}-acl
Get the permits of the trait definitionPatch the permits of the trait definition
trait-definitions-{systemName}-instanceAcl
Get trait instance acl of the trait definitionDelete instance acl of trait definitionGrant or revoke trait instance acl permits
trait-definitions-{systemName}
Get trait definition detailsUpdate trait definitionDelete trait definitionPatch/activate/deactivate trait definitionReturn true if trait has at least one instance, false otherwise
trait-definitions
Get list of all trait definitions availableCreate a new custom trait definitionGet history of changes on trait definition
case-type-definitions-{id}
Get case model by case model idUpdate case model by case model idDelete case model by case model idReturn true if case model has at least one instance, false otherwise
case-type-definitions
List case modelsCreate a new case model
case-case-nodes/{id}
Get case node details by case node idUpdate case node by idDelete case node by idGet case node parent details
namespaces-{namespaceId}
Get namespace detailsUpdate a namespaceDelete a namespaceUpdate a namespace by patch. Deactivate and activate a namespace by changing active attribute
namespaces
Get list of namespacesCreate a new namespace
shared-links-{id}
Get shared link detailsUpdate shared link detailsPatch shared link detailsDelete shared link
shared-links
Creates a new shared linkList all the shared links
List all service endpointsExecute full text search against search serviceCreate Zip request to have files content be zipped
Introduction
Core Viewing Viewer Service
viewers
Return all available viewersLoads the named `viewer`
Return the service rootReturn the service version informationReturn the service health check
Magellan Risk Guard
api/v1
Process documents/images for extraction/identification of PII, PSI and threat/riskGet version of Risk Guard Service
Active Documents Visibility REST Services
entitlementServices/v1/companies/{companyId}
Get available and entitled mailboxesGet list of available partner companies referencesGet entitled Trading Addresses
visibilityServices/v1-documentLifecycles
Visibility - Get document lifecycleVisibility - Get business related lifecycles
visibilityServices/v1
Get list of key namesVisibility - Get envelope lifecyclesVisibility - Get file lifecycles
The LiveSite Content Services (LSCS) REST API Documentation
document
Performs document searches.Gets document content by using the alphanumeric assetId.Gets document content by using the area-relative path of a document in TeamSite.
contexts-{order}
Gets all deployment contexts for a default project.Use the following resource to get all deployment contexts for a default project by given order (asc or desc) based upon the deployment time.
contexts
Gets all deployment contexts for a default project.Use the following resource to get all deployment contexts for a default project by given order (asc or desc) based upon the deployment time.
admin
XML response only. Clients can retrieve the operational status of the LSCS service asset content from LSCS using the admin/status resource.XML Response only. Clients can retrieve more detailed diagnostic information using the admin/diags resource.
Gets the list of all deployed projects.Clients can retrieve the list of all deployed extended attributes, including their type and whether they are faceted or multi-valued, using the metadata-info resource.
Exstream CE Design API (21.2.0)
api/v1-import
Fetch import historyImport a package that was previously exported
api/v1-links/{domain}-multiple
Create multiple resource linksDelete multiple resource links
api/v1-links/{domain}
Fetch links to/from a resourceCreate a resource linkDelete a resource linkFetch resources that are linked to/from another resource
api/v1-resources/{domain}-{id}-content-{type}
Get additional resource contentUpdate additional resource content
api/v1-resources/{domain}-{id}-content
Fetch resource contentUpdate resource content
api/v1-resources/{domain}-{id}-lock
Lock resourceUnlock resource
api/v1-resources/{domain}-{id}
Fetch resource informationUpate resource informationDelete a resourceDisassociate (demote) resource from a domainHide resourceAssociate (promote) resource to a domainRevert to an older resource versionShow/Unhide resourceUpdate the workflow state of a resource
api/v1-resources/{domain}
Fetch resourcesCreate a new resourceCreate resource from fileFetch the history information of a resource
api/v1-themes/{domain}-{themeId}
Fetch themeFetch theme with options payloadUpdate themeUpdate a theme to be based on the latest approved version of its template
api/v1-themes/{domain}
Create a theme
api/v1
Export a resource and its references into a ZIP file
OpenText Core Signature API
brandings-{uuid}
Retrieve a Branding customizationUpdate a Branding customizationPartially update a Branding customizationDelete a Branding customization
brandings
Retrieve a list of Branding customizationsCreate a Branding customization
defaults/signing-flow-customizations-{uuid}
Retrieve a Signing Flow customizationUpdate a Signing Flow customizationPartially update a Signing Flow customizationDelete a Signing Flow customization
defaults/signing-flow-customizations
Retrieve a list of Signing Flow customizationsCreate a Signing Flow customization
document-attachments-{uuid}
Retrieve a Document AttachmentDelete a Document Attachment
document-attachments
Retrieve a list of Document AttachmentsCreate a Document Attachment
documents-{uuid}
Retrieve a DocumentDelete a Document
documents
Retrieve a list of DocumentsCreate a Document
events
Retrieve a list of EventsRetrieve an Event
signature-requests-{uuid}
Retrieve a signature requestCancel a signature requestResend a signature request
signature-requests
Retrieve a list of signature requestsCreate a signature request
templates-{uuid}
Retrieve a TemplateDelete a Template
templates
Retrieve a list of TemplatesCreate a Template
webhooks-{uuid}
Retrieve a WebhookUpdate a WebhookPartially update a WebhookDelete a Webhook
webhooks
Retrieve a list of WebhooksCreate a Webhook
Retrieve a list of allowed file types for uploadSearch documentsQuick create a signature request
OpenText Messaging Email REST API
mra/v1/outbound/emails
Submit a email requestGet Email status
OpenText Connected Workspaces REST API
v1-businessworkspacetypes/{workspace_type_id}
Get business workspace typeGet widgets of business workspace type
v1-externalsystems/{ext_system_id}
Get workspace node IDCreate document in workspace
v1-nodes-{id}
Get business workspace rootGet business workspace types
v1-nodes
Create business workspace template
v1
Authenticate userGet business workspace
v2-businessworkspaces-{bw_id}-relateditems
Get related items of business workspaceAdd relation to the business workspaceDelete relation of a business workspace
v2-businessworkspaces-{bw_id}-icons
Add icon to business workspaceUpdate icon of business workspaceDelete icon of business workspace.
v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}
Get member of roleDelete member of role
v2-businessworkspaces-{bw_id}-roles-{role_id}-members
Get members of roleAdd member to role
v2-businessworkspaces-{bw_id}-roles-{role_id}
Get role of business workspaceUpdate role of business workspaceDelete role of business workspace
v2-businessworkspaces-{bw_id}-roles
Get roles of a business workspaceAdd role to business workspace
v2-businessworkspaces-{bw_id}
Get business workspaceSearch for business workspaces to link
v2-businessworkspaces
Search for business workspacesCreate business workspace
v2-forms
Get business object search formGet business workspace create form
v2
Search for business object typesGet business objectsGet business workspace typesGet configured volumesGenerate reference numberGet picker info
Core Transformation Publication Service
publications-{id}-artifacts-content
Return published artifactsReturn published artifact variants
publications-{id}-artifacts
Return available artifact descriptorsReturns artifact descriptor for the named artifactReturns artifact descriptor for the named artifact
publications-{id}
Return a publicationRemoves a publication
publications
Create a new publicationReturns all publications
Return the service rootReturn the service version informationReturn the service health check
Community Provisioning Services REST API's
v2/onboarding/tradingPartnerProvisionings
Create Trading Partner ProvisioningGet Provisioning Status
Webroot Unity API - OpenAPI Definition (Production)
api-status-site
Returns agent status information for all endpoints matching the specified criteria.Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.
api-status-gsm
Returns agent status information for all endpoints matching the specified criteria.Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.
api-status-reporting/gsm/{gsmKey}-sites-{keyCode}
Returns a site-level summary report of endpoint usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of endpoints.Returns an endpoint-level summary report of endpoint usage for a GSM master keycode by a site keycode. For each endpoint the report includes information like the endpoint's hostname, machine identifier, and its activation state. Returns a site-level summary report of DNSP usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of devices.Returns a site-level summary report of WSAT usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of users.
api-status-reporting/gsm/{gsmKey}-sites
Returns a site-level summary report of endpoint usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of endpoints.Returns a site-level summary report of DNSP usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of devices.Returns a site-level summary report of WSAT usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of users.
api-status-reporting/gsm/{gsmKey}
Returns a GSM-level summary report of endpoint usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and endpoints.Returns an endpoint-level summary report of endpoint usage for a GSM master keycode. For each endpoint the report includes information like the endpoint's hostname, machine identifier, and its activation state Returns a GSM-level summary report of DNSP usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and devices.Returns a GSM-level summary report of WSAT usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and users.
api-usage
Returns usage information for a site keycode.Returns usage information for a master keycode.
api-console-access/gsm/{gsmKey}
Initiates the process for requesting admin access to a GSM console. **IMPORTANT**: Before initiating an access request it is the responsibility of the requestor to inform the owner of the target GSM console that a designated person (whose e-mail addressRetrieves the status of a GSM add admin access request.
api-console-gsm/{gsmKey}-sites-{siteId}-admins
Gets the list of admins on a given GSM site.Adds admins to a site or modifies access permissions of site admins.Gets information about a site admin.
api-console-gsm/{gsmKey}-sites-{siteId}-policies
Gets the list of policies on a given GSM site.Gets information about a site policy.
api-console-gsm/{gsmKey}-sites-{siteId}-groups-{groupId}-endpoints
Gets the list of endpoints on a given group.Applies a new policy to a group of endpoints.Deactivates all endpoints in a group.Issues an agent command to a group of endpoints.
api-console-gsm/{gsmKey}-sites-{siteId}-groups-{groupId}
Gets information about a group.Edits a group under a given GSM site.Deletes a group under a given GSM site.Gets a list of executed commands on a given group.Gets threat history information for endpoints on a group.
api-console-gsm/{gsmKey}-sites-{siteId}-groups
Gets the list of groups on a given GSM site.Creates a group under a given GSM site.
api-console-gsm/{gsmKey}-sites-{siteId}-endpoints-{endpointId}
Gets information about an endpoint.Gets a list of executed commands on a given endpoint.Gets threat history information for a given endpoint.
api-console-gsm/{gsmKey}-sites-{siteId}-endpoints
Gets the list of endpoints on a given GSM site.Moves endpoints to a different group.Applies a new policy to the specified endpoints.Reactivates a list of endpoints, or all endpoints on a site.Deactivates a list of endpoints, or all endpoints on a site.Issues an agent command to a list of endpoints, or to all endpoints on a site.
api-console-gsm/{gsmKey}-sites-{siteId}-blockedurls
Retrieves per-day summary counts of the number of recorded URL actions on endpoints in the given site.Retrieves a list of recorded URL actions on endpoints in the given site.
api-console-gsm/{gsmKey}-sites-{siteId}-dnsp-mappings-{mappingId}
Returns detailed information for a specified mapping of a DNS Protection policy.Edits a specified mapping of a DNS Protection policy.Deletes a specified mapping of a DNS Protection policy.
api-console-gsm/{gsmKey}-sites-{siteId}-dnsp-mappings
Returns the defined mappings of DNS Protection Policies for a GSM parent keycode, filtered by the given site.Creates a mapping for a DNS Protection policy for a GSM site.
api-console-gsm/{gsmKey}-sites-{siteId}-dnsp
Returns information about DNS requests that were blocked by the DNS Protection service.Returns information about DNS requests that were seen by the DNS Protection service for one or more specified categories.Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for a specific site under a given GSM.
api-console-gsm/{gsmKey}-sites-{siteId}-wsat/campaigns
Returns information on activity seen for Webroot Security Awareness Training (WSAT) phishing campaigns associated to a given site.Returns information on activity seen for Webroot Security Awareness Training (WSAT) training campaigns associated to a given site.
api-console-gsm/{gsmKey}-sites-{siteId}
Gets information about a GSM site.Edits information for a site under a given GSM console.Gets a URL to the Webroot web console that, when used in a browser, automatically logs the authenticated user in to the corresponding Endpoint Protection Console.Deactivates a site under a given GSM console.Suspends a site under a given GSM console.Resumes a site under a given GSM console.Converts a trial site under a given GSM console into a full license.Gets a list of executed commands on a given GSM site.Gets threat history information for endpoints on a GSM site.
api-console-gsm/{gsmKey}-sites
Gets the list of sites associated with a given GSM console.Creates a new site under a given GSM console.
api-console-gsm/{gsmKey}-admins
Gets the list of admins on a given GSM console.Gets information about a GSM admin.
api-console-gsm/{gsmKey}-policies
Gets the list of global policies on a given GSM console.Gets information about a GSM policy.
api-console-gsm/{gsmKey}-dnsp-policies
Returns a list of available DNS Protection policies and their respective identifier for a GSM parent keycode.Returns detailed information for one specified DNS Protection policy.
api-console-gsm/{gsmKey}-dnsp
Returns a list of available DNS Protection categories and their respective identifier.Returns a list of available DNS Protection block reasons and their respective identifiers.Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for each site under a given GSM.
api-console-gsm/{gsmKey}
Gets information about a given GSM console.Looks up information about a specific GSM site which is associated with a given site keycode. You can use this method to query site details using a site keycode and to retrieve the site's identifier for follow-up calls.Gets a URL to the Webroot web console that, when used in a browser, automatically logs the authenticated user in to the corresponding GSM Console.
api-ecom-licenses-{licenseId}
Gets the details for an individual license, child license, or trial license by its licenseId.Updates (renew license, increase seats etc.) a license, child license, or trial license by its license id.Cancels an individual license by its license id.Adds a trial module (e.g. DNS Protection or WSAT) to a given license id.Cancels an individual module for a given license id and module code (e.g. "DNS" for DNS Protection or "WSAT" for Webroot Security Awareness Training).
api-ecom-licenses-{keycode}
Gets the details for an individual license, child license, or trial license by its keycode.Updates (renew license, increase seats etc.) a license, child license, or trial license by its keycode.Cancels an individual license by its keycode.Gets all child licenses by a given parent keycode.Adds a trial module (e.g. DNS Protection or WSAT) to a given keycode.Cancels an individual module for a given keycode and module code (e.g. "DNS" for DNS Protection or "WSAT" for Webroot Security Awareness Training).
api-ecom-licenses
Creates one or multiple licenses. Returns order details along with the license id and keycode created for each item in the order.Creates a trial license.
api-ecom-shop-carts-{vendorOrderCode}-customers
Creates end customer (shipping) and/or reseller customer records to associate to a given cart. Note that a billing customer is associated when the cart is created and cannot be modified.Gets the customers associated to a cart.
api-ecom-shop-carts-{vendorOrderCode}
Gets a cart by its vendorOrderCode. The response will also include the cart’s items and customers, if present.
api-ecom-shop-carts
Creates a new shopping cart. Carts act as a container for pending orders.
api-ecom-shop-products/{keycode}
Gets a license by its keycode.Gets information about the order status for a keycode.Creates a request to cancel a particular product.Gets all child licenses of a parent license, but without billing information which is maintained by the parent license.
api-ecom-shop-trials
Creates a trial license for a given product.Creates trial modules for a given parent keycode.
api-ecom-shop
Creates an order by processing a cart.
api-ecom
Gets orders by vendor order code.
api-health
Empty action that can be used to ping for the availability of the service.Retrieves version information of the running service environment.
api-notifications/subscriptions-{subscriptionId}
Gets information about a specific subscription.Edits the information of a specific subscription.Unsubscribes from a specific subscription.Retrieves the latest notifications for a specific subscription.Generates a position token which can be used to start fetching notifications.Suspends calls to the subscription's webhook *DeliveryUrl* for informing about new notifications.Resumes calls to the subscription's webhook *DeliveryUrl* for informing about new notifications.
api-notifications/subscriptions
Gets information about the active subscriptions associated with the authenticated caller.Creates a new subscription.Gets a list of available event types that can be subscribed to, with information on required scope permissions and subscription domains for each event type.
Workflow REST API
administration/privileges-{privilegeName}-groups
Delete a specific privilege for group(s)Add a specific privilege for group(s)
administration/privileges-{privilegeName}-roles
Delete a specific privilege for role(s)Add a specific privilege for role(s)
administration/privileges-{privilegeName}-users
Delete a specific privilege for user(s)Add a specific privilege for user(s)
administration/privileges
List privileges
designtime/models-{modelId}
Delete a non-executable process modelRetrieve process model content
designtime/models
Get non-executable process modelsCreate a non-executable process model
models
Convert process model content from json to xml or vice versaValidate process model content
process-instances-adhoc-subprocesses/{adhocSubprocessId}-activities
List of enabled activities for adhoc sub processExecute activities in adhoc sub process
process-instances-adhoc-subprocesses/{adhocSubprocessId}
Complete adhoc sub process
process-instances-administration/failedasync-jobs
List failed async jobsRecover failed async job
process-instances-executions
List of executions for a process instanceList of executions for a process instance.Broadcast signal or message to a process instance
process-instances-{processInstanceId}-comments-{commentId}
Delete a comment on a process instanceGet a comment on a process instance
process-instances-{processInstanceId}-comments
Get comments on a process instanceCreate new comment on a process instance
process-instances-{processInstanceId}-variables-{variableName}
Delete a variable on a process instanceGet a variable for a process instanceUpdate a single variable on a process instance
process-instances-{processInstanceId}-variables
List variables for a process instanceCreate variables on a process instance
process-instances-{processInstanceId}
Delete a process instanceGet a process instanceActivate or suspend a process instanceList of adhoc sub processes for a process instanceGet diagram for a process instanceInject activity in a process instance
process-instances
List process instancesCreate a process instanceBroadcast signal to create process instances
runtime/models
Get executable process modelsCreate a new executable process modelRetrieve executable process model contentDelete an executable process model
tasks-{taskId}-assignments
Delete assignments on a taskGet an assignments for a taskCreate an assignment on a taskUpdate an assignment on a task
tasks-{taskId}-attachments-{attachmentId}
Delete an attachment on a taskGet an attachment on a task
tasks-{taskId}-attachments
List attachments on a taskCreate a new attachment on a task.
tasks-{taskId}-comments-{commentId}
Delete a comment on a taskGet a comment on a task
tasks-{taskId}-comments
Get comments on a taskCreate a new comment on a task
tasks-{taskId}-variables-{variableName}
Delete a variable on a taskGet a variable for a taskUpdate a single variable on a task
tasks-{taskId}-variables
List variables for a taskCreate variables on a task
tasks-{taskId}
Get a taskAct on a taskUpdate a task
tasks
Get tasksCreate a sub task
Get workflow version information
OpenText Messaging SMS REST API
mra/v1/outbound/sms
Submit SMS requestGet SMS status
Content Storage Service API
v2-tenant/{tenantId}
Upload content for a tenantGet total storage used for a tenant
v2-content-{id}-publicShareUrl-{urlId}
Delete a sharable linkUpdate a sharable linkRetrieve sharable link object
v2-content-{id}-publicShareUrl
Create a new sharable-link for download
v2-content-{id}
Get details of a specific contentDownload content
v2-content
Tenant user upload content
v2
Upload content with upload URL
Get all services of Content Storage Service
OpenText Business Workspaces REST API
v1-businessworkspacetypes/{workspace_type_id}
Get business workspace typeGet widgets of business workspace type
v1-nodes-{id}
Get business workspace rootGet business workspace types
v1-nodes
Create business workspace template
v1
Authenticate userGet business workspace
v2-businessworkspaces-{bw_id}-relateditems
Get related items of business workspaceAdd relation to the business workspaceDelete relation of a business workspace
v2-businessworkspaces-{bw_id}-icons
Add widget icon to business workspaceUpdate icon of business workspaceDelete widget icon of business workspace.
v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}
Get member of roleDelete member of role
v2-businessworkspaces-{bw_id}-roles-{role_id}-members
Get members of roleAdd member to role
v2-businessworkspaces-{bw_id}-roles-{role_id}
Get role of business workspaceUpdate role of business workspaceDelete role of business workspace
v2-businessworkspaces-{bw_id}-roles
Get roles of a business workspaceAdd role to business workspace
v2-businessworkspaces-{bw_id}
Get business workspaceSearch for business workspaces to link
v2-businessworkspaces
Search for business workspacesCreate business workspace
v2-forms/businessworkspaces
Get business workspace create formGet business workspace metadata update form
v2
Get business workspace typesGet configured volumesGenerate reference numberGet picker info
Core Case Administration API
api/v1/case-definitions-{caseDefinitionId}-stages
Create a new lifecycle stageAdd a lifecycle task to a stage
api/v1/case-definitions-{caseDefinitionId}
Create a custom attributeUpdate a case type general settingPublish a case definition
api/v1/case-definitions
Create a case definition with default attributes.
Cartographer Api Endpoints
mp/rest/v1-map
Add map versionMap commentsReserve mapGet map reservation infoUn-reserve mapGet tuples
mp/rest/v1-xbm
Download mapGet map versions
mp/rest/v1
Map detailsGet mapsGet solutions
xref/xrefselfserveapp/rest/xrefSelfServeExternalApi/v1
Get Xref Table detailsGet Xref Tables
Get Auth token
Search Visibility Transactions
/graphql
OpenText Messaging Push REST API
Submit a file to a Parser
Workflow Job REST API
external-jobs-{jobId}
Get a single external worker jobComplete an external worker jobComplete an external worker job with an errorFail an external worker job
external-jobs
List external worker jobsAcquire external worker jobs
timer-jobs-{jobId}
Get a timer jobMove a timer jobUpdate a timer jobDelete a timer job
timer-jobs
List timer jobs
Core Case Application API
api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-documents
Get case documentsAdd documents to case instanceRemove documents from case instance
api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-comments
Get comments on caseAdd comments on caseDelete comments on case
api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}
Delete a caseAssign, claim, revoke, cancel, or resolve a caseGet case details which includes lifecycle stages, tasks etcEdit Case Data including default attributes, custom attributes and input formsGet Input forms
api/v1-case-definitions/{caseDefinitionId}/cases
Create a new case using the caseDefinitionId
api/v1
List cases with paging and sortingList User Cases
Password Management Services REST API's
v1/accounts/credentials
Initiate Reset CredentialReset CredentialsGet Credentials reset request details by Id
Workflow History REST API
historic-process-instances
List historic process instancesGet a historic process instance
historic-task-instances
List historic task instancesGet a historic task instance
List process activity instances audit logList historic activity instancesList process instances audit logList process task instances audit logGet workflow version information
Core Capture Services
session-tables
Returns a list of available tables for the given environment.Returns the table identified by tableId for the given environment.
session-doctypes
Returns the list of available Document Types for the given environment.Returns the Document Type identified by docType for the given environment.
session-files-{fileId}
Retrieves the file identified by the fileId.Appends or retries a stage file chunk.Deletes a stage file.
session-files
Creates a stage file.Deletes all stage files.
session-services
Retrieves a list of the Real-Time Services that are available.Convert Images Service.Process Image Service.Full Page OCR Service.Read BarCodes ServiceClassify Service.Classify Extract Page Service.Classify Extract Document Service.Extract Page Service.Extract Document Service.UIMData Service.Process Image Pipeline Service.Learning Service
session
Retrieves the Session resource.Deletes your session data.Creates and exports a batch.
The Home Document is an entry point to the Core Capture Services.Provides product version information.
OpenText Messaging Fax REST API
mra/v1-outbound/faxes
Submit a fax requestGet fax status
mra/v1-inbound/documents
Retrieve a fax documentDelete a fax document
TGCommunity Services REST API's
v1/companies-{companyId}-users-{userId}
Retrieve UserUpdate UserDelete User
v1/companies-{companyId}-users-{userLoginId}/roles
Retrieve User RolesUpdate User Roles
v1/companies-{companyId}-users
Search UsersCreate User
v1/companies-{companyId}
Retrieve CompanySearch trading community
v1/companies
Search Company
Content Server Rest API
v1-auth
Get Current User InfoAuthenticate user
v1-nodes-{id}-categories-{category_id}
Get category info for a nodeUpdate a category on a nodeRemove a category from a nodeGet category-related actions for a category on a node
v1-nodes-{id}-categories
List categories on a nodeApply a category to a nodeGet category-related actions for a node
v1-nodes-{id}-content
Get contentGet content with a specified filename
v1-nodes-{id}-thumbnails-{size}
Get thumbnail info according to sizeGet thumbnail content according to size
v1-nodes-{id}-thumbnails
Get thumbnail info
v1-nodes-{id}-versions-{version_number}-content
Download versionDownload version in specified name
v1-nodes-{id}-versions-{version_number}-thumbnails-{thumbnail_type}
Get info on the specified size of a version thumbnailDownload version thumbnail in specified size
v1-nodes-{id}-versions-{version_number}-thumbnails
Get info on available version thumbnails
v1-nodes-{id}-versions-{version_number}
Get specified versionUpdate versionDelete versionGet actions for a versionGet categories for specified version
v1-nodes-{id}-versions
List versionsAdd versionGet latest version
v1-nodes-{id}-output
Get output for a WebReportRun a WebReport that has a destination type other than 'browser' or 'desktop'
v1-nodes-{id}
Get a nodeUpdate a node | Move a node | Change the Versions Control setting for a FolderDelete a nodeGet actionsGet info on addable node typesGet ancestorsGet auditGet columnsGet facetsGet subnodesGet destination data for a WebReport
v1-nodes
Create node | Copy a node
v1-forms-nodes-categories
Alpaca form for creating a category on a nodeAlpaca form for updating a category on a node
v1-forms-nodes-properties
Alpaca form detailing the general properties of a nodeAlpaca form detailing the specific properties of a node
v1-forms-nodes-versions-properties
Alpaca form detailing the general properties of a versionAlpaca form detailing the specific properties of a version
v1-forms-nodes-versions
Alpaca form for displaying the categories on a versionAlpaca form for creating a version on a nodeAlpaca form for updating a version on a node
v1-forms-nodes
Alpaca form for copying a nodeAlpaca form for creating a nodeAlpaca form for filing a nodeAlpaca form for moving a nodeAlpaca form for renaming nodeAlpaca form for running a WebReportAlpaca form(s) for updating a node
v1-forms
Alpaca forms detailing the specific properties of a workflowAlpaca forms detailing the specific properties of a workflowAlpaca form for a user
v1-members-{id}
Get user info | Get group infoUpdate user | Update groupDelete user | Delete GroupGet profile photo
v1-members
Search for user | Search for groupCreate group | Create user
v1-validation/nodes
Check a list of namesCheck for enforced required attributesCheck for name collisions
v1-volumes-{type}
Get volume infoGet subnodes of the specified volume
v1-volumes
Get available volumes
v1-webreports/{nickname}
Get output for a WebReportRun a WebReport that has a destination type other than 'browser' or 'desktop'Get parameters info
v1
Get API InfoBulk node actionsInsertable PropertiesGet CS and REST API InfoGet Current Regions InfoGet Current Slices InfoCategories tabTKL Attribute Valid Values
v2-nodes-{id}-categories-{category_id}-inheritance
Enable category inheritance for the node's childrenDisable category inheritance for the node's children
v2-nodes-{id}-categories-{category_id}
Get category info for a nodeUpdate a category on a nodeRemove a category from a node
v2-nodes-{id}-categories
List categories on a nodeApply a category to a nodeUpgrade categories on a node
v2-nodes-{id}-content
Get contentGet content with a specified filename
v2-nodes-{id}-releases
List releases and revisionsCreate release
v2-nodes-{id}-permissions-owner
Get owner permissionsUpdate or Restore the owner permissions
v2-nodes-{id}-permissions-group
Get owner group permissionsUpdate or Restore the owner group permissions
v2-nodes-{id}-permissions-public
Get public access permissionsUpdate the public access permissions
v2-nodes-{id}-permissions-custom
Add an Assigned Access permissionUpdate an Assigned Access permission for the specified user/group
v2-nodes-{id}-permissions
Get all node permissionsGet the effective permissions for the specified user/group
v2-nodes-{id}-versions-{version_number}-renditions
List/Get rendition(s) for a specified versionReplace renditionDelete renditionDownload rendition
v2-nodes-{id}-versions-{version_number}
Get specified versionUpdate versionDelete versionGet categories for specified versionPromote versionLock versionUnlock version
v2-nodes-{id}-versions-renditions
List all renditions for all available versionsAdd rendition
v2-nodes-{id}-versions
List versionsAdd versionPurge versions
v2-nodes-{id}
Get a node | Get a virtual folderUpdate a node | Move a node | Change the Versions Control setting for a Folder | Reserve/Unreserve a node | Collect/Uncollect a nodeDelete a nodeUpdate a node's nicknameGet auditUpdate collectionList the templatesGet subnodesGet node propertiesCreate revisionUpdate System Attributes
v2-nodes-actions
Get actionsGet actions
v2-nodes
Create node | Copy a node
v2-draftprocesses
Creates a draft process.Initiates a process from a draft process
v2-members-{id}-members
Lists the members of a groupAdd members to a groupRemove members from a group
v2-members-{id}
Get user info | Get group infoUpdate user | Update groupDelete user | Delete group
v2-members-favorites-tabs-{id}
Update a Favorites TabRemove a Favorites TabGet Favorites in a Tab
v2-members-favorites-tabs
Get Favorites TabAdd a Favorites TabGet unsorted Favorites
v2-members-favorites-{id}
Add a FavoriteUpdate a FavoriteRemove a Favorite
v2-members-favorites
Get Favorites
v2-members
Search for user | Search for groupCreate user | Create groupSearch for groups where currently logged in user is a memberGet recently accessed listGet recent targetsGet assignmentsGet Reserved Items
v2-notifications/interests/nodes/{id}
Get the notification interests on a nodeSet the notification interests on a node
v2-processes-{process_id}-subprocesses/{subprocess_id}
Sends on a processReads workflow activities
v2-processes-{process_id}
Deletes the processChanges the process status
v2-processes
Initiates a workflowLoads the workflow map definition
v2-search-template-settings/display
Get Display Options from the user's default templateSets Display Options from the user's default template
v2-search-template
Sets the display options for the specified template ID
v2-search
Returns search resultsReturns search resultsGet information on available search Slices, Personal Search Forms, recent Search Forms, and System Search Forms for the user
v2-volumes
Get available volumesGet volume infoGet subnodes of the specified volume
v2
Creates a Instance for Document TemplateExport System Settings to a report fileList facets on a nodeAlpaca Forms for instance creation from templateAutofile a documentGet a node by nicknamePersonalize particular perspective for specific userDefault Values of child TKL attributesImport admin settings from an XML file
Content Metadata Service API
categories-{id}
get category by idupdate category detailspatch category details
categories
List all the categoriesCreate a new categoryget category by name
groups-{groupId}-members-{groupMemberId}
Get group member detailsRemove member from group
groups-{groupId}-members
Get group membershipUpdate group membershipAdd a new group memberRemove all members from group
groups-{groupId}
Get group detailsUpdate groupDelete groupPatch group
groups
List all groupsCreate a new group
instances-{category}/{type}-{id}-linked-parents-{folderId}
Get linked parent detailsDelete linked parent
instances-{category}/{type}-{id}-linked-parents
List linked parentsAdd linked parent to an object
instances-{category}/{type}-{id}-acl
Get ACL associated with object instanceChange ACL associated with object instanceUpdate permits for an ACL associated with an object
instances-{category}/{type}-{id}-parent
Get parent instance detailsChange parent for object instance
instances-{category}/{type}-{id}-policies-{RetentionId}
Get a policy of an objectUpdate qualification date, base_date or policy replacement of an item policyDelete policy for an object
instances-{category}/{type}-{id}-policies
List all policies of an objectAttach a policy to an object
instances-{category}/{type}-{id}-holds
List all holds of an objectAttach a hold to an object
instances-{category}/{type}-{id}-hold/{RetentionId}
Get a hold of an objectReplace existing hold to be a new holdDelete hold for an object
instances-{category}/{type}-{id}-case-node/{caseNodeId}
Get case instance detailsCreate case instance childList case role groups
instances-{category}/{type}-{id}
Get object instance detailsUpdate instance detailsDelete object instanceUpdate instance detailsCopy an object instanceGet effective permissions of the objectRequest instance to send to searchGet history of changes on an object instanceGet relations based on source relation typeGet relations based on target relation type
instances-{category}/{type}
List object instancesCreate new instance
instances-file/{type}/{id}-lock
Lock the file instanceDelete the lock on a file
instances-file/{type}/{id}-contents-{renditionId}
Get rendition detail of the fileUpdate a renditionDelete renditionPatch file rendition
instances-file/{type}/{id}-contents
List all renditions associated with a fileAdd new rendition to fileReplace existing rendition of file
instances-file/{type}/{id}
Delete all versions of an objectCheck if user privilege to download the content associated with file typeMake current to latest versionList all versions of the fileCheck in as next versionCheck in as current version
instances-case/{type}
Create case instanceGet case node instance children
instances-folder/{type}/{id}-items
List object instances under the folderCreate object instances under the folder
instances-folder/{type}/{id}
Get the count of immediate children in the folder
instances
Add history of changes on an object instance
localizations-{id}
Get localization detailsUpdate localization detailsDelete localization
localizations
List all localizationsUpdate all localizationsCreate a new localizationDelete all localizations
bundles-{id}
Get bundleDelete bundle
bundles-{bundleId}/deployments
Get all bundlesInstall bundle into tenantDelete bundle deployment
bundles
Get all bundlesCreate bundle using zip file or json
permissions-{id}
Get permission detailsUpdate permission detailsDelete permissionPatch permission details
permissions
List all the permissionsCreate a new permission
retention-itemPolicy
For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filtersFor backward compatibility, it is old API for setting all item objects for null qualification date and base date on given policy id
retention
List all CMS objects with policies or holds based on the filtersSet all item objects for null qualification date and base date on given policy idRemove same hold id for all CMS objectsDispose a list of CMS objects which is from RPS approval listFor backward compatibility, it is old API for disposing a list of CMS objects which is from RPS approval list
type-definitions-{typeName}-attributes-{attributeId}
Get type attribute detailsUpdate type attribute detailsDelete type attribute
type-definitions-{typeName}-attributes
List all the attributes associated with a typeCreate new type attribute
type-definitions-{typeName}-index-definitions-{indexId}
Get type index definition detailsUpdate type index definition detailsDelete type index definition details
type-definitions-{typeName}-index-definitions
List all the index definitions associated with a typeCreate new type index definition
type-definitions-{typeName}-required-traits-{requiredTraitId}
Get required trait detailsDelete the required trait definition
type-definitions-{typeName}-required-traits
Get list of all the required traits associated with the type definitionsAssociate a new required trait with a type definition
type-definitions-{typeName}-policies
Get list of retention policies from a type-definitionUpdating type definition with one or more new policiesDelete one or more type-definitions policy provided in request body
type-definitions-{typeName}
Get type definition detailsUpdate type definitionDelete type definitionPatch to update/activate/deactivate type definitionGet type and inherited types attributes detailsReturn true if type has at least one instance, false otherwise
type-definitions
List all type definitionsGet history of changes on type definitionCreate a new custom type definition for the given category
trait-definitions-{systemName}-attributes-{attributeId}
Get trait attribute detailsUpdate trait attribute detailsDelete trait attribute
trait-definitions-{systemName}-attributes
List all the attributes associated with a traitCreate new trait attribute
trait-definitions-{systemName}-index-definitions-{indexId}
Get trait index definition detailsUpdate trait index definition detailsDelete trait index definition details
trait-definitions-{systemName}-index-definitions
List all the index definitions associated with a traitCreate new index definition for trait
trait-definitions-{systemName}-acl
Get the permits of the trait definitionPatch the permits of the trait definition
trait-definitions-{systemName}-instanceAcl
Get trait instance acl of the trait definitionDelete instance acl of trait definitionGrant or revoke trait instance acl permits
trait-definitions-{systemName}
Get trait definition detailsUpdate trait definitionDelete trait definitionPatch/activate/deactivate trait definitionReturn true if trait has at least one instance, false otherwise
trait-definitions
Get list of all trait definitions availableCreate a new custom trait definitionGet history of changes on trait definition
case-type-definitions-{id}
Get case model by case model idUpdate case model by case model idDelete case model by case model idReturn true if case model has at least one instance, false otherwise
case-type-definitions
List case modelsCreate a new case model
case-case-nodes/{id}
Get case node details by case node idUpdate case node by idDelete case node by idGet case node parent details
namespaces-{namespaceId}
Get namespace detailsUpdate a namespaceDelete a namespaceUpdate a namespace by patch. Deactivate and activate a namespace by changing active attribute
namespaces
Get list of namespacesCreate a new namespace
shared-links-{id}
Get shared link detailsUpdate shared link detailsPatch shared link detailsDelete shared link
shared-links
Creates a new shared linkList all the shared links
List all service endpointsExecute full text search against search serviceCreate Zip request to have files content be zipped
HomeContent Server Rest APIv2-search

v2-search

Number of APIs: 3

  1. Get information on available search Slices, Personal Search Forms, recent Search Forms, and System Search Forms for the user GET {{baseUrl}}/v2/search/members/info?location=-11141396&enterprise_slices=true

  2. Returns search results GET {{baseUrl}}/v2/search

  3. Returns search results POST {{baseUrl}}/v2/search

Previous
Sets the display options for the specified template ID
Next
Returns search results