Skip to content

Bots From Extension: restclient

REST Client - Read, Write and invoke APIs using REST Client

This extension provides 5 bots.





Bot @restclient:invoke

Bot Position In Pipeline: Source Sink

Invoke APIs using REST Client. Input data is passed through to output.

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
url* Text The URL for getting the data
method Text post HTTP method to use. Example: post, put
payload_template* Text Name of the template where payload is stored.
encoding Text json Encoding for the payload: Options are json or urlencode
username Text The UserName for authentication
password Text The Password for authentication
credential_name Text Name of the predefined credential from the config
use_session Text Name of the previously saved session in this pipeline
save_session Text Name of session that needs to be stored in the context of current pipeline
verify Text no If HTTPS, verify SSL certificate. Values can be 'yes' or 'no'

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.







Bot @restclient:post-json

Bot Position In Pipeline: Sink

Post each input row as JSON data to the specified URL. The status and response data are added as addtional columns in the output dataframe

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
url* Text The URL for getting the data
secret_name Text Name of the secret from the vault
use_session Text Name of the previously saved session in this pipeline
save_session Text Name of session that needs to be stored in the context of current pipeline
verify Text no If HTTPS, verify SSL certificate. Values can be 'yes' or 'no'

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.







Bot @restclient:read

Bot Position In Pipeline: Source

Read data using REST Client

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
url* Text The URL for getting the data
method Text get HTTP method to use. Example: get, post, put
payload Text Payload to send along with POST or PUT. Must be a JSON formatted string.
encoding Text json Encoding for the payload: Options are json or urlencode
result_path Text The Path to look for JSON Objects in the result
username Text The UserName for authentication
password Text The Password for authentication
secret_name Text Name of the secret from the vault
use_session Text Name of the previously saved session in this pipeline
save_session Text Name of session that needs to be stored in the context of current pipeline
verify Text no If HTTPS, verify SSL certificate. Values can be 'yes' or 'no'

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.







Bot @restclient:read-bulk

Bot Position In Pipeline: Sink

Read data using REST Client with the parameters provided in the input dataset

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
use_session Text Name of the previously saved session in this pipeline
save_session Text Name of session that needs to be stored in the context of current pipeline







Bot @restclient:write

Bot Position In Pipeline: Sink

Write input data using REST Client

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
url* Text The URL for getting the data
method Text post HTTP method to use. Example: post, put
envelope Text ${data} Envelope for the payload. Use ${data} as place holder for actual data.
encoding Text json Encoding for the payload: Options are json or urlencode
batch_size Text The number of rows written at a time.
username Text The UserName for authentication
password Text The Password for authentication
secret_name Text Name of the secret from the vault
use_session Text Name of the previously saved session in this pipeline
save_session Text Name of session that needs to be stored in the context of current pipeline
verify Text no If HTTPS, verify SSL certificate. Values can be 'yes' or 'no'
debug_dataset Text Saves all the debug information including headers and other sensitive information to the specified
dataset.

This bot also accepts wildcard parameters. Any additional name = 'value' parameters are passed to the bot.

Example Pipelines Using this Bot