Core Viewing Viewer Service

Return all available viewers Loads the named `viewer`

Return the service root Return the service version information Return the service health check

Magellan Risk Guard

Process documents/images for extraction/identification of PII, PSI and threat/risk Get version of Risk Guard Service

Active Documents Visibility REST Services

entitlementServices/v1/companies/{companyId}

Get available and entitled mailboxes Get list of available partner companies references Get entitled Trading Addresses

visibilityServices/v1-documentLifecycles

Visibility - Get document lifecycle Visibility - Get business related lifecycles

visibilityServices/v1

Get list of key names Visibility - Get envelope lifecycles Visibility - Get file lifecycles

The LiveSite Content Services (LSCS) REST API Documentation

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.

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.

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)

Fetch import history Import a package that was previously exported

api/v1-links/{domain}-multiple

Create multiple resource links Delete multiple resource links

api/v1-links/{domain}

Fetch links to/from a resource Create a resource link Delete a resource link Fetch resources that are linked to/from another resource

api/v1-resources/{domain}-{id}-content-{type}

Get additional resource content Update additional resource content

api/v1-resources/{domain}-{id}-content

Fetch resource content Update resource content

api/v1-resources/{domain}-{id}-lock

Lock resource Unlock resource

api/v1-resources/{domain}-{id}

Fetch resource information Upate resource information Delete a resource Disassociate (demote) resource from a domain Hide resource Associate (promote) resource to a domain Revert to an older resource version Show/Unhide resource Update the workflow state of a resource

api/v1-resources/{domain}

Fetch resources Create a new resource Create resource from file Fetch the history information of a resource

api/v1-themes/{domain}-{themeId}

Fetch theme Fetch theme with options payload Update theme Update a theme to be based on the latest approved version of its template

api/v1-themes/{domain}

Export a resource and its references into a ZIP file

OpenText Core Signature API

brandings-{uuid}

Retrieve a Branding customization Update a Branding customization Partially update a Branding customization Delete a Branding customization

Retrieve a list of Branding customizations Create a Branding customization

defaults/signing-flow-customizations-{uuid}

Retrieve a Signing Flow customization Update a Signing Flow customization Partially update a Signing Flow customization Delete a Signing Flow customization

defaults/signing-flow-customizations

Retrieve a list of Signing Flow customizations Create a Signing Flow customization

document-attachments-{uuid}

Retrieve a Document Attachment Delete a Document Attachment

document-attachments

Retrieve a list of Document Attachments Create a Document Attachment

documents-{uuid}

Retrieve a Document Delete a Document

Retrieve a list of Documents Create a Document

Retrieve a list of Events Retrieve an Event

signature-requests-{uuid}

Retrieve a signature request Cancel a signature request Resend a signature request

signature-requests

Retrieve a list of signature requests Create a signature request

templates-{uuid}

Retrieve a Template Delete a Template

Retrieve a list of Templates Create a Template

webhooks-{uuid}

Retrieve a Webhook Update a Webhook Partially update a Webhook Delete a Webhook

Retrieve a list of Webhooks Create a Webhook

Retrieve a list of allowed file types for upload Search documents Quick create a signature request

OpenText Messaging Email REST API

mra/v1/outbound/emails

Submit a email request Get Email status

OpenText Connected Workspaces REST API

v1-businessworkspacetypes/{workspace_type_id}

Get business workspace type Get widgets of business workspace type

v1-externalsystems/{ext_system_id}

Get workspace node ID Create document in workspace

Get business workspace root Get business workspace types

Create business workspace template

Authenticate user Get business workspace

v2-businessworkspaces-{bw_id}-relateditems

Get related items of business workspace Add relation to the business workspace Delete relation of a business workspace

v2-businessworkspaces-{bw_id}-icons

Add icon to business workspace Update icon of business workspace Delete icon of business workspace.

v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}

Get member of role Delete member of role

v2-businessworkspaces-{bw_id}-roles-{role_id}-members

Get members of role Add member to role

v2-businessworkspaces-{bw_id}-roles-{role_id}

Get role of business workspace Update role of business workspace Delete role of business workspace

v2-businessworkspaces-{bw_id}-roles

Get roles of a business workspace Add role to business workspace

v2-businessworkspaces-{bw_id}

Get business workspace Search for business workspaces to link

v2-businessworkspaces

Search for business workspaces Create business workspace

Get business object search form Get business workspace create form

Search for business object types Get business objects Get business workspace types Get configured volumes Generate reference number Get picker info

Core Transformation Publication Service

publications-{id}-artifacts-content

Return published artifacts Return published artifact variants

publications-{id}-artifacts

Return available artifact descriptors Returns artifact descriptor for the named artifact Returns artifact descriptor for the named artifact

publications-{id}

Return a publication Removes a publication

Create a new publication Returns all publications

Return the service root Return the service version information Return the service health check

Community Provisioning Services REST API's

v2/onboarding/tradingPartnerProvisionings

Create Trading Partner Provisioning Get 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.

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.

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 address Retrieves 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.

Creates an order by processing a cart.

Gets orders by vendor order code.

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 model Retrieve process model content

designtime/models

Get non-executable process models Create a non-executable process model

Convert process model content from json to xml or vice versa Validate process model content

process-instances-adhoc-subprocesses/{adhocSubprocessId}-activities

List of enabled activities for adhoc sub process Execute activities in adhoc sub process

process-instances-adhoc-subprocesses/{adhocSubprocessId}

Complete adhoc sub process

process-instances-administration/failedasync-jobs

List failed async jobs Recover failed async job

process-instances-executions

List of executions for a process instance List 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 instance Get a comment on a process instance

process-instances-{processInstanceId}-comments

Get comments on a process instance Create new comment on a process instance

process-instances-{processInstanceId}-variables-{variableName}

