This page explains the REST Import Rules in Bridge context. If you were looking for the same information regarding the PAS Designer, refer to 2023-06-06_10-13-09_REST Schema Object in the Designer guide.
Schema objects can be defined inline or be a reference to an object of the definitions list.
A class is created for each schema object that is not a base type or array. If the schema object is in the definitions list, the key is used as class name instead a unique name is created using the path to the schema object (E.g.: "UserList_Items", "users_GET_response" ...).
Element | Used By Importer | Description | More Information at ... |
---|---|---|---|
$ref | A reference to a schema defined in the definitions list. the schema object is replaced by the definition. | ||
type | The type of the object.
| ||
format | The format of the object is used to be more specific when the type is string. | ||
items | The item is a schema object to defined the type of element in the array. Only used if type is array. | ||
allOf | List of schema object. The resulting class will contain all properties of all listed schema objects. | ||
properties | List of properties. Each property is define by a name and a schema object. A property is created on the resulting class for each properties defined. | ||
additionalProperties | This should allow to define a map/dictionary. | ||
xml | Adds additional metadata to describe the XML representation format of this property. |
Overview
Content Tools