Skip to content

Structs

The Structs tab of an API adapter holds the data structures that the operations of the adapter use: their classes, enumerations and relationships. They are used in your code like the classes of a business object, and you can also create a business object from them.

A new adapter says This API has no structs. The + button offers:

  • New Imported Struct
  • New Enumeration
  • New Class

For a REST or SOAP adapter, the structs are detected when you refresh the model: Studio reads the operations and collects the classes of their parameters and results. Each attribute of a struct has these properties:

Property Description
Attribute Name The name of the attribute. You can change it to an alias, but then you must set its original name in Initial Name.
Type The data type of the attribute.
Initial Name The name the attribute had before you changed it, as the API knows it.

See Operations and structs for the adapter types.