Defining Resources 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.

Resources are the basic building blocks of a REST Web Service, that is, the data or objects that the REST API can provide or manipulate. When you create a REST Connection object, you define the resources that Jobs that use that Connection object will be able to address. The resources that you specify in the Connection object will be available for selection when defining a REST Job on its Web Service > Request page, in the Request Settings section under Resource.

In the Resources section of the Web Service page of a REST Connection object you define the following:

  • Resource

    This is the tag or name that you assign to the resource. Use a name that is descriptive and helps you recognize the purpose of the resource (the Value) later on.

  • Value

    This is the URI entity fragment. You can find it in the target Web Service REST API documentation. You can use Automic Automation variables here. You can also use the following replacement values:

    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: