[Index]

Model: device/http/Request

HTTP Request Driver Usage

The procedure to use the HTTP Request driver involves the following steps:

  1. Create an instance of data/Http in the required hierarchy, specifying at least the host name and version number of the interface (typically HTTP 1.1). The details in this instance will be used when a Provisioning Workflow that has a device/http/Request Configuration Template is excecuted.
  2. Executing this Provisioning Workflow will send the HTTP requests using the instance in the hierarchy search upwards in the hierarchy until a data/Http instance is found.
  3. The specified the Configuration Template will map any workflow input data to the body of the HTTP request.
  4. The execution of the workflow with makes the HTTP request. The HTTP request will fail unless a HTTP 2xx response is received. Any steps in the workflow are rolled back as usual.

Refer to the example in the Notifications Interface topic.

Model Details: device/http/Request

Title Description Details
Body
  • Field Name: body
  • Type: ["String", "Null"]
Username
  • Field Name: username
  • Type: String
URL
  • Field Name: url
  • Type: String
Verify SSL Certificate
  • Field Name: verify
  • Type: Boolean
Headers
  • Field Name: headers
  • Type: ["Array", "Null"]
Value *
  • Field Name: headers.value
  • Type: String
Key *
  • Field Name: headers.key
  • Type: String
Password
  • Field Name: password
  • Type: String
  • Is Password: True
Method *
  • Field Name: method
  • Type: String
  • Choices: ["GET", "PATCH", "PUT", "POST", "DELETE"]