Delete a variable on a process instance Get a variable for a process instance Update a single variable on a process instance

process-instances-{processInstanceId}-variables

List variables for a process instance Create variables on a process instance

process-instances-{processInstanceId}

Delete a process instance Get a process instance Activate or suspend a process instance List of adhoc sub processes for a process instance Get diagram for a process instance Inject activity in a process instance

process-instances

List process instances Create a process instance Broadcast signal to create process instances

Get executable process models Create a new executable process model Retrieve executable process model content Delete an executable process model

tasks-{taskId}-assignments

Delete assignments on a task Get an assignments for a task Create an assignment on a task Update an assignment on a task

tasks-{taskId}-attachments-{attachmentId}

Delete an attachment on a task Get an attachment on a task

tasks-{taskId}-attachments

List attachments on a task Create a new attachment on a task.

tasks-{taskId}-comments-{commentId}

Delete a comment on a task Get a comment on a task

tasks-{taskId}-comments

Get comments on a task Create a new comment on a task

tasks-{taskId}-variables-{variableName}

Delete a variable on a task Get a variable for a task Update a single variable on a task

tasks-{taskId}-variables

List variables for a task Create variables on a task

Get a task Act on a task Update a task

Get tasks Create a sub task

Get workflow version information

OpenText Messaging SMS REST API

mra/v1/outbound/sms

Submit SMS request Get SMS status

Content Storage Service API

v2-tenant/{tenantId}

Upload content for a tenant Get total storage used for a tenant

v2-content-{id}-publicShareUrl-{urlId}

Delete a sharable link Update a sharable link Retrieve sharable link object

v2-content-{id}-publicShareUrl

Create a new sharable-link for download

v2-content-{id}

Get details of a specific content Download content

Tenant user upload content

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 type Get widgets of business workspace type

Get business workspace root Get business workspace types

Create business workspace template

Authenticate user Get business workspace

v2-businessworkspaces-{bw_id}-relateditems

Get related items of business workspace Add relation to the business workspace Delete relation of a business workspace

v2-businessworkspaces-{bw_id}-icons

Add widget icon to business workspace Update icon of business workspace Delete widget icon of business workspace.

v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}

Get member of role Delete member of role

v2-businessworkspaces-{bw_id}-roles-{role_id}-members

Get members of role Add member to role

v2-businessworkspaces-{bw_id}-roles-{role_id}

Get role of business workspace Update role of business workspace Delete role of business workspace

v2-businessworkspaces-{bw_id}-roles

Get roles of a business workspace Add role to business workspace

v2-businessworkspaces-{bw_id}

Get business workspace Search for business workspaces to link

v2-businessworkspaces

Search for business workspaces Create business workspace

v2-forms/businessworkspaces

Get business workspace create form Get business workspace metadata update form

Get business workspace types Get configured volumes Generate reference number Get picker info

Core Case Administration API

api/v1/case-definitions-{caseDefinitionId}-stages

Create a new lifecycle stage Add a lifecycle task to a stage

api/v1/case-definitions-{caseDefinitionId}

Create a custom attribute Update a case type general setting Publish a case definition

api/v1/case-definitions

Create a case definition with default attributes.

Cartographer Api Endpoints

Add map version Map comments Reserve map Get map reservation info Un-reserve map Get tuples

Download map Get map versions

Map details Get maps Get solutions

xref/xrefselfserveapp/rest/xrefSelfServeExternalApi/v1

Get Xref Table details Get Xref Tables

Search Visibility Transactions

OpenText Messaging Push REST API

Submit a file to a Parser

Workflow Job REST API

external-jobs-{jobId}

Get a single external worker job Complete an external worker job Complete an external worker job with an error Fail an external worker job

List external worker jobs Acquire external worker jobs

timer-jobs-{jobId}

Get a timer job Move a timer job Update a timer job Delete a timer job

List timer jobs

Core Case Application API

api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-documents

Get case documents Add documents to case instance Remove documents from case instance

api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-comments

Get comments on case Add comments on case Delete comments on case

api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}

Delete a case Assign, claim, revoke, cancel, or resolve a case Get case details which includes lifecycle stages, tasks etc Edit Case Data including default attributes, custom attributes and input forms Get Input forms

api/v1-case-definitions/{caseDefinitionId}/cases

Create a new case using the caseDefinitionId

List cases with paging and sorting List User Cases

Password Management Services REST API's

v1/accounts/credentials

Initiate Reset Credential Reset Credentials Get Credentials reset request details by Id

Workflow History REST API

historic-process-instances

List historic process instances Get a historic process instance

historic-task-instances

List historic task instances Get a historic task instance

List process activity instances audit log List historic activity instances List process instances audit log List process task instances audit log Get workflow version information

Core Capture Services

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.

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 Service Classify Service.Classify Extract Page Service.Classify Extract Document Service.Extract Page Service.Extract Document Service.UIMData Service.Process Image Pipeline Service.Learning Service

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 request Get fax status

mra/v1-inbound/documents

Retrieve a fax document Delete a fax document

TGCommunity Services REST API's

v1/companies-{companyId}-users-{userId}

Retrieve User Update User Delete User

v1/companies-{companyId}-users-{userLoginId}/roles

Retrieve User Roles Update User Roles

v1/companies-{companyId}-users

Search Users Create User

v1/companies-{companyId}

Retrieve Company Search trading community

Content Server Rest API

Get Current User Info Authenticate user

v1-nodes-{id}-categories-{category_id}

Get category info for a node Update a category on a node Remove a category from a node Get category-related actions for a category on a node

v1-nodes-{id}-categories

List categories on a node Apply a category to a node Get category-related actions for a node

v1-nodes-{id}-content

Get content Get content with a specified filename

v1-nodes-{id}-thumbnails-{size}

