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.


REST Service activity

Configure the REST Service activity

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

Examples

Prerequisites

  • An operational REST Service.

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Web Services tab.

    Open Web Services tab
  3. On the Web Services tab, drag the REST Service activity onto your process.

    Drag REST Service 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 REST Access Token icon.
  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 REST Configuration icon.
    3. Complete the fields on the Advanced REST Configuration screen.
  6. Click REST Request Payload REST Request Payload icon.
  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 the process schema.
      3. Click Map Schema.
      4. On the Schema Mapper screen, map the request columns to the schema elements.
  8. Click REST Response REST Response icon.
  9. Complete the fields on the REST Response Configuration screen.
  10. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the REST Service activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name
Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

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

REST Access Token Configuration

Specifies the access token or configure the REST service.

Figure: REST Access Token screen

REST Access Token screen

Fields

Field NameDefinition

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

Create Add Token icon
Opens this Screen:
Access Token for REST Service
Function of this Screen:
Configure an access token to connect to a REST service.
Example:
Refer to:

Advanced Configuration
Description:
Specifies if you want to do a detailed configuration of the REST service.
Allowed 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.

Figure: Advanced REST Configuration screen

Advanced REST Configuration screen

Fields

Field NameDefinition

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

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

Content Type
Description:
Specifies the type of content the REST service uses.

JSON or XML patch files are also supported to patch the document with the specified changes.

Allowed Values:
  • XML
  • JSON
  • x-www-form-urlencoded
Default Value:
JSON

Accept
Description:
Specifies the data format to accept in a REST service.
Allowed Values:
  • XML
  • JSON
  • Text
Default Value:
JSON
Limitations:

The Text option is available in these releases:

Protocol
Description:
Specifies the communication protocol for your REST service.
Allowed Values:
  • HTTP 1.0
  • HTTP 1.1
Default Value:
HTTP 1.0
Example:
Refer to:

Request Timeout (Seconds)
Description:
Specifies the maximum amount of time, in seconds, to complete the REST service call for the activity.
Allowed Values:
An integer.

Represents:

  • A number of seconds
Default Value:
600

Read/Write Timeout (Seconds)
Description:
Specifies the maximum amount of time, in seconds, for read and write methods.
Allowed Values:
An integer.

Represents:

  • A number of seconds
Default Value:
600

Continue Timeout (seconds)
Description:
Specifies the maximum amount of time, in seconds, to wait for a server response with the HTTP status 100-Continue. If this times out before a response is received, the request body is sent without a response from the server.
Allowed Values:
An integer.

Represents:

  • A number of seconds
Default Value:
600

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

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

Allowed Values:
  • Header
  • RunTime Value

Use the Create Create icon button to add the Header and RunTime Value for the REST service.

Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Create Create icon
Function:
Adds the row for Header and RunTime Value.

Delete Delete icon
Function:
Deletes a Header and RunTime Value row.

Plain Header
Description:
Specifies the header name and value to add in the Header and RunTime Value field.

Authentication
Opens this Screen:

Advanced REST Configuration > Authentication screen > Basic Authentication tab

Creates REST service authentication credentials to connect to a REST service URL with basic authentication.

Figure: Advanced REST Configuration > Authentication > Basic Authentication tab

Advanced REST Configuration Authentication Basic Authentication tab

Fields

Field NameDefinition

User Name
Description:
Specifies the user name for REST service authentication.
Allowed Values:
A valid user name.
Default Value:
None
Example:
Refer to:

Password
Description:
The password for the authentication account.
To Open this Field:
  1. On the SFTP Access Token screen, click Password Authentication.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Variables:
No

Authorization
Description:
Specifies an authorization value to connect to the REST service.
Allowed Values:
A valid authorization value.

When you click Generate button, this field completes.

Default Value:
None

Generate
Function:
Gives the authorization value to connect to the REST service.

Insert
Function:
Adds the authorization name and value in the Header and Value field.

Reset
Description:
Deletes the REST service authentication credentials.

Advanced REST Configuration > Authentication screen > OAuth 2.0 tab

Creates REST service authentication credentials to connect to a REST service URL with the OAuth 2.0 protocol.

Figure: Advanced REST Configuration > Authentication > OAuth 2.0 tab

Advanced REST Configuration Authentication OAuth 2 tab

Fields

Field NameDefinition

Token Type
Description:
Specifies the name of an external system, such as SharePoint, Google Drive, or Box from the list.
Allowed Values:
The name of an external system.
Default Value:
None

Token
Description:
Specifies the access token for the specified external system.
Allowed Values:
An access token from the list.
Default Value:
None.

When you select an external system from the Token Type field, the name of the access token for the specified system shows in this field.

Advanced REST Configuration > Authentication screen > Windows Authentication tab

Creates REST service authentication credentials to connect to a REST service URL with Windows Authentication (NTLM).

Figure: Advanced REST Configuration > Authentication screen > Windows Authentication tab

Advanced REST Configuration Authentication screen Windows Authentication tab

Prerequisites

Fields

Field NameDefinition

Domain
Description:
The domain for the REST service authentication.
Allowed Values:
A valid domain.
Default Value:
None

User Name
Description:
Specifies the user name for the REST service authentication.
Allowed Values:
A valid user name.
Default Value:
None

Password
Description:
The password for the authentication account.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Example:
Refer to:

REST Request Payload Configuration

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

Figure: REST Request PayLoad Configuration screen

REST Request PayLoad Configuration screen

Fields

Field NameDefinition

Payload
Description:
Specifies the payload to use when the process runs.
Allowed Values:
  • Custom Payload - Specifies a payload to use when the process runs. The payload must be in a valid JSON or XML format.
  • Map Payload with Schema - Connects the values in your payload with your AgilePoint process schema.
Default Value:
Custom Payload
Accepts Variables:
No
Example:
Refer to:

REST Response Configuration

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

Figure: REST Response Configuration screen

REST Response Configuration screen

Fields

Field NameDefinition

Response Status Code
Description:
Specifies the process data variable that stores the response status code, which tells status of the HTTP request.
Allowed Values:
A process data variable.
Default Value:
None
Accepts Variables:
Yes

Error Response
Description:
Specifies the process data variable that stores the HTTP response message, which tells the result of the request.
Allowed Values:
A process data variable.
Default Value:
None
Accepts Variables:
Yes

Save Response to Custom Attribute
Description:
Specifies the variable that stores the response to a method call. The method calls a REST service.
Allowed Values:
A process data variable.
Default Value:
None
Accepts Variables:
Yes

Map Response to Process Schema
Description:
Specifies if the REST service response connects to your process schema.
Allowed 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
Example:
Refer to:
Limitations:

Header (Optional)
Description:
Specifies the custom headers for the REST service
Allowed 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
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add Header Add Header icon
Function:
Adds the row for Schema and Header fields.

Delete Delete icon
Function:
Deletes the row with Schema and Header fields.

Payload
Description:
Specifies JSON or XML response payload to connect to the process schema.
Allowed Values:
  • XML
  • JSON
  • x-www-form-urlencoded
Default Value:
JSON

Sample JSON/XML
Description:
Specifies an example response payload to connect the process schema in JSON or XML format.
Allowed 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.

Ad Hoc 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 one at a time.

REST Response Configuration > Simulate

Configures the response settings with a simulated REST method call.

Figure: REST Response Configuration > Simulate screen

REST Response Configuration Simulate screen

Fields

Field NameDefinition

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

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

Header
Description:
Specifies the custom headers for the REST service
Allowed Values:
A valid header
Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Request Body
Description:
Specifies the request data.
Allowed Values:
A valid data.
Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

User Agent
Description:
Specifies the user agent for your REST service.

The user agent is a request header that the REST service can use to identify the app, operating system, and browser of the web server.

Allowed Values:
One line of text (a string) that can have letters, numbers, spaces, and special characters.
Default Value:
None
Limitations:

This field is available in these releases:

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
Description:
Shows the response message.
Allowed Values:
A valid response message.
Default Value:
None

Header
Description:
Shows the name and value of the header.
Allowed Values:
Read only.

REST Response Configuration > Ad Hoc Mapping

Configures the response settings one at a time.

Figure: REST Response Configuration > Ad Hoc Mapping screen

REST Response Configuration Ad Hoc Mapping screen

Fields

Field NameDefinition

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

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

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

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

Remove Response Field Remove Response Field icon
Function:
Deletes the row with the Process Field and Response Field XPath.