Commit 22a96766 authored by Peter Waher's avatar Peter Waher

Describing Request/Response.

parent 749fe34c
......@@ -32,20 +32,26 @@ use of [tokens](#tokens).
### XML representation
| Entity | Element | Use | Attributes | Type | Use | Description |
|-----------|-----------|----------|------------|---------------|----------|-----------------------------------|
| Request | `req` | Required | `id` | `xs:string` | Required | Request identity. |
| | | | `m` | `xs:boolean` | Optional | Include momentary values. |
| | | | `p` | `xs:boolean` | Optional | Include peak values. |
| | | | `s` | `xs:boolean` | Optional | Include status values. |
| | | | `c` | `xs:boolean` | Optional | Include computed values. |
| | | | `i` | `xs:boolean` | Optional | Include identity values. |
| | | | `h` | `xs:boolean` | Optional | Include historical values. |
| | | | `all` | `xs:boolean` | Optional | Include all categories of fields. |
| Node | `nd` | Optional | `id` | `xs:string` | Required | Node identity. |
| | | | `src` | `xs:string` | Optional | Source identity. |
| | | | `pt` | `xs:string` | Optional | Partition. |
| Field | `f` | Optional | `f` | `xs:string` | Required | Unlocalized field name. |
| Entity | Element | Use | Attributes | Type | Use | Description |
|-----------|-----------|----------|------------|---------------|----------|---------------------------------------------------|
| Request | `req` | Required | `id` | `xs:string` | Required | Request identity. |
| | | | `m` | `xs:boolean` | Optional | Include momentary values. |
| | | | `p` | `xs:boolean` | Optional | Include peak values. |
| | | | `s` | `xs:boolean` | Optional | Include status values. |
| | | | `c` | `xs:boolean` | Optional | Include computed values. |
| | | | `i` | `xs:boolean` | Optional | Include identity values. |
| | | | `h` | `xs:boolean` | Optional | Include historical values. |
| | | | `all` | `xs:boolean` | Optional | Include all categories of fields. |
| | | | `from` | `xs:dateTime` | Optional | Only return fields not older than this timestamp. |
| | | | `to ` | `xs:dateTime` | Optional | Only return fields not newer than this timestamp. |
| | | | `when` | `xs:dateTime` | Optional | Timestamp of when the request is to be executed. |
| | | | `st` | `xs:string` | Optional | Service token. |
| | | | `dt` | `xs:string` | Optional | Device token. |
| | | | `ut` | `xs:string` | Optional | User token. |
| Node | `nd` | Optional | `id` | `xs:string` | Required | Node identity. |
| | | | `src` | `xs:string` | Optional | Source identity. |
| | | | `pt` | `xs:string` | Optional | Partition. |
| Field | `f` | Optional | `f` | `xs:string` | Required | Unlocalized field name. |
Responses
......@@ -142,6 +148,10 @@ is being reported back.
Tokens
------------
To support distributed transactions, where the identity of the original actors are used to authorize requests, a set of **tokens** can be
provided in the request. Tokens can be used to identify a **device**, a **service** and a **user**. They can be validated and challenged.
For more information, see the article on [Tokens](Tokens.md).
Legacy
-------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment