Workflow Rest Endpoints Tutorial

Removed from output and from searches pending re-write; needs more explanation and details of the actual workflow.

This tutorial creates a workflow (CLCommentFromExternal) that is published as a web service. It allows a third party system (MRI Evolution) to add a comment (CommentDescription) to an issue that is identified by the third party's reference (ExternalRef). The application's default language (AppDefaultLanguage) is supplied for language translations.

For basic configuration details see Workflow Rest Endpoints

Configuring the new workflow rest endpoint

View Parameters

The View Parameters button displays workflow inputs and outputs:

Service details

After saving the new workflow rest endpoint details, it appears in the list on the Workflow Rest Endpoint page.

REST details

To review the REST details, select the service and click Detail.

Token-based authentication: All requests to a MRI Dreamscape workflow web service must include a security token obtained by sending an HTTP POST request header with username and password like this:

http://workflowrest.<Domain>/ my company name/workflow/gettoken?userName=<username>&password=<password>

Workflow management page

The source workflow shows the Is Service flag set.

Note | If you unpublish a workflow that is the source of a workflow rest endpoint, and then republish it, the Is Service flag does not show set unless you open the workflow rest endpoint with its editor and save it (with no changes).