Defining the HTTP Request Headers for REST Agent Connection Objects

Connection objects establish the communication between the REST Agent and the target REST Web Service. In addition, you can predefined certain parameters in the REST Connection objects. These parameters are then applied by default to the REST Jobs that are created using the Agent or they are available for selection when configuring those Jobs.

The HTTP headers that you specify in the Connection object will be available by default when you define a REST Job that uses this Connection object on its Web Service > Request page, in the HTTP Request Headers section.

  1. Enter a meaningful name for the Header.

  2. Enter the Value. You can use Automation Engine variables here. You can also use the variables described in the following table. They retrieve values from your Connection definitions under the Authentication Method (see Configuring the Authentication Methods for the REST Agent).

    Value Description
    {user} Value of the User field in Connection objects with Basic, Digest, or NTLM authentication.
    {password} Value of the Password field in Connection objects with Basic, Digest, or NTLM authentication.
    {client_key} Value of the Client Key field in Connection objects with OAuth 1.0a or OAuth 2.0 authentication.
    {client_secret} Value of the Client Secret field in Connection objects with OAuth 1.0a or OAuth 2.0 authentication.
    {authorization_token} Value of the Authorization Token field in Connection objects with OAuth 1.0a or OAuth 2.0 authentication.
    {token_secret} Value of the Token Secret field in Connection objects with OAuth 1.0a authentication.
    {access_key} Value of the Access Key field in Connection objects with AWS Signed URL authentication.
    {secret_access_key} Value of the Secret Access Key field in Connection objects with AWS Signed URL authentication.
    {verifier} Value of the Verifier field n Connection objects with OAuth 1.0a authentication.

See also: