IMaaS Workflow services

IMaaS Workflow services integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from OpenText Developer.

IMaaS Workflow services | OpenText Developer Cloud public resources Workspace | API documentation

Get a variable for a process instance

scope

SampleVariable

Indicates both the process instance and variable were found and variable is returned.

Get a variable for a process instance Workflow action and model services IMaaS Workflow services integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from OpenText Developer.

Get a variable for a process instance Workflow action and model services IMaaS Workflow services | OpenText Developer Cloud public resources Workspace | API documentation

Workflow action and model services-process-instances-{process Instance Id}-variables-{variable Name}

Workflow action and model services IMaaS Workflow services integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from OpenText Developer.

Workflow action and model services IMaaS Workflow services | OpenText Developer Cloud public resources Workspace | API documentation

The Home Document is an entry point to the Core Capture Services.

Provides product version information.

Returns a list of available tables for the given environment.

Returns the table identified by tableId for the given environment.

session-tables

Returns the list of available Document Types for the given environment.

Returns the Document Type identified by docType for the given environment.

session-doctypes

Retrieves the file identified by the fileId.

Appends or retries a stage file chunk.

Deletes a stage file.

session-files-{file Id}

Creates a stage file.

Deletes all stage files.

session-files

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

session-services

Retrieves the Session resource.

Deletes your session data.

Creates and exports a batch.

session

IMaaS Capture Services

List all service endpoints

Execute full text search against search service

get category by id

update category details

patch category details

categories-{id}

List all the categories

Create a new category

get category by name

Get group member details

delete group members

groups-{group Id}-members-{group Member Id}

Get group members details

Update group membership details

Add a new group member

Delete Group Member

groups-{group Id}-members

Get group details

Delete group

groups-{group Id}

List all groups

Create a new group

groups

Get linked parent details

Delete linked parent

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

List linked parents

Add linked parent to an object

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

get ACL associated with object instance

Change ACL action

Update permits for an ACL associated with an object

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

Get parent instance details

Change parent for object instance

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

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-{Retention Id}

List all policies of an object

Attach a policy to an object

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

List all holds of an object

Attach a hold to an object

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

Get a hold of an object

Replace existing hold to be a new hold

Delete hold for an object

instances-{category}/{type}-{id}-hold/{Retention Id}

Get case instance details

Create case instance child

List case role groups

instances-{category}/{type}-{id}-case-node/{case Node Id}

get object instance details

update instance details

delete object instance

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}-{id}

List object instances

create new instance

instances-{category}/{type}

Lock the file instance

Delete the lock on a file

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

get rendition detail of the file

Update a rendition

Delete rendition

Patch rendition

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

List all renditions associated with a file

Add new rendition to file

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

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-file/{type}/{id}

Create case instance

Get case node instances

instances-case/{type}

List object instances under the folder.

create object instances under the folder.

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

get localization details

update Localization details

Delete Localization

localizations-{id}

List all Localizations

update all localizations

Create a new Localization

Delete all localizations

localizations

Get bundle

Delete bundle

bundles-{id}

Get all bundles

Install bundle into tenant

Delete bundle deployment

bundles-{bundle Id}/deployments

Create bundle using zip file or json

bundles

get permission details

update permission details

Delete permission

patch permission details

permissions-{id}

List all the permissions

Create a new permission

permissions

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 on given policy id

retention-item Policy

List all CMS objects with policies or holds based on the filters

Set all item objects for null qualification 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

retention

Get case model by case model id

Update case model by case model id

Delete case model by case model id

case-type-definitions-{id}

List case models

Create a new case model

case-type-definitions

Get case node details by case node id

Update case node by id

Delete case node by id

Get case node parent details

case-case-nodes/{id}

Get trait attribute details

Update trait attribute details

Delete trait attribute

trait-definitions-{trait Name}-attributes-{attribute Id}

List all the attributes associated with a trait

create new trait attribute

trait-definitions-{trait Name}-attributes

Get trait index definition details

Update trait index definition details

Delete index definition details

trait-definitions-{trait Name}-index-definitions-{index Id}

List all the index definitions associated with a trait

create new index definition for trait

trait-definitions-{trait Name}-index-definitions

get trait definition details

update trait definition

trait-definitions-{trait Name}

IMaaS Content Metadata Service

The OpenText Developer cloud provides access to the <a href="https://developer.opentext.com/apis"> OpenText product and service APIs</a>

<a href="http://www.youtube.com/watch?feature=player_embedded&v=BDYZfLKhSIo
" target="_blank"><img src="http://img.youtube.com/vi/BDYZfLKhSIo/0.jpg" 
alt="Sample App How-To" width="360" height="180" border="10" /></a>

This Qodex collection focuses on our information services in the eight capabilities:

<ol>
<li>Analyze &amp; Report: <a href="https://developer.opentext.com/capability/edb3bec9-8355-4516-a530-8074f90cff0c/Analyze%20&%20Report">Prescriptive and predictive analytics and reporting capabilities</a></li>
<li>Capture &amp; Digitize:<a href="https://developer.opentext.com/capability/14a7dba4-c80f-440c-be04-3d6b8c0b53d1/Capture%20&%20Digitize">Multi-channel capture and advanced recognition capabilities</a></li>
<li>Manage &amp; Secure: <a href="https://developer.opentext.com/capability/3a7bfdae-4cd3-465c-8485-c887f65def9b/Manage%20&%20Secure">Manage and secure the cloud API service usage and deployment</a></li>
<li>Process &amp; Automate: <a href="https://developer.opentext.com/capability/523afd8e-0180-4500-91fa-713df27b8f19/Process%20&%20Automate">Dynamic case management and signature capabilities</a></li>
<li>Protect &amp; Secure: <a href="https://developer.opentext.com/capability/365cb38c-34d1-42e4-a7cf-beab2a6f8bb9/Protect%20&%20Secure">Information and end-point security and management capabilities</a></li>
<li>Search &amp; Discover: <a href="https://developer.opentext.com/capability/24d66681-fe14-4ea9-8231-3879cfd6c55b/Search%20&%20Discover">Enterprise federated search and electronic discovery capabilities</a></li>
<li>Store &amp; Manage |<a href="https://developer.opentext.com/capability/14ba85a7-4693-48d3-8c93-9214c663edd2/Store%20&%20Manage">Secure and flexible content services capabilities</a></li>
<li>View &amp; Communicate: <a href="https://developer.opentext.com/capability/69f18c6b-0b58-4509-8117-6bf022fd2e44/View%20&%20Communicate">Content customization / personalization and output management capabilities</a></li>
</ol>

The services that are included in these eight capabilities are part of our Information Management Services API these services are part of our new IMaaS offering. 
You can test our IMaaS offering for free by signing-up for a <a href="https://developer.opentext.com/plans/ot2-trial-signup">free trial</a>

OpenText Developer Cloud public resources

OpenText Developer Cloud public resources projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from OpenText Developer.

OpenText Developer APIs | OpenText Developer Cloud public resources API Integration | QodexAI API Network

Key	Datatype	Required	Description
scope	string