Detailed Descriptions for the elements in the Parameters Resource.
Parameters | |
Definition | This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it. |
Control | 1..1 |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
Parameters.parameter | |
Definition | A parameter passed to or received from the operation. |
Control | 0..* |
Invariants | Defined on this element inv-1: A parameter must have only one of (value, resource, part) (expression ![]() |
Parameters.parameter.name | |
Definition | The name of the parameter (reference to the operation definition). |
Control | 1..1 |
Type | string |
Parameters.parameter.value[x] | |
Definition | If the parameter is a data type. |
Control | 0..1 |
Type | * |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Invariants | Affect this element inv-1: A parameter must have only one of (value, resource, part) (expression ![]() |
Parameters.parameter.resource | |
Definition | If the parameter is a whole resource. |
Control | 0..1 |
Type | Resource |
Invariants | Affect this element inv-1: A parameter must have only one of (value, resource, part) (expression ![]() |
Parameters.parameter.part | |
Definition | A named part of a multi-part parameter. |
Control | 0..* |
Type | See Parameters.parameter |
Comments | Only one level of nested parameters is allowed. |