Call HTTP Web Service

Use the Call HTTP Web Service action A tool for building the processes, logic, and direction within workflows. to make HTTP requests to create, read, update, or delete data from a web service.

For example, send an HTTP Get request and make an API call to a third party API platform such as OpenWeatherApp to retrieve current weather information of a specific city. See Step-by-step example: Make an API call to the OpenWeatherMap API to retrieve weather information.

Note: This is an external action and may execute on servers running outside your data center Centralized locations used to house servers used by Nintex for remote storage, processing, or distribution of data. Nintex has a number of regional data centers available for Nintex for Office 365. For information about Nintex data centers and where your data center is located, contact your Nintex account or territory manager. region. Before implementing, consider performance and regional concerns where digital boundaries are an issue. For more information, see In-tenant and external actions.

Before you start 

In simple terms, a web service can be defined as a method of communication between systems to send and receive data through a network, in machine readable file formats such as JSON. When doing so, they make use of a protocol such as HTTP to transport their data from one application to another.

Variables are placeholders that store information that changes each time the workflow runs or even during execution of a single workflow instance.

Each variable has a type that determines what values can be stored in the variable, such as a date, number, file path or a workflow user name. For example, if you want to save the name of an employee in a variable, you have to create a variable of type Text. The workflow can then store a name of the employee, such as "John," in the variable.

  • Text: Text string.
  • Boolean: Yes or No value.
  • Date/Time: Date and time value.
  • GUID: Globally unique identifier, often used to reference a list item in SharePoint.
  • Number: Integer number with decimal value.
  • Integer: Integer number with no decimal value.
  • Choice: A value that requests a selection from a list of allowed values.
  • Person or Group: A value that requests a selection from a user lookup.
  • Hyperlink: A value that requests a hyperlink URL and description.
  • Dictionary: A container that holds a single logical unit of variables. For more information, see Dictionary variables.
  • Collection: An index-based array of values, also known as an ordered list of values. For more information, see Collection variables.

In NintexOffice 365, the different categories of variables that can be used in a workflow are given below:

  • Start Variables: Workflow variables with the initiation option selected. Start Variables are used to get data from users when a workflow manually starts.

    • For more information on manually starting a workflow, see .

You can insert an existing Workflow Variable or Context Variable into the configuration fields of workflow actions A tool for building the processes, logic, and direction within workflows. and you can create user-defined variables for use throughout your workflow.

You can create user-defined variables from the Action configuration window when you are configuring a workflow action or from the toolbar of the designer page.

  1. In the Action configuration window, click in a field that accepts variables.
  2. Do one of the following depending on the method available;
    • On the drop-down list that appears, Click Create New Variable.
    • On the Insert Reference pane that appears, expand the Workflow Variables section and click Create New Variable.
  3. Do the following in the Workflow Variables pane to create the variable:
    1. For Name, type the variable name you want to use.
    2. Select a Type.
    • If you want to display the variable on the start form, select the Show on start form check box.
    1. Click Create.
  1. On the toolbar of the Designer page, click Variables. The Variables dialog box appears.
  2. Click New and fill in the following:
    1. For Name, type the variable name you want to use.
    2. For Type, select a variable type corresponding to the type of data you want to store.
    1. Click Save.

For more information, see User-defined variable types and Initiation options.

The following table describes the variable types available in the Variables dialog box as well as their initiation options, which are available when you select Yes for Initiation. Initiation options control the display and behavior of the variable on the start form that is displayed when a workflow is started manually.

Variable type Description

Initiation Available

 Initiation options
Text

Any text value.

Underlying .NET data type: System.String.

Yes
  • Multiple Lines: When selected, allows multiple text lines in the default value.
  • Description: Text to display under the text box on the start form. Example: "Enter new name".
  • Default value: Default value for variable.
Boolean

Yes or No value.

Underlying .NET data type: System.Boolean.

Yes
  • Description: Text to display under the check box on the start form. Example: "Enable?"
  • Default value: Default value for variable: Yes (true) or No (false).
Date/Time

Date and time value.

Underlying .NET data type: System.DateTime.

Yes
  • Description: Text to display under the text box on the start form. Example: "Select the date needed by".
  • Default value: Default value for variable: None or Today's date.
  • Allow blank values?: When selected, allows the start form to be submitted without specifying a value for the variable.
  • Display format: Display format for variable: Date and time or Date only.
GUID

Globally unique identifier, often used to reference a list item in SharePoint.

Underlying .NET data type: System.Guid.