Get thumbnail info according to size Get thumbnail content according to size

v1-nodes-{id}-thumbnails

Get thumbnail info

v1-nodes-{id}-versions-{version_number}-content

Download version Download version in specified name

v1-nodes-{id}-versions-{version_number}-thumbnails-{thumbnail_type}

Get info on the specified size of a version thumbnail Download 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 version Update version Delete version Get actions for a version Get categories for specified version

v1-nodes-{id}-versions

List versions Add version Get latest version

v1-nodes-{id}-output

Get output for a WebReport Run a WebReport that has a destination type other than 'browser' or 'desktop'

Get a node Update a node | Move a node | Change the Versions Control setting for a Folder Delete a node Get actions Get info on addable node types Get ancestors Get audit Get columns Get facets Get subnodes Get destination data for a WebReport

Create node | Copy a node

v1-forms-nodes-categories

Alpaca form for creating a category on a node Alpaca form for updating a category on a node

v1-forms-nodes-properties

Alpaca form detailing the general properties of a node Alpaca form detailing the specific properties of a node

v1-forms-nodes-versions-properties

Alpaca form detailing the general properties of a version Alpaca form detailing the specific properties of a version

v1-forms-nodes-versions

Alpaca form for displaying the categories on a version Alpaca form for creating a version on a node Alpaca form for updating a version on a node

Alpaca form for copying a node Alpaca form for creating a node Alpaca form for filing a node Alpaca form for moving a node Alpaca form for renaming node Alpaca form for running a WebReport Alpaca form(s) for updating a node

Alpaca forms detailing the specific properties of a workflow Alpaca forms detailing the specific properties of a workflow Alpaca form for a user

v1-members-{id}

Get user info | Get group info Update user | Update group Delete user | Delete Group Get profile photo

Search for user | Search for group Create group | Create user

v1-validation/nodes

Check a list of names Check for enforced required attributes Check for name collisions

v1-volumes-{type}

Get volume info Get subnodes of the specified volume

Get available volumes

v1-webreports/{nickname}

Get output for a WebReport Run a WebReport that has a destination type other than 'browser' or 'desktop'Get parameters info

Get API Info Bulk node actions Insertable Properties Get CS and REST API Info Get Current Regions Info Get Current Slices Info Categories tab TKL Attribute Valid Values

v2-nodes-{id}-categories-{category_id}-inheritance

Enable category inheritance for the node's children Disable category inheritance for the node's children

v2-nodes-{id}-categories-{category_id}

Get category info for a node Update a category on a node Remove a category from a node

v2-nodes-{id}-categories

List categories on a node Apply a category to a node Upgrade categories on a node

v2-nodes-{id}-content

Get content Get content with a specified filename

v2-nodes-{id}-releases

List releases and revisions Create release

v2-nodes-{id}-permissions-owner

Get owner permissions Update or Restore the owner permissions

v2-nodes-{id}-permissions-group

Get owner group permissions Update or Restore the owner group permissions

v2-nodes-{id}-permissions-public

Get public access permissions Update the public access permissions

v2-nodes-{id}-permissions-custom

Add an Assigned Access permission Update an Assigned Access permission for the specified user/group

v2-nodes-{id}-permissions

Get all node permissions Get the effective permissions for the specified user/group

v2-nodes-{id}-versions-{version_number}-renditions

List/Get rendition(s) for a specified version Replace rendition Delete rendition Download rendition

v2-nodes-{id}-versions-{version_number}

Get specified version Update version Delete version Get categories for specified version Promote version Lock version Unlock version

v2-nodes-{id}-versions-renditions

List all renditions for all available versions Add rendition

v2-nodes-{id}-versions

List versions Add version Purge versions

Get a node | Get a virtual folder Update a node | Move a node | Change the Versions Control setting for a Folder | Reserve/Unreserve a node | Collect/Uncollect a node Delete a node Update a node's nickname Get audit Update collection List the templates Get subnodes Get node properties Create revision Update System Attributes

v2-nodes-actions

Get actions Get actions

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 group Add members to a group Remove members from a group

v2-members-{id}

Get user info | Get group info Update user | Update group Delete user | Delete group

v2-members-favorites-tabs-{id}

Update a Favorites Tab Remove a Favorites Tab Get Favorites in a Tab

v2-members-favorites-tabs

Get Favorites Tab Add a Favorites Tab Get unsorted Favorites

v2-members-favorites-{id}

Add a Favorite Update a Favorite Remove a Favorite

v2-members-favorites

Search for user | Search for group Create user | Create group Search for groups where currently logged in user is a member Get recently accessed list Get recent targets Get assignments Get Reserved Items

v2-notifications/interests/nodes/{id}

Get the notification interests on a node Set the notification interests on a node

v2-processes-{process_id}-subprocesses/{subprocess_id}

Sends on a process Reads workflow activities

v2-processes-{process_id}

Deletes the process Changes the process status

Initiates a workflow Loads the workflow map definition

v2-search-template-settings/display

Get Display Options from the user's default template Sets Display Options from the user's default template

v2-search-template

Sets the display options for the specified template ID

Returns search results Returns search results Get information on available search Slices, Personal Search Forms, recent Search Forms, and System Search Forms for the user

Get available volumes Get volume info Get subnodes of the specified volume

Creates a Instance for Document Template Export System Settings to a report file List facets on a node Alpaca Forms for instance creation from template Autofile a document Get a node by nickname Personalize particular perspective for specific user Default Values of child TKL attributes Import admin settings from an XML file

Content Metadata Service API

categories-{id}

get category by id update category details patch category details

List all the categories Create a new category get category by name

groups-{groupId}-members-{groupMemberId}

Get group member details Remove member from group

groups-{groupId}-members

Get group membership Update group membership Add a new group member Remove all members from group

