Preskočiť na obsah
Overené

API

Volateľný koncový bod projektu, interný cez call_project_api alebo externý cez koncový bod api/mcp.

Program API je orchestračná vrstva s jedným výstupom: môže viazať zdroj dát, koordinovať volania get_data, set_data a batch vo svojich udalostiach a vrátiť jednu odpoveď, tvarovanú šablónou, nie väzbami polí. Zavolajte ho zvnútra projektu akciou pracovného postupu call_project_api alebo sa k nemu dostanete zvonka cez koncový bod api/mcp projektu.

Vlastnosti

progDataSource a progFields

Rovnaký tvar ako Zdroj dát, používa sa, keď API číta alebo zapisuje tabuľku pri vytváraní odpovede. progFields deklaruje polia dostupné pre šablónu odpovede, table pre skutočné stĺpce, virtual pre vypočítané.

scriptData: šablóna odpovede

Obsah je šablóna objektu ako reťazec v scriptData.value; väzby @field sa vyhodnotia pri volaní, rovnakou syntaxou výrazov ako všade inde na platforme:

json
{ "value": "{\n   CS_Id: @CS_Id,\n   CS_Class_Id: @CS_Class_Id,\n   CS_School_Id: @CS_School_Id\n}" }

Volanie programu API

Interne call_project_api ho spustí presne tak, ako get_data alebo set_data spúšťajú svoje typy programov, name.prog pomenúva id API a name.parameters dodáva jeho vstupy.

Ukážkový príklad

Deklarujte rozhranie

progParams pre každú vstupnú (dir: "in") a výstupnú (dir: "out") hodnotu.

Viažte dáta, ak ich odpoveď potrebuje

Voliteľný progDataSource plus progFields pre stĺpce, ktoré napájajú šablónu.

Napíšte šablónu odpovede

scriptData.value, reťazec objektu so zástupnými symbolmi @field, a nastavte apiOutput na formát, ktorý majú volajúci dostať späť.

Vytvorte uzol API pod Programami, nastavte apiOutput na jeho karte Vlastnosti, voliteľne viažte Zdroj dát a potom napíšte tvar odpovede v editore Odpoveď.

xml
<meta lang="json5">
{
  id: "student_classes_api",
  menuTitle: "Student Dashboard API",
  apiOutput: "json"
}
</meta>

<params lang="json5">
{
  in: { campus_in: "string", active_view_in: "string" }
}
</params>

<response>
({
  ok: true,
  campus: @campus_in,
  activeView: @active_view_in,
  summary: { students: 3, tasks: 3, profiles: 3 }
})
</response>

Blok <response> v .xu je scriptData.value, zapísaný ako obyčajný výraz objektu, nie ako reťazec JSON.

json
{
  "properties": {
    "menuType": "api", "menuName": "Student Classes", "apiOutput": "json",
    "progParams": [{ "id": 1734434656288, "data": { "dir": "in", "parameter": "user_id_in", "type": "string" }, "props": {} }]
  },
  "progDataSource": {
    "dataSourceType": "table", "dataSourceFilterModelType": "index",
    "dataSourceTableId": "5b1_tbl_…", "dataSourceIndexId": "be2d06c8-…"
  },
  "progFields": [
    { "id": 1489199308774, "data": { "type": "table", "field_id": "CS_Id" }, "props": { "fieldType": "string" } }
  ],
  "scriptData": { "value": "{\n   CS_Id: @CS_Id\n}" }
}