No

 (n/a)
Number

Numeric with a Decimal value.

Underlying .NET data type: System.Double.

Yes
  • Description: Text to display under the text box on the start form. Example: "Specify quantity".
  • Default value: Default value for variable. Can be selected or entered.
Integer

Numeric without a decimal.

Underlying .NET data type: System.Int32.

No

 (n/a)
Choice

A value that requests a selection from a list of allowed values. The value selected by the workflow initiator is stored in the variable.

Underlying .NET data type: System.String.

Yes
  • Description: Text to display under the drop-down list on the start form. Example: "Select the product"
  • Choices: Choices available in the variable. Enter each choice on a separate line.
  • Default value: Default value for variable. Enter one of the specified choices.
Person or Group

A value that requests a selection from a user lookup. The item selected by the workflow initiator is stored in the variable.

Underlying .NET data type: System.String.

Yes
  • Description: Text to display under the text box on the start form. Example: "Select your manager"
  • Allow selection of: Scope of allowed selection: People Only or People and Groups.
  • Choose from: Source of selection: All Users or SharePoint Group. Use the drop-down list to select a SharePoint group.
  • Allow blank values?: When selected, allows the start form to be submitted without specifying a value for the variable.
  • Allow multiple values?: When selected, allows entry of multiple values.
Hyperlink

A value that requests a hyperlink URL and description.

Two text boxes are provided: 

  • Type the Web address
  • Type the description

The values entered by the workflow initiator are stored in the variable.

Underlying .NET data type: System.String.

Yes
  • Description: Text to display under the "Type the description" text box on the start form. Example: "Enter a display value for the URL"
  • Allow blank value?: When selected, allows the start form to be submitted without specifying a value for the variable.
Dictionary

A container that holds a single logical unit of variables. For more information, see Dictionary variables.

Underlying .NET data type: Microsoft.Activities.DynamicValue.

No

 (n/a)

Collection

An index-based array of values, also known as an ordered list of values. For more information, see Collection variables.

No

(n/a)

You can insert a Workflow Variable, Reference A workflow reference which is used to construct content containing information specific to the list or library item and to the current instance of the workflow. or a Context Variable into the configuration fields of workflow actions A tool for building the processes, logic, and direction within workflows..

Each field that accepts variables accepts one or more methods for inserting variables. The method available differs depending on the field.

Available methods are given below:

  • Click on the field and select an existing variable from the drop-down list for the field.

  • Click on the field, click Create New Variable, and fill the following fields in the Workflow Variable pane that appears:
    1. For Name, type the variable name you want to use.
    2. Select the Show on start form check box if you want to display the variable on the start form.
    3. Click Create.
  • Click on the field, select Workflow Variables or Workflow Context, and select a variable from the corresponding drop-down list.

  • Click Advanced Lookup, select Workflow Variables or Workflow Context from the drop-down list that appears, and then select a variable from the corresponding drop down and click Insert.

  • Click on the field that accept references and from the Insert Reference pane that appears on the right, double-click on a reference to select. Available sections and lookup values depend on the options available for the workflow action.
    Section Description
    Item Properties

    Metadata columns for the item the workflow is associated with. Available only for list workflows.
    Workflow Context

    Context variables that represent data related to the current workflow instance, such as current item or site URL and workflow name.

    • Current item URL: The URL of the item the workflow is associated item. Available only for list workflow actions.
    • Current site URL: The URL of the site the workflow is associated site.
    • Initiator login name: The login name of the person who started the workflow instance.
    • Initiator display name: The display name of the person who started the workflow instance.
    • Initiator email address: The email address of the person who started the workflow instance.
    • Instance ID: The unique identifier of the workflow instance.
    • List ID: The unique identifier of the list the workflow is associated with. Available only for list workflow actions.
    • List Name: The name of the list the workflow is associated with. Available only for list workflow actions.
    • Manager login name: The login name of the manager of the initiator (the person who started the workflow instance).
    • Manager display name: The display name of the manager of the initiator (the person who started the workflow instance).
    • Manager email address: The email address of the manager of the initiator (the person who started the workflow instance).
    • Publish user: The person who published the workflow.
    • Workflow name: The name of the executing workflow.
    Workflow Variables Workflow variables configured for the workflow.

You can configure variables to collect data when a workflow is manually started. These variables will be shown on a start form used to initiate the workflow and allows users to specify a value for the workflow variable before the workflow starts, basically passing values into the workflow before it starts.

Variables displayed on a start form are also known as the "start data" of the workflow and represent data that must be collected when the workflow is started.

