Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / VAB / HTTP Mapping"
< BaSyx | Documentation | VAB
(HTTP/REST mapping (taken from VAB description)) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" | ||
| + | ! style="text-align:left;"| See also | ||
| + | | [[BaSyx_/_Documentation_/_VAB_/_TCP_Mapping | TCP Mapping]] | ||
| + | | [[BaSyx_/_Documentation_/_VAB_/_JSON_Serialization | JSON Serialization]] | ||
| + | | [[BaSyx_/_Documentation_/_VAB_/_Exceptions | Exceptions]] | ||
| + | |} | ||
| + | |||
The following table illustrates the mapping of VAB communication operations to HTTP REST communication that was used in this example. Short values, e.g. the path to the element and an operation ID are transmitted in the header, while complex objects, e.g. parameters are transmitted in the HTTP body, which has no size limitation. | The following table illustrates the mapping of VAB communication operations to HTTP REST communication that was used in this example. Short values, e.g. the path to the element and an operation ID are transmitted in the header, while complex objects, e.g. parameters are transmitted in the HTTP body, which has no size limitation. | ||
Latest revision as of 02:00, 5 August 2020
| See also | TCP Mapping | JSON Serialization | Exceptions |
|---|
The following table illustrates the mapping of VAB communication operations to HTTP REST communication that was used in this example. Short values, e.g. the path to the element and an operation ID are transmitted in the header, while complex objects, e.g. parameters are transmitted in the HTTP body, which has no size limitation.
| VAB operation | HTTP/REST mapping |
|---|---|
| retrieve(e,p) | HTTP-GET e/p |
| update(e,p,v) | HTTP-PUT e/p [body: v as JSON] |
| create(e,n,v) | HTTP-POST e/n [body: v as JSON] |
| delete(e,p) | HTTP-DELETE e/p |
| invoke(e,p,par) | HTTP-POST e/p [body: par as JSON] |