groups-{groupId}

Get group details Update group Delete group Patch group

List all groups Create a new group

instances-{category}/{type}-{id}-linked-parents-{folderId}

Get linked parent details Delete linked parent

instances-{category}/{type}-{id}-linked-parents

List linked parents Add linked parent to an object

instances-{category}/{type}-{id}-acl

Get ACL associated with object instance Change ACL associated with object instance Update permits for an ACL associated with an object

instances-{category}/{type}-{id}-parent

Get parent instance details Change parent for object instance

instances-{category}/{type}-{id}-policies-{RetentionId}

Get a policy of an object Update qualification date, base_date or policy replacement of an item policy Delete policy for an object

instances-{category}/{type}-{id}-policies

List all policies of an object Attach a policy to an object

instances-{category}/{type}-{id}-holds

List all holds of an object Attach a hold to an object

instances-{category}/{type}-{id}-hold/{RetentionId}

Get a hold of an object Replace existing hold to be a new hold Delete hold for an object

instances-{category}/{type}-{id}-case-node/{caseNodeId}

Get case instance details Create case instance child List case role groups

instances-{category}/{type}-{id}

Get object instance details Update instance details Delete object instance Update instance details Copy an object instance Get effective permissions of the object Request instance to send to search Get history of changes on an object instance Get relations based on source relation type Get relations based on target relation type

instances-{category}/{type}

List object instances Create new instance

instances-file/{type}/{id}-lock

Lock the file instance Delete the lock on a file

instances-file/{type}/{id}-contents-{renditionId}

Get rendition detail of the file Update a rendition Delete rendition Patch file rendition

instances-file/{type}/{id}-contents

List all renditions associated with a file Add new rendition to file Replace existing rendition of file

instances-file/{type}/{id}

Delete all versions of an object Check if user privilege to download the content associated with file type Make current to latest version List all versions of the file Check in as next version Check in as current version

instances-case/{type}

Create case instance Get case node instance children

instances-folder/{type}/{id}-items

List object instances under the folder Create object instances under the folder

instances-folder/{type}/{id}

Get the count of immediate children in the folder

Add history of changes on an object instance

localizations-{id}

Get localization details Update localization details Delete localization

List all localizations Update all localizations Create a new localization Delete all localizations

Get bundle Delete bundle

bundles-{bundleId}/deployments

Get all bundles Install bundle into tenant Delete bundle deployment

Get all bundles Create bundle using zip file or json

permissions-{id}

Get permission details Update permission details Delete permission Patch permission details

List all the permissions Create a new permission

retention-itemPolicy

For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filters For backward compatibility, it is old API for setting all item objects for null qualification date and base date on given policy id

List all CMS objects with policies or holds based on the filters Set all item objects for null qualification date and base date on given policy id Remove same hold id for all CMS objects Dispose a list of CMS objects which is from RPS approval list For 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 details Update type attribute details Delete type attribute

type-definitions-{typeName}-attributes

List all the attributes associated with a type Create new type attribute

type-definitions-{typeName}-index-definitions-{indexId}

Get type index definition details Update type index definition details Delete type index definition details

type-definitions-{typeName}-index-definitions

List all the index definitions associated with a type Create new type index definition

type-definitions-{typeName}-required-traits-{requiredTraitId}

Get required trait details Delete the required trait definition

type-definitions-{typeName}-required-traits

Get list of all the required traits associated with the type definitions Associate a new required trait with a type definition

type-definitions-{typeName}-policies

Get list of retention policies from a type-definition Updating type definition with one or more new policies Delete one or more type-definitions policy provided in request body

type-definitions-{typeName}

Get type definition details Update type definition Delete type definition Patch to update/activate/deactivate type definition Get type and inherited types attributes details Return true if type has at least one instance, false otherwise

type-definitions

List all type definitions Get history of changes on type definition Create a new custom type definition for the given category

trait-definitions-{systemName}-attributes-{attributeId}

Get trait attribute details Update trait attribute details Delete trait attribute

trait-definitions-{systemName}-attributes

List all the attributes associated with a trait Create new trait attribute

trait-definitions-{systemName}-index-definitions-{indexId}

Get trait index definition details Update trait index definition details Delete trait index definition details

trait-definitions-{systemName}-index-definitions

List all the index definitions associated with a trait Create new index definition for trait

trait-definitions-{systemName}-acl

Get the permits of the trait definition Patch the permits of the trait definition

trait-definitions-{systemName}-instanceAcl

Get trait instance acl of the trait definition Delete instance acl of trait definition Grant or revoke trait instance acl permits

trait-definitions-{systemName}

Get trait definition details Update trait definition Delete trait definition Patch/activate/deactivate trait definition Return true if trait has at least one instance, false otherwise

trait-definitions

Get list of all trait definitions available Create a new custom trait definition Get history of changes on trait definition

case-type-definitions-{id}

Get case model by case model id Update case model by case model id Delete case model by case model id Return true if case model has at least one instance, false otherwise

case-type-definitions

List case models Create a new case model

case-case-nodes/{id}

Get case node details by case node id Update case node by id Delete case node by id Get case node parent details

namespaces-{namespaceId}

Get namespace details Update a namespace Delete a namespace Update a namespace by patch. Deactivate and activate a namespace by changing active attribute

Get list of namespaces Create a new namespace

shared-links-{id}

Get shared link details Update shared link details Patch shared link details Delete shared link

Creates a new shared link List all the shared links

List all service endpoints Execute full text search against search service Create Zip request to have files content be zipped

Core Viewing Viewer Service

Return all available viewers Loads the named `viewer`

Return the service root Return the service version information Return the service health check

Magellan Risk Guard

Process documents/images for extraction/identification of PII, PSI and threat/risk Get version of Risk Guard Service

Active Documents Visibility REST Services

