How to Start
- On the Organizer,
do one of these:
- Do one of these:
- Add an activity:
- In the Process Builder, in the Activity Library,
open the Web Services
tab.
- On the Web Services
tab,
drag the REST Service
activity onto your process.
- Change an activity:
- In your process, double-click your activity.
- Click Next.
- On the Rest Service field, click Add Token
.
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
|
Description
|
- Function:
- A description for your access token.
- Accepted Values:
- More than one line of text.
- Default Value:
- None
|
Service URL
|
- Function:
- Specifies the URL of your REST service.
- 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:
-
- Default Value:
- None
|
Content-Type
|
- Function:
- Specifies the type of content the REST service uses.
- Accepted Values:
-
- Default Value:
- None
|
Accept
|
- Function:
- Specifies the data format to accept in a REST service.
- Accepted Values:
-
- Default Value:
- None
|
Protocol
|
- Function:
- Specifies the communication protocol for your REST service.
- Accepted Values:
-
- Default Value:
- None
|
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:
-
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:
- Add REST Service Access Token > Authentication screen
- Function of this Screen:
- Creates REST service authentication
credentials with basic or OAuth 2.0 protocol to connect to a REST service URL.
|
Test Connection
|
- Function:
- Makes sure the specified REST service account is correct.
|
Encrypt
|
- Function:
- Holds the access token in the AgilePoint database as encrypted data.
- Accepted Values:
- Deselected - The access token is in plain text in the database.
- Selected - The access token is encrypted in the database.
- Default Value:
- Deselected
|
