Child pages
  • http-request

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

The http-request context provides information about an incoming HTTP request.

Usage

Code Block
{
    "type": "http",
    "uuid": string,
    "parent": context object,
    "security": object,
    "method": string,
    "path": string,
    "query": query object,
    "headers": headers object
}
Members

"type": "http"
Specifies that the context is an http-request context type.

"uuid": string, required
See context object .

"parent": context object, required
See context object .

"security": security object (see below), required
The security properties of the HTTP request.

"method": string, required
The method of the HTTP request.

"path": string, required
The URI path of the HTTP request.

"query": query object (see below), required
The URI query parameters of the HTTP request.

"headers": headers object (see below), required
The headers included in the HTTP request.

Security object

Code Block
{
    "user": string
}
Members

"user": string, required
The name of the authenticated user that was provided by the container, or null if no authenticated user was provided.

Query object

The query object represents the query parameters that were included in the request URI of the HTTP request. Each parameter name is represented as a member in the query object. HTTP allows a parameter to be expressed more than once in the query string, therefore the member value is a string for single values, and array of strings for multiple values.

Headers object

The headers object represents the header fields that were included in the HTTP request. Each header name is represented as a member in the headers object. HTTP allows a header field to be expressed more than once in a request, therefore the member value is a string for single header values, and an array of strings for multiple header values.