entitlementServices/v1/companies/{companyId}

Get available and entitled mailboxes Get list of available partner companies references Get entitled Trading Addresses

visibilityServices/v1-documentLifecycles

Visibility - Get document lifecycle Visibility - Get business related lifecycles

visibilityServices/v1

Get list of key names Visibility - Get envelope lifecycles Visibility - Get file lifecycles

The LiveSite Content Services (LSCS) REST API Documentation

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.

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.

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)

Fetch import history Import a package that was previously exported

api/v1-links/{domain}-multiple

Create multiple resource links Delete multiple resource links

api/v1-links/{domain}

Fetch links to/from a resource Create a resource link Delete a resource link Fetch resources that are linked to/from another resource

api/v1-resources/{domain}-{id}-content-{type}

Get additional resource content Update additional resource content

api/v1-resources/{domain}-{id}-content

Fetch resource content Update resource content

api/v1-resources/{domain}-{id}-lock

Lock resource Unlock resource

api/v1-resources/{domain}-{id}

Fetch resource information Upate resource information Delete a resource Disassociate (demote) resource from a domain Hide resource Associate (promote) resource to a domain Revert to an older resource version Show/Unhide resource Update the workflow state of a resource

api/v1-resources/{domain}

Fetch resources Create a new resource Create resource from file Fetch the history information of a resource

api/v1-themes/{domain}-{themeId}

Fetch theme Fetch theme with options payload Update theme Update a theme to be based on the latest approved version of its template

api/v1-themes/{domain}

Export a resource and its references into a ZIP file

OpenText Core Signature API

brandings-{uuid}

Retrieve a Branding customization Update a Branding customization Partially update a Branding customization Delete a Branding customization

Retrieve a list of Branding customizations Create a Branding customization

defaults/signing-flow-customizations-{uuid}

Retrieve a Signing Flow customization Update a Signing Flow customization Partially update a Signing Flow customization Delete a Signing Flow customization

defaults/signing-flow-customizations

Retrieve a list of Signing Flow customizations Create a Signing Flow customization

document-attachments-{uuid}

Retrieve a Document Attachment Delete a Document Attachment

document-attachments

Retrieve a list of Document Attachments Create a Document Attachment

documents-{uuid}

Retrieve a Document Delete a Document

Retrieve a list of Documents Create a Document

Retrieve a list of Events Retrieve an Event

signature-requests-{uuid}

Retrieve a signature request Cancel a signature request Resend a signature request

signature-requests

Retrieve a list of signature requests Create a signature request

templates-{uuid}

Retrieve a Template Delete a Template

Retrieve a list of Templates Create a Template

webhooks-{uuid}

Retrieve a Webhook Update a Webhook Partially update a Webhook Delete a Webhook

Retrieve a list of Webhooks Create a Webhook

Retrieve a list of allowed file types for upload Search documents Quick create a signature request

OpenText Messaging Email REST API

mra/v1/outbound/emails

Submit a email request Get Email status

OpenText Connected Workspaces REST API

v1-businessworkspacetypes/{workspace_type_id}

Get business workspace type Get widgets of business workspace type

v1-externalsystems/{ext_system_id}

Get workspace node ID Create document in workspace

Get business workspace root Get business workspace types

Create business workspace template

Authenticate user Get business workspace

v2-businessworkspaces-{bw_id}-relateditems

Get related items of business workspace Add relation to the business workspace Delete relation of a business workspace

v2-businessworkspaces-{bw_id}-icons

Add icon to business workspace Update icon of business workspace Delete icon of business workspace.

v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}

Get member of role Delete member of role

v2-businessworkspaces-{bw_id}-roles-{role_id}-members

Get members of role Add member to role

v2-businessworkspaces-{bw_id}-roles-{role_id}

Get role of business workspace Update role of business workspace Delete role of business workspace

v2-businessworkspaces-{bw_id}-roles

Get roles of a business workspace Add role to business workspace

v2-businessworkspaces-{bw_id}

Get business workspace Search for business workspaces to link

v2-businessworkspaces

Search for business workspaces Create business workspace

Get business object search form Get business workspace create form

Search for business object types Get business objects Get business workspace types Get configured volumes Generate reference number Get picker info

Core Transformation Publication Service

publications-{id}-artifacts-content

Return published artifacts Return published artifact variants

publications-{id}-artifacts

Return available artifact descriptors Returns artifact descriptor for the named artifact Returns artifact descriptor for the named artifact

publications-{id}

Return a publication Removes a publication

Create a new publication Returns all publications

Return the service root Return the service version information Return the service health check

Community Provisioning Services REST API's

v2/onboarding/tradingPartnerProvisionings

Create Trading Partner Provisioning Get 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.

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.

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 address Retrieves 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.

Creates an order by processing a cart.

Gets orders by vendor order code.

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 model Retrieve process model content

designtime/models

Get non-executable process models Create a non-executable process model

Convert process model content from json to xml or vice versa Validate process model content

process-instances-adhoc-subprocesses/{adhocSubprocessId}-activities

List of enabled activities for adhoc sub process Execute activities in adhoc sub process

process-instances-adhoc-subprocesses/{adhocSubprocessId}

Complete adhoc sub process

process-instances-administration/failedasync-jobs

List failed async jobs Recover failed async job

process-instances-executions

List of executions for a process instance List 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 instance Get a comment on a process instance

process-instances-{processInstanceId}-comments

Get comments on a process instance Create new comment on a process instance

process-instances-{processInstanceId}-variables-{variableName}

Delete a variable on a process instance Get a variable for a process instance Update a single variable on a process instance

process-instances-{processInstanceId}-variables

List variables for a process instance Create variables on a process instance

process-instances-{processInstanceId}

