Referencing Request Values

Jump to bottom Edit New page

Adnan Hajdarević edited this page Jun 9, 2015 · 6 revisions

Referencing request values

There are three types of request values:

HTTP Request Header values

{
  "source": "header",
  "name": "Header-Name"
}

HTTP Query parameters

{
  "source": "url",
  "name": "parameter-name"
}

Payload (JSON or form-value encoded)
```
{
  "source": "payload",
  "name": "parameter-name"
}
```
Note: For JSON encoded payload, you can reference nested values using the dot-notation. For example, if you have following JSON payload
```
{
  "commits": [
    {
      "commit": {
        "id": 1
      }
    }, {
      "commit": {
        "id": 2
      }
    }
  ]
}
```
You can reference the first commit id as
```
{
  "source": "payload",
  "name": "commits.0.commit.id"
}
```
If the payload contains a key with the specified name "commits.0.commit.id", then the value of that key has priority over the dot-notation referencing.

Special cases

If you want to pass the entire payload as JSON string to your command you can use

{
  "source": "entire-payload"
}

for headers you can use

{
  "source": "entire-headers"
}

and for query variables you can use

{
  "source": "entire-query"
}