Process Activities / Web Services tab
Parent topic: Web Services tab

REST Service activity

An activity that calls a REST service method from an AgilePoint process. You can select and configure the method call by connecting to a REST service URI.



Configure the REST Service activity

To configure the REST Service activity, do the procedure in this topic.

Prerequisites

  • A valid REST Service.

Good to Know

How to Start

  1. On the Organizer, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Web Services tab.
      2. On the Web Services tab, drag the REST Service activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for Web Service.

  2. Click REST Access Token .
  3. On the REST Access Token screen, in the REST Service list, select your REST service access token.
  4. To connect to the REST service, in the REST Service list, select your REST service access token.
  5. (Optional) To do advanced configuration for the REST service, do this procedure.
    1. Select Advanced Configuration.
    2. Click REST Configuration .
    3. Complete the fields on the Advanced REST Configuration screen.
  6. Click REST Request Payload .
  7. On the REST Request Payload Configuration screen, do one of these:
    • To configure the custom payload details for the REST Service request, do this procedure.
      1. Select Custom Payload.
      2. Enter payload values in the box to use when the process runs. The values of the payload must be in JSON/XML format.
    • To map the PayLoad with Schema, do this procedure.
      1. Select Map Payload with Schema.
      2. In the box, enter the payload values which you want to map from process schema.
      3. Click Map Schema.
      4. On the Schema Mapper screen, map the request columns to the schema elements.
  8. Click REST Response .
  9. Complete the fields on the REST Response Configuration screen.
  10. (Optional) Click Advanced > E-mail Notification .

    For more information, refer to Configure E-mail Notifications for Any Activity

General Configuration

Specifies the common configuration settings for a REST service.



Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No

Description
Function:
Specifies an optional description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Connection Timeout (Seconds)
Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer that represents a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

REST Access Token Configuration

Specifies the access token or configure the REST service.



Fields

Field Name Definition

REST Service
Function:
Specifies the access token that connects to your REST service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
A process data variable based on the parameter name.

Add Token

Opens this Screen:
New REST Access Token
Function of this Screen:
Configures a new access token for a REST service.

Advanced Configuration
Function:
Specifies if you want to do a detailed configuration of the REST service.
Accepted Values:
  • Deselected - Does not do a detailed configuration of the REST service.
  • Selected - Does a detailed configuration of the REST service.
Default Value:
Deselected

Advanced REST Configuration

Specifies the advanced configuration options for your REST Service connection.



Fields

Field Name Definition

Request URL
Function:
Specifies the REST service URL for your method.
Accepted Values:
A valid REST service URL.
Default Value:
None

Action
Function:
Specifies the type of action for the REST service to do.
Accepted Values:
  • POST
  • GET
  • DELETE
  • PUT
Default Value:
GET

Content Type
Function:
Specifies the type of content the REST service uses.
Accepted Values:
  • JSON
  • Plain
Default Value:
JSON

Accept
Function:
Specifies the data format to accept in a REST service.
Accepted Values:
  • XML
  • JSON
Default Value:
JSON

Protocol
Function:
Specifies the communication protocol for your REST service.
Accepted Values:
  • HTTP 1.0
  • HTTP 1.1
Default Value:
None

Request Timeout (Seconds)
Function:
Specifies the maximum amount of time, in seconds, to complete the REST service call for the activity.
Accepted Values:
An integer that specifies a number of seconds.
Default Value:
60

Read/Write Timeout (Seconds)
Function:
Specifies the maximum amount of time, in seconds, for read and write methods.
Accepted Values:
An integer that specifies a number of seconds.
Default Value:
60

Header Information
Function:
Specifies the custom headers for the REST service.

Request headers are usually used to give security information, such as authentication credentials.

Accepted Values:
  • Header
  • RunTime Value
Default Value:
None

REST Request Payload Configuration

Configures the request payload for the REST service method call with the REST activity.



Fields

Field Name Definition

Custom Payload
Function:
Specifies a payload to use when the process runs. The payload must be in JSON/XML format.
Accepted Values:
  • Selected - Specifies payload values in the box.
  • Deselected - Connects the values of the payload with AgilePoint process schema.