Delete a process instance Get a process instance Activate or suspend a process instance List of adhoc sub processes for a process instance Get diagram for a process instance Inject activity in a process instance

process-instances

List process instances Create a process instance Broadcast signal to create process instances

Get executable process models Create a new executable process model Retrieve executable process model content Delete an executable process model

tasks-{taskId}-assignments

Delete assignments on a task Get an assignments for a task Create an assignment on a task Update an assignment on a task

tasks-{taskId}-attachments-{attachmentId}

Delete an attachment on a task Get an attachment on a task

tasks-{taskId}-attachments

List attachments on a task Create a new attachment on a task.

tasks-{taskId}-comments-{commentId}

Delete a comment on a task Get a comment on a task

tasks-{taskId}-comments

Get comments on a task Create a new comment on a task

tasks-{taskId}-variables-{variableName}

Delete a variable on a task Get a variable for a task Update a single variable on a task

tasks-{taskId}-variables

List variables for a task Create variables on a task

Get a task Act on a task Update a task

Get tasks Create a sub task

Get workflow version information

OpenText Messaging SMS REST API

mra/v1/outbound/sms

Submit SMS request Get SMS status

Content Storage Service API

v2-tenant/{tenantId}

Upload content for a tenant Get total storage used for a tenant

v2-content-{id}-publicShareUrl-{urlId}

Delete a sharable link Update a sharable link Retrieve sharable link object

v2-content-{id}-publicShareUrl

Create a new sharable-link for download

v2-content-{id}

Get details of a specific content Download content

Tenant user upload content

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 type Get widgets of business workspace type

Get business workspace root Get business workspace types

Create business workspace template

Authenticate user Get business workspace

v2-businessworkspaces-{bw_id}-relateditems

Get related items of business workspace Add relation to the business workspace Delete relation of a business workspace

v2-businessworkspaces-{bw_id}-icons

Add widget icon to business workspace Update icon of business workspace Delete widget icon of business workspace.

v2-businessworkspaces-{bw_id}-roles-{role_id}-members-{member_id}

Get member of role Delete member of role

v2-businessworkspaces-{bw_id}-roles-{role_id}-members

Get members of role Add member to role

v2-businessworkspaces-{bw_id}-roles-{role_id}

Get role of business workspace Update role of business workspace Delete role of business workspace

v2-businessworkspaces-{bw_id}-roles

Get roles of a business workspace Add role to business workspace

v2-businessworkspaces-{bw_id}

Get business workspace Search for business workspaces to link

v2-businessworkspaces

Search for business workspaces Create business workspace

v2-forms/businessworkspaces

Get business workspace create form Get business workspace metadata update form

Get business workspace types Get configured volumes Generate reference number Get picker info

Core Case Administration API

api/v1/case-definitions-{caseDefinitionId}-stages

Create a new lifecycle stage Add a lifecycle task to a stage

api/v1/case-definitions-{caseDefinitionId}

Create a custom attribute Update a case type general setting Publish a case definition

api/v1/case-definitions

Create a case definition with default attributes.

Cartographer Api Endpoints

Add map version Map comments Reserve map Get map reservation info Un-reserve map Get tuples

Download map Get map versions

Map details Get maps Get solutions

xref/xrefselfserveapp/rest/xrefSelfServeExternalApi/v1

Get Xref Table details Get Xref Tables

Search Visibility Transactions

OpenText Messaging Push REST API

Submit a file to a Parser

Workflow Job REST API

external-jobs-{jobId}

Get a single external worker job Complete an external worker job Complete an external worker job with an error Fail an external worker job

List external worker jobs Acquire external worker jobs

timer-jobs-{jobId}

Get a timer job Move a timer job Update a timer job Delete a timer job

List timer jobs

Core Case Application API

api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-documents

Get case documents Add documents to case instance Remove documents from case instance

api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}-comments

Get comments on case Add comments on case Delete comments on case

api/v1-case-definitions/{caseDefinitionId}/cases-{caseId}

Delete a case Assign, claim, revoke, cancel, or resolve a case Get case details which includes lifecycle stages, tasks etc Edit Case Data including default attributes, custom attributes and input forms Get Input forms

api/v1-case-definitions/{caseDefinitionId}/cases

Create a new case using the caseDefinitionId

List cases with paging and sorting List User Cases

Password Management Services REST API's

v1/accounts/credentials

Initiate Reset Credential Reset Credentials Get Credentials reset request details by Id

Workflow History REST API

historic-process-instances

List historic process instances Get a historic process instance

historic-task-instances

List historic task instances Get a historic task instance

List process activity instances audit log List historic activity instances List process instances audit log List process task instances audit log Get workflow version information

Core Capture Services

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.

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 Service Classify Service.Classify Extract Page Service.Classify Extract Document Service.Extract Page Service.Extract Document Service.UIMData Service.Process Image Pipeline Service.Learning Service

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 request Get fax status

mra/v1-inbound/documents

Retrieve a fax document Delete a fax document

TGCommunity Services REST API's

v1/companies-{companyId}-users-{userId}

Retrieve User Update User Delete User

v1/companies-{companyId}-users-{userLoginId}/roles

Retrieve User Roles Update User Roles

v1/companies-{companyId}-users

Search Users Create User

v1/companies-{companyId}

Retrieve Company Search trading community

Content Server Rest API

Get Current User Info Authenticate user

v1-nodes-{id}-categories-{category_id}

Get category info for a node Update a category on a node Remove a category from a node Get category-related actions for a category on a node

v1-nodes-{id}-categories

List categories on a node Apply a category to a node Get category-related actions for a node

v1-nodes-{id}-content

Get content Get content with a specified filename

v1-nodes-{id}-thumbnails-{size}

Get thumbnail info according to size Get thumbnail content according to size

v1-nodes-{id}-thumbnails

Get thumbnail info

