Swagger HTTP Request

Use the Swagger HTTP Request activity to send a request for a file based on a URL, HTTP headers, or Cookies data.

  1. In the Workflow Editor Toolbox, choose Web Service > Swagger HTTP Request and drag and drop the activity onto the Workflow pane.

  2. On the Workflow Properties pane, enter the following information:

    1. Under General, specify the following information:

      1. Display Name - Enter the unique display name for the activity.

      2. Description - Enter the brief description about the activity.

      3. Activity Timeout (Seconds): Enter the number of seconds to wait for Swagger HTTP Request activity to fail because it timed out.

      4. Check the Continue Workflow Execution on Failure check box to continue the workflow execution on failure of the activity.

    2. Under Target, specify the following information:

      1. Use Workflow Target - Check this radio button to use the workflow target.

      2. Override Workflow Target - Check this radio button to override the workflow target. You can select the appropriate target or +ADD NEW  from the dropdown list. For more information, see HTTP Endpoint.

      3. Use Workflow Target Group: Check this radio button to use the workflow target group.

      4. Override Workflow Target Group Criteria: Check this radio button to override the workflow target group criteria.

    3. Under Credentials, specify the following information:

      1. Use Target's Default Account Key - Check this radio button to use the target's default account key.

      2. Override Account Key - Check this radio button to override the workflow account key. You can select the appropriate Account key or +ADD NEW from the dropdown list. For more information, see HTTP Basic Authentication or HTTP Client Certificate Authentication.

    4. Under Browse APIs, enter the Swagger URL to be requested or click Browse icon to choose your URL.

    5. Under HTTP Request, enter the following information or click Variable Reference icon to choose any variable:

      1. Relative URL - Enter the relative URL to be requested. The base URL will be determined by the web target combined with the relative Url during the activity execution.

      2. Method - Select the method to be performed on the resource identified by the Request-URI from the dropdown list such as Get, Post, Put, and so forth.

      3. Request Parameters - Enter the message parameters to be carried in the HTTP request.

      4. Request Body - Enter the message body to be carried in the HTTP request.

        You will be able modify the request parameters and body formats using Format option in the right bottom such as JSON, Text, XML, and so forth.

    6. Under Headers, enter the following information or click Variable Reference icon to choose any variable:

      1. Content Type: Select the appropriate value from the dropdown list to be used for defining the structure of the output such as HTML, JSON, Plain Text, and so forth.

      2. Custom Headers: Click +ADD, to enter the Header and Value.

      3. Cookie: Click +ADD, to enter the cookie to be accepted from HTTP request.

    7. Under Behavior, check the Continue on HTTP Error Status Code check box to allow the header request to continue on HTTP Error Status Code.

Back to: Web Service

  • No labels
Terms & Conditions Privacy Statement Cookies Trademarks