Access Token for REST

Configure an access token to connect to a REST service.

Screen



Background and Setup

Examples

Good to Know

  • In most cases, you can use a global access token or an application level access token:
    • Global access tokens are shared across all users and applications. If you want all process designers and form users in your AgilePoint NX tenant to be able to connect to an external data source, use a global access token. An example is a SharePoint site on an intranet that all employees in a company can access.
    • Application level access tokens are shared with all processes in a process-based app, or restricted to use within a form-based app. Use application level access tokens if only process designers or form users for a particular application should access an external system — for example, a Google Drive account that is only used to share files within a small team.
  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

Fields

Field Name Definition

Token Name

Function:
Specifies the unique name for your connection to REST service.
Accepted Values:
A text string that can include letters, numbers, and spaces
Default Value:
None
Example:
Refer to:

Description

Function:
A description for your access token.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Service URL

Function:
Specifies the URL of your REST service.
Accepted Values:
A valid rest service URL.
Default Value:
None
Example:
Refer to:

Action

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

Content-Type

Function:
Specifies the type of content the REST service uses.
Accepted Values:
  • JSON
  • XML
Default Value:
None
Example:
Refer to:

Accept

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

Protocol

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

Request Timeout

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:
600

Read Write Timeout

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:
600

Request Headers

Function:
Specifies the custom headers necessary for the REST service.

Request headers contain application-specific information in the SOAP header. Request headers are usually used to give security information, such as authentication credentials.

Accepted Values:
  • Header
  • Value

Use the Add Header button to add the Header and Value for the web service.

Default Value:
None

Add Header

Function:
Adds the row for Header and Value fields.

Update

Function:
Changes the information in the Header and Value fields.

Cancel

Function:
Deletes the row with Header and Value fields.

Authentication

Opens this Screen:

Test Connection

Function:
Makes sure the specified REST service account is correct.

Encrypt

Function:
Stores the access token in the AgilePoint database as encrypted data.
Note: AgilePoint recommends you to store this access token in the database in encrypted format.
Accepted Values:
  • Deselected - The access token is in plain text in the database.
  • Selected - The access token is encrypted in the database.
Default Value:
Selected

Access Token for REST Service > Authentication screen > Basic Authentication tab

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

Screen



Fields

Field Name Definition

User Name

Function:
Specifies the user name for REST service authentication.
Accepted Values:
A valid user name.
Default Value:
None
Example:
Refer to:

Password

Function:
The password for the authentication account.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Authorization

Function:
Specifies an authorization value to connect to the REST service.
Accepted 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

Function:
Deletes the REST service authentication credentials.

Access Token for REST Service > Authentication screen > OAuth 2.0 tab

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

Screen



Fields

Field Name Definition

Select Token Type

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

Select Token

Function:
Specifies the access token for the specified external system.
Accepted Values:
An access token from the list.
Default Value:
None.

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