Skip to main content

Extensibility and Integration

 

OutSystems

Structure Attribute (REST API Method)

Attribute of structure used in input and output arguments of REST API Methods.

Properties

Name Description Mandatory Default value Observations
Description Text that documents the element. Useful for documentation purpose.
The maximum size of this property is 2000 characters.
Name Identifies an element in the scope where it is defined, like a screen, action, or module. Yes
Label Text literal or expression used as a tooltip when hovering the image or displayed when the image cannot be displayed.
Data Type The attribute data type. Yes
Length Maximum size of the attribute in characters.
Decimals Number of decimal places. Only available when data type is Decimal (mandatory).
Is Mandatory Set to Yes to require for a value to be set. Yes
Advanced
Default Value Initial value of this element. If undefined, the default value of the data type is used.
Name in JSON Name to use when sending this attribute in the payload of the request.
  • Was this article helpful?