Call API endpoint

Send a custom API call that may use the previous row values

Ingredient Family: formIngredients

Outline Display: Send a custom API call to {{endpoint}}

Details

The mapping may be omitted when the form’s fields already carry the endpoint’s arguments under their own names: an argument no entry names is filled from the field of that name, so a mapping spells only what it renames or computes. A file or point argument is never filled that way and always needs its own entry.

Local scope

The parent slot binds these (look up the slot in the parent to see how):

• $parentTable – The table (if any) that this form is based on
• $formFieldsTable – A table of form fields that is built up through the sequence of form ingredients

Names introduced within this component’s knobs:

• inputTable – request shape of endpoint (chosen under apiName)
• outputTable – response shape of endpoint (chosen under apiName)
• mappingResult – empty table populated by ingredients

Settings

Required

• apiName : API connection
  the API the endpoint is part of
  Set this to the name of any top-level api: item (or the inline api: block on a service/authenticator).

• endpoint : endpoint of apiName
  the endpoint to call
  Set this to the Name of an entry under wrappedEndpoints: on the referenced api: item, or to the name of a raw endpoints: entry that has no hand-written wrapper: every such endpoint automatically gets an identity wrapper of the same name (each parameter an argument, each response field revealed, with any character other than letters, digits, _, and - in a name replaced by an underscore, so the flattened path payload.note becomes payload_note). Do not write identity wrappers by hand; write a wrappedEndpoints: entry only to restrict or reshape an endpoint, and note that doing so replaces its automatic wrapper.

• mapping : ingredient slot of mappingIngredientsList($formFieldsTable, mappingResult, inputTable) (many, until inputTable = mappingResult)
  How to map available field values to the endpoint’s inputs

Optional

• outputMapping : ingredient slot of mappingIngredientsList(outputTable, $formFieldsTable, $parentTable) (many)
  How to map endpoint outputs to results