API
En anropbar slutpunkt i projektet, intern via call_project_api eller extern via slutpunkten api/mcp.
Ett API-program är ett orkestreringslager med en utdata: det kan binda en datakälla, samordna anropen get_data, set_data och batch i sina egna händelser och lämna tillbaka ett svar, format av en mall i stället för av fältbindningar. Anropa det inifrån projektet med arbetsflödesåtgärden call_project_api, eller nå det utifrån via projektets slutpunkt api/mcp.
Egenskaper
progDataSource och progFields
Samma form som Datakälla, används när API:et läser eller skriver en tabell som en del av att bygga sitt svar. progFields deklarerar fälten som är tillgängliga för svarsmallen, table för riktiga kolumner, virtual för beräknade.
scriptData: svarsmallen
Nyttolasten är en stringifierad objektmall i scriptData.value. @field-bindningar löses vid anropet, med samma uttryckssyntax som på alla andra ställen i plattformen:
Att anropa ett API-program
Internt kör call_project_api det precis som get_data eller set_data kör sina programtyper, name.prog namnger API:ets id, name.parameters levererar dess indata.
Genomgånget exempel
Deklarera gränssnittet
progParams för varje indatavärde (dir: "in") och utdatavärde (dir: "out").
Bind data om svaret behöver det
En valfri progDataSource, plus progFields för de kolumner som matar mallen.
Skriv svarsmallen
scriptData.value, ett stringifierat objekt med @field-platshållare, och ange apiOutput till det format som anropare ska få tillbaka.
Skapa en API-nod under Program, ange apiOutput på dess flik Egenskaper, binda eventuellt en Datakälla och skriv sedan svarsformen i editorn Svar.
Blocket <response> i .xu är scriptData.value, skrivet som ett vanligt objektuttryck i stället för en JSON-sträng.