Default Value:
None
Accepts Process Data Variables:
No

Map Payload with Schema
Function:
Connects the values in your payload with your AgilePoint process schema.
Accepted Values:
Click the Map Schema button to open the Schema Mapper screen. You can not map the schema if the REST service type is None.

Use this screen to connect the payload values to the AgilePoint process schema.

Default Value:
None

REST Response Configuration

Configures the response settings for a REST service method call with the REST activity.



Fields

Field Name Definition

Save Response to Custom Attribute
Function:
Specifies the variable that contains the response to a method call. The method calls a REST service.
Accepted Values:
A process data variable.

You can use Process Data screen to specify a process data variable.

Default Value:
None
Accepts Process Data Variables:
Yes

Map Response to Process Schema
Function:
Specifies if the REST service response connects to your process schema.
Accepted Values:
  • Enter Sample Response - Specifies sample response schema to connect to your process.
  • Get Response from Simulation - Specifies a response schema with a simulation.

Click Map to Schema button to open the Schema Mapper screen. Use this screen to connect the response to process schema. You can not map the schema if the REST service type is None.

Default Value:
None

Header (Optional)
Function:
Specifies the custom headers for the REST service
Accepted Values:
  • Schema - Specifies a process data variable to use for the custom header.
  • Header - Specifies a name of the custom header.
  • Value - Specifies a value to use for the custom header.

    Select Get Response from Simulation for Value field.

Default Value:
None

Add Header

Function:
Adds the row for Schema and Header fields.

Remove Header

Function:
Deletes the row with Schema and Header fields.

Payload
Function:
Specifies JSON or XML response payload to connect to the process schema.
Accepted Values:
  • XML
  • JSON
Default Value:
JSON

Sample JSON/XML
Function:
Specifies an example response payload to connect the process schema in JSON or XML format.
Accepted Values:
Sample payload data in XML or JSON format.
Default Value:
None

Map to Schema
Opens this Screen:
Schema Mapper screen
Function of this Screen:
Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..

Simulate
Opens this Screen:
REST Response Configuration > Simulate
To Open this Field:
  1. On the REST Response Configuration screen, click Get Response from Simulation.
Function of this Screen:
Configures the response settings with a simulated REST method call.

Adhoc Mapping
Opens this Screen:
REST Response Configuration > Ad Hoc Mapping
To Open this Field:
  1. On the REST Response Configuration screen, click Get Response from Simulation.
Function of this Screen:
Configures the response settings with a ad hoc mapping.

REST Response Configuration > Simulate

Configures the response settings with a simulated REST method call.



Fields

Field Name Definition

URL
Function:
Specifies the REST service URL for your method.
Accepted Values:
A valid REST service URL.
Default Value:
None

Action
Function:
Specifies the type of action for the REST service to do.
Accepted Values:
  • POST
  • GET
  • DELETE
  • PUT
Default Value:
GET

Header
Function:
Specifies the custom headers for the REST service
Accepted Values:
A valid header
Default Value:
None

Request Body
Function:
Specifies the request data.
Accepted Values:
A valid data.
Default Value:
None

Simulate
Opens this Screen:
Runs the REST service and shows the response message.

Save
Opens this Screen:
Saves the response message and goes back to the previous screen.

Response
Function:
Shows the response message.
Accepted Values:
A valid response message.
Default Value:
None

Header
Function:
Shows the name and value of the header.
Accepted Values:
Read only.

REST Response Configuration > Ad Hoc Mapping

Configures the response settings with a ad hoc mapping.



Fields

Field Name Definition

Process Field
Function:
Specifies a process data variable to use for process schema.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Response Field XPath
Function:
Specifies a name for the response.
Accepted Values:
  • A variable from the Rest Response box.
  • One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
Yes

Add Response Field

Function:
Adds a row for the Process Field and Response Field XPath.

Remove Response Field

Function:
Deletes the row with the Process Field and Response Field XPath.
Parent topic: Web Services tab

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.