v1-nodes-{id}-versions-{version_number}-content

Download version Download version in specified name

v1-nodes-{id}-versions-{version_number}-thumbnails-{thumbnail_type}

Get info on the specified size of a version thumbnail Download 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 version Update version Delete version Get actions for a version Get categories for specified version

v1-nodes-{id}-versions

List versions Add version Get latest version

v1-nodes-{id}-output

Get output for a WebReport Run a WebReport that has a destination type other than 'browser' or 'desktop'

Get a node Update a node | Move a node | Change the Versions Control setting for a Folder Delete a node Get actions Get info on addable node types Get ancestors Get audit Get columns Get facets Get subnodes Get destination data for a WebReport

Create node | Copy a node

v1-forms-nodes-categories

Alpaca form for creating a category on a node Alpaca form for updating a category on a node

v1-forms-nodes-properties

Alpaca form detailing the general properties of a node Alpaca form detailing the specific properties of a node

v1-forms-nodes-versions-properties

Alpaca form detailing the general properties of a version Alpaca form detailing the specific properties of a version

v1-forms-nodes-versions

Alpaca form for displaying the categories on a version Alpaca form for creating a version on a node Alpaca form for updating a version on a node

Alpaca form for copying a node Alpaca form for creating a node Alpaca form for filing a node Alpaca form for moving a node Alpaca form for renaming node Alpaca form for running a WebReport Alpaca form(s) for updating a node

Alpaca forms detailing the specific properties of a workflow Alpaca forms detailing the specific properties of a workflow Alpaca form for a user

v1-members-{id}

Get user info | Get group info Update user | Update group Delete user | Delete Group Get profile photo

Search for user | Search for group Create group | Create user

v1-validation/nodes

Check a list of names Check for enforced required attributes Check for name collisions

v1-volumes-{type}

Get volume info Get subnodes of the specified volume

Get available volumes

v1-webreports/{nickname}

Get output for a WebReport Run a WebReport that has a destination type other than 'browser' or 'desktop'Get parameters info

Get API Info Bulk node actions Insertable Properties Get CS and REST API Info Get Current Regions Info Get Current Slices Info Categories tab TKL Attribute Valid Values

v2-nodes-{id}-categories-{category_id}-inheritance

Enable category inheritance for the node's children Disable category inheritance for the node's children

v2-nodes-{id}-categories-{category_id}

Get category info for a node Update a category on a node Remove a category from a node

v2-nodes-{id}-categories

List categories on a node Apply a category to a node Upgrade categories on a node

v2-nodes-{id}-content

Get content Get content with a specified filename

v2-nodes-{id}-releases

List releases and revisions Create release

v2-nodes-{id}-permissions-owner

Get owner permissions Update or Restore the owner permissions

v2-nodes-{id}-permissions-group

Get owner group permissions Update or Restore the owner group permissions

v2-nodes-{id}-permissions-public

Get public access permissions Update the public access permissions

v2-nodes-{id}-permissions-custom

Add an Assigned Access permission Update an Assigned Access permission for the specified user/group

v2-nodes-{id}-permissions

Get all node permissions Get the effective permissions for the specified user/group

v2-nodes-{id}-versions-{version_number}-renditions

List/Get rendition(s) for a specified version Replace rendition Delete rendition Download rendition

v2-nodes-{id}-versions-{version_number}

Get specified version Update version Delete version Get categories for specified version Promote version Lock version Unlock version

v2-nodes-{id}-versions-renditions

List all renditions for all available versions Add rendition

v2-nodes-{id}-versions

List versions Add version Purge versions

Get a node | Get a virtual folder Update a node | Move a node | Change the Versions Control setting for a Folder | Reserve/Unreserve a node | Collect/Uncollect a node Delete a node Update a node's nickname Get audit Update collection List the templates Get subnodes Get node properties Create revision Update System Attributes

v2-nodes-actions

Get actions Get actions

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 group Add members to a group Remove members from a group

v2-members-{id}

Get user info | Get group info Update user | Update group Delete user | Delete group

v2-members-favorites-tabs-{id}

Update a Favorites Tab Remove a Favorites Tab Get Favorites in a Tab

v2-members-favorites-tabs

Get Favorites Tab Add a Favorites Tab Get unsorted Favorites

v2-members-favorites-{id}

Add a Favorite Update a Favorite Remove a Favorite

v2-members-favorites

Search for user | Search for group Create user | Create group Search for groups where currently logged in user is a member Get recently accessed list Get recent targets Get assignments Get Reserved Items

v2-notifications/interests/nodes/{id}

Get the notification interests on a node Set the notification interests on a node

v2-processes-{process_id}-subprocesses/{subprocess_id}

Sends on a process Reads workflow activities

v2-processes-{process_id}

Deletes the process Changes the process status

Initiates a workflow Loads the workflow map definition

v2-search-template-settings/display

Get Display Options from the user's default template Sets Display Options from the user's default template

v2-search-template

Sets the display options for the specified template ID

Returns search results Returns search results Get information on available search Slices, Personal Search Forms, recent Search Forms, and System Search Forms for the user

Get available volumes Get volume info Get subnodes of the specified volume

Creates a Instance for Document Template Export System Settings to a report file List facets on a node Alpaca Forms for instance creation from template Autofile a document Get a node by nickname Personalize particular perspective for specific user Default Values of child TKL attributes Import admin settings from an XML file

Content Metadata Service API

categories-{id}

get category by id update category details patch category details

List all the categories Create a new category get category by name

groups-{groupId}-members-{groupMemberId}

Get group member details Remove member from group

groups-{groupId}-members

Get group membership Update group membership Add a new group member Remove all members from group

groups-{groupId}

Get group details Update group Delete group Patch group

List all groups Create a new group

