...
JSON Path The path to the property | Type* Type of information | JSON Type The type of the value | Description The description of the value | Presence When this property is exposed | Comment |
|---|---|---|---|---|---|
$ | STRUCT | Object | The response for end point invocation (root) | Always | |
$.resource | META | String | The resource type name | Always | |
$.name | META | String | Localized name of the resource type | Always | |
$.description | META | String | Localized description of the resource type | Always | This is the data titled Technical description in the configuration of the data structure |
$.response | STRUCT | Object | Data specific to the call for service response | Always | |
$.links | AGPG | Object | HATEOAS Section | Always | |
$.version | TECH | String | Version of the API end point | Always | |
$.apiversion | TECH | String | Version of the API | Always | |
$.response.headers | STRUCT | Object | The headers | If parameter | See details of this section here. |
$.response.data | STRUCT | Object | Resource data | Always | |
$.response.data.<prop> where <prop> is a resource property name | DATA | Miscellaneous Depends of the property data type (see below) | Resource data value | Depends of the resource configuration and the | |
$.response.data.<prop> where <prop> is technical property (starting with $) | TECH | Miscellaneous (see below) | Technical property | Depends of specific parameters and the | |
$.response.data.$custom | TECH | Object | Custom data section | This section will be produced by a specific extension to the environment | |
$.response.data.$custom.[*] | any | Miscellaneous | Custom data properties | If a custom data section has been implemented on the environment. |
...