Set via API call

Set fields with an api call

Ingredient Family: setterIngredientsList

Outline Display: Use an API call to {{endpoint}} of {{apiName}} to set some fields

Local scope

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

• $settables – The set of fields that are available to be set

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
• mappingOutputs – 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 send the GET request to
  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($settables, mappingResult, inputTable) (many, until inputTable = mappingResult)
  How to map available field values to the endpoint’s inputs

• outputMapping : ingredient slot of mappingIngredientsList(outputTable, mappingOutputs, $settables) (many, until $settables >= mappingOutputs)
  How to map endpoint outputs to the fields we will set