A payload schema defines the shape of the data body sent to an ERP endpoint, including its fields, data types, and nesting. Open Payload Schemas from the side menu to manage schemas.
Payload schemas list
Control | Purpose | Options or state |
Name | Filters the list by schema name. | The control is a text field with a Search placeholder. |
Client connection | Narrows the list to schemas belonging to the selected client connection. | The control is a selectable filter. |
Create | Opens the create form for a new payload schema. | The control is available on the list screen. |
Delete | Deletes all selected schemas. | Select one or more rows before selecting Delete. |
Column | What it identifies |
Name | The schema's display name. |
Method | The HTTP method associated with the schema. |
Endpoint | The API endpoint path targeted by the schema, without a leading slash. |
Root type | This identifies whether the top-level payload is an Object or an Array. |
General tab
Selecting a schema from the list or selecting Create opens the detail screen. The General tab contains the schema's identity and routing fields.
Field | What it contains | Options or state |
Name | The display name for the schema. | The field is a text field. |
Client connection | Identifies the client connection to which the schema belongs. | Select from the available connections. |
Endpoint | The API endpoint path for the schema. | Enter the path without a leading slash. |
Method | The HTTP method for the endpoint. | The available methods are POST, PUT, PATCH, and DELETE. |
Root type | The top-level structure of the payload body. | The available root types are Object and Array. |
Control | What it does | State or scope |
Save | Persists changes to the schema. | The control is disabled in the displayed detail state. |
Delete | Permanently removes the schema and all its fields. | The control is available on the detail screen. |
Fields tab
The Fields tab defines the fields that make up the payload body. Fields with the Association many data type contain a nested Payload Fields subsection. Each payload-field row includes an edit control for modifying that field's properties.
Column | What it identifies |
Name | The field key as it appears in the payload body. |
Data type | The data type of the field. |
edit | This control modifies the properties of its payload field. |
Control or area | What it does | Scope |
Create Payload Field | Adds a new top-level field to the schema. | The control is in the Payload Fields section. |
Delete | Deletes all selected top-level fields. | The action applies to selected fields in the top-level Payload Fields section. |
Nested field creation | Adds a nested field under the parent association field. | This applies to a parent field with the Association many data type. |
Nested field deletion | Deletes all selected child fields. | This applies to selected child fields in the nested subsection. |
Related