Objects
ResourceReference
Points to a list another API serves and says how to read it: which route, which property is the value and which the label. A client fetches the options itself, with the permissions of the caller. Used for choices whose options are master data.
object
ResourceReferenceFields
route
String!
The route of the list, for example /v3/payment-methods.
valueProperty
String!
The property of an entry that is stored as the value, for example id.
labelProperty
String!
The property of an entry that is shown, for example name.
descriptionProperty
String
The property of an entry that holds a further text.
searchParameter
String
The query parameter for searching while typing. Absent when the list is not searchable.
fixedParameters
Query parameters to always send, for example isActive=true.
Was this page helpful?