instances-{category}/{type}-{id}-linked-parents-{folderId}

Get linked parent details Delete linked parent

instances-{category}/{type}-{id}-linked-parents

List linked parents Add linked parent to an object

instances-{category}/{type}-{id}-acl

Get ACL associated with object instance Change ACL associated with object instance Update permits for an ACL associated with an object

instances-{category}/{type}-{id}-parent

Get parent instance details Change parent for object instance

instances-{category}/{type}-{id}-policies-{RetentionId}

Get a policy of an object Update qualification date, base_date or policy replacement of an item policy Delete policy for an object

instances-{category}/{type}-{id}-policies

List all policies of an object Attach a policy to an object

instances-{category}/{type}-{id}-holds

List all holds of an object Attach a hold to an object

instances-{category}/{type}-{id}-hold/{RetentionId}

Get a hold of an object Replace existing hold to be a new hold Delete hold for an object

instances-{category}/{type}-{id}-case-node/{caseNodeId}

Get case instance details Create case instance child List case role groups

instances-{category}/{type}-{id}

Get object instance details Update instance details Delete object instance Update instance details Copy an object instance Get effective permissions of the object Request instance to send to search Get history of changes on an object instance Get relations based on source relation type Get relations based on target relation type

instances-{category}/{type}

List object instances Create new instance

instances-file/{type}/{id}-lock

Lock the file instance Delete the lock on a file

instances-file/{type}/{id}-contents-{renditionId}

Get rendition detail of the file Update a rendition Delete rendition Patch file rendition

instances-file/{type}/{id}-contents

List all renditions associated with a file Add new rendition to file Replace existing rendition of file

instances-file/{type}/{id}

Delete all versions of an object Check if user privilege to download the content associated with file type Make current to latest version List all versions of the file Check in as next version Check in as current version

instances-case/{type}

Create case instance Get case node instance children

instances-folder/{type}/{id}-items

List object instances under the folder Create object instances under the folder

instances-folder/{type}/{id}

Get the count of immediate children in the folder

Add history of changes on an object instance

localizations-{id}

Get localization details Update localization details Delete localization

List all localizations Update all localizations Create a new localization Delete all localizations

Get bundle Delete bundle

bundles-{bundleId}/deployments

Get all bundles Install bundle into tenant Delete bundle deployment

Get all bundles Create bundle using zip file or json

permissions-{id}

Get permission details Update permission details Delete permission Patch permission details

List all the permissions Create a new permission

retention-itemPolicy

For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filters For backward compatibility, it is old API for setting all item objects for null qualification date and base date on given policy id

List all CMS objects with policies or holds based on the filters Set all item objects for null qualification date and base date on given policy id Remove same hold id for all CMS objects Dispose a list of CMS objects which is from RPS approval list For 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 details Update type attribute details Delete type attribute

type-definitions-{typeName}-attributes

List all the attributes associated with a type Create new type attribute

type-definitions-{typeName}-index-definitions-{indexId}

Get type index definition details Update type index definition details Delete type index definition details

type-definitions-{typeName}-index-definitions

List all the index definitions associated with a type Create new type index definition

type-definitions-{typeName}-required-traits-{requiredTraitId}

Get required trait details Delete the required trait definition

type-definitions-{typeName}-required-traits

Get list of all the required traits associated with the type definitions Associate a new required trait with a type definition

type-definitions-{typeName}-policies

Get list of retention policies from a type-definition Updating type definition with one or more new policies Delete one or more type-definitions policy provided in request body

type-definitions-{typeName}

Get type definition details Update type definition Delete type definition Patch to update/activate/deactivate type definition Get type and inherited types attributes details Return true if type has at least one instance, false otherwise

type-definitions

List all type definitions Get history of changes on type definition Create a new custom type definition for the given category

trait-definitions-{systemName}-attributes-{attributeId}

Get trait attribute details Update trait attribute details Delete trait attribute

trait-definitions-{systemName}-attributes

List all the attributes associated with a trait Create new trait attribute

trait-definitions-{systemName}-index-definitions-{indexId}

Get trait index definition details Update trait index definition details Delete trait index definition details

trait-definitions-{systemName}-index-definitions

List all the index definitions associated with a trait Create new index definition for trait

trait-definitions-{systemName}-acl

Get the permits of the trait definition Patch the permits of the trait definition

trait-definitions-{systemName}-instanceAcl

Get trait instance acl of the trait definition Delete instance acl of trait definition Grant or revoke trait instance acl permits

trait-definitions-{systemName}

Get trait definition details Update trait definition Delete trait definition Patch/activate/deactivate trait definition Return true if trait has at least one instance, false otherwise

trait-definitions

Get list of all trait definitions available Create a new custom trait definition Get history of changes on trait definition

case-type-definitions-{id}

Get case model by case model id Update case model by case model id Delete case model by case model id Return true if case model has at least one instance, false otherwise

case-type-definitions

List case models Create a new case model

case-case-nodes/{id}

Get case node details by case node id Update case node by id Delete case node by id Get case node parent details

namespaces-{namespaceId}

Get namespace details Update a namespace Delete a namespace Update a namespace by patch. Deactivate and activate a namespace by changing active attribute

Get list of namespaces Create a new namespace

shared-links-{id}

Get shared link details Update shared link details Patch shared link details Delete shared link

Creates a new shared link List all the shared links

List all service endpoints Execute full text search against search service Create Zip request to have files content be zipped

Home OpenText Messaging Fax REST APImra/v1-outbound/faxes

mra/v1-outbound/faxes

Number of APIs: 2

Submit a fax request POST {{baseUrl}}/mra/v1/outbound/faxes
Get fax status GET {{baseUrl}}/mra/v1/outbound/faxes/status/?job_id=xsi-1234567

OpenText Messaging Fax REST API

Submit a fax request