Web Services on-premises - Call a web service on-premises

Use the Web Services on-premises - Call a web service on-premises action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to make HTTP requests and API calls.

For more information about Web Services on-premises, go to Web Services on-premises.

Before you begin: 

  • Understand Variables

  • JSON is JavaScript Object Notation, a flexible syntax for storing textual information in a structured way. It is one of the primary standards for transmitting information across the internet. JSON is built of:

    • Key-value pairs, where a key is matched by a colon to a specific value, like "title" : "Gone with the Wind".
    • Objects, where multiple key-value pairs are grouped together as a unit between a set of curly braces {}.
    • Arrays, where a set of objects or key-value pairs are grouped into a list between a set of square brackets [].

    Objects and arrays can be nested inside of each other, creating an extremely flexible data structure:

    
{ 
  "products": {
    "food": [ 
      { 
        "category": "fruit",
        "name": "apple",
        "type": "Red Delicious",
        "price": 2.95
      },
      { 
        "category": "deli",
        "name": "fish",
        "type": "salmon",
        "price": 7.99
      }
    ],
    "homewares": {
      "item" : "towel",
      "color": "blue",
      "size" : "bath",
      "price": 12.95
    }
  }
}

Jump to:

Configure the Web Services on-premises - Call a web service on-premises action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  1. Select a Connection. If you do not have a connection, see Add a connection.
  1. In URL, type your request URL or select a variable that holds your request URL.
  2. Select a Request type.
  3. If needed, in Request headers, click Add header and then type your request headers or insert a variable that stores the headers of your HTTP request.
  4. If needed, in Request content, type your request content or insert a variable that stores the content of your HTTP request.
  5. Create or select a variable for the output.

Web Services on-premises - Call a web service on-premises action fields and settings

Section

Field

Description

Variable types

(Unlabeled)

Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The Web Services on-premises connection to use to create the new record.

To refresh the available connections, click .

(n/a)
URL

Uniform Resource Locator (URL) used to call a web service. Accepts any combination of typed text and inserted variables.

 Text, Decimal, Integer, Boolean, DateTime, Collection
  Request method

The method of HTTP request to be performed on an identified resource.

  • Get: Requests to retrieve data.
  • Post: Requests that the server accept your data.
  • Put: Requests to store an entity under the supplied URI (Unified Resource Identifier).
  • Patch: Requests to apply partial modifications to a resource.
  • Delete: Requests to delete a specified resource.
  • Options: Used by the client to find out the HTTP methods and other options supported by a web server.
  • Head: Same as Get, but transfers the status line and header section only.

Learn more about HTTP request methods.

Text, Decimal, Integer, Boolean, DateTime, Collection
  Request headers

Click Add header to add a header to the request.

Name: The name of the header.

Value: The content of the header.

You can add multiple headers per web call.

 Text, Decimal, Integer, Boolean, DateTime, Collection
  Request content The message content of your HTTP request. Accepts any combination of typed text and inserted variables. Text, Decimal, Integer, Boolean, DateTime, Collection
  Integrated authentication Select whether to use integrated authentication. (n/a)
  Timeout The number of seconds the HTTP request has to complete. Integer
Output Response

Stores the result of the action as an object. The following values are returned:

  • HTTP status: (Object)
    • HTTP status code: (Integer)
    • HTTP status message (Text)
  • Nintex Gateway status: (Object)
    • Nintex Gateway status code: (Text)
    • Nintex Gateway message: (Text)
  • Headers: (Collection)
    • Name: (Text)
    • Value: (Text)
  • Response: (Text)
 Object