Note:  If the workflow starts automatically, then default values are used for start data.

To learn how to manually start a workflow, see Start a workflow manually.

Configure a variable to show on a workflow start form:

  1. Open the required workflow. The workflow designer opens.

  2. On the toolbar, click Variables. The Variables window opens.

  3. To edit an existing variable, click the required variable. The row becomes editable.

    or

    4. To create a variable, click New on the Variables window toolbar, enter a Name, and select the Type for the variable.

  4. Select the Initiation check box for the required variable.
  1. Click Save to commit changes.

Add and configure the Call HTTP Web Service action

In the Designer:

  1. Click the Integration action group in the action toolbox.

    2. or

    Type the action name or function in the Search field at the top of the action toolbox.

  1. Drag the Call HTTP Web Service action to the designer canvas.
  2. Open the Action configuration window. For steps on how to open the Action configuration window, see Action configuration window.
  3. Type the Address.
  4. Select the Request Type.
  5. Select a variable to store the Response Status Code.
  6. Click Save.

For more information on the fields and buttons see, Call HTTP Web Service fields, buttons and settings.

Field

Description
Address

The URL of the web service to call and retrieve data from.

Request Type

The method of HTTP request to use to interact with the web service.

  • HTTP Get: requests to retrieve data. Requests using GET should only be used to retrieve data.
  • HTTP Put: requests to send data to a server to update a resource.
  • HTTP Post: requests to send data to a server to create a resource.
  • HTTP Delete: requests to delete the specified resource.

Learn more about HTTP request methods.
Request Headers

Dictionary variable A group of name-value pairs. A dictionary variable is a container for a logical unit of variables. Multiple data types can be contained in a single dictionary variable. to store the headers of the request.

A request header is an header used in the web service request that does not relate to the content of the message.

Request headers contain more information about the resource to be fetched, or about the client requesting the resource.
Request Content

Dictionary variable to store the content (body) of the request.

Request content is the message content of your HTTP request.
Response Content Dictionary variable to store the content (body) of the server's response. Usually the data you want is stored in the response content.
Response Headers

Dictionary variable to store the response headers of the request.

An HTTP response header is the component of a network packet that is sent in response to an HTTP request.
Response Status Code

Variable to store the status code that indicates the result of the HTTP request. It is issued by the server in response to a request.

For example, if the it returns OK if the result is successful.

For more information about how to use Lookups in configuration fields, see Lookups in action configuration fields.

This example retrieves the current weather information of a city you specify in the GET URL. The response content of the API call is returned in JSON format.

Note: Use the OpenWeatherMap API guide alongside these steps.

In the Designer page:

  1. Drag the Call HTTP web service action to the point in the workflow when you want to make an API call.
  2. Click the Call HTTP web service action.
  3. Copy and paste the following URL into the URL field. 
    4. https://api.openweathermap.org/data/2.5/weather?q=‍Location&APPID=AppID

    Replace Location and AppID in the URL with the following:

    • Location: the city where the current weather information will be retrieved. For example, to retrieve weather information of London, replace Location in the above URL with London,uk
    • AppID: the API key provided when you sign up for an OpenWeatherMap account. This API key allows you authenticated use of OpenWeatherMap APIs.
  1. Select HTTP Get for the Request type.
  1. In Response content, select or create a variable to hold the response content of the API call.

  2. Select or create a variable to store the Response Status Code of this HTTP request.

    The following code is an example of a response from an OpenWeatherMap API call about the weather of London at a specified time:

    {
    "coord": {
      "lon": -0.13,
      "lat": 51.51
    },
    "weather": [
        {
          "id": 801,
          "main": "Clouds",
          "description": "scattered clouds",
          "icon": "02d"
        }
      ],
      "base": "stations",
      "main": {
          "temp": 281.62,
          "pressure": 1023,
          "humidity": 71,
          "temp_min": 278.71,
          "temp_max": 284.82
      },
      "visibility": 10000,
      "wind": {
          "speed": 3.1,
          "deg": 230
      },
      "clouds": {
          "all": 18
    },
      "dt": 1567405267,
      "sys": {
          "type": 1,
          "id": 1414,
          "message": 0.0113,
          "country": "GB",
          "sunrise": 1567401255,
          "sunset": 1567450013
      },
         "timezone": 3600,
         "id": 2643743,
         "name": "London",
         "cod": 200
}

For more information on the fields and buttons, see Call HTTP Web Service fields, buttons and settings.