Přeskočit na obsah
Ověřeno

API

Volatelný koncový bod projektu, interní přes call_project_api nebo externí přes koncový bod api/mcp.

Program API je orchestrační vrstva s jedním výstupem: může navázat zdroj dat, koordinovat volání get_data, set_data a batch uvnitř svých vlastních událostí a vrátit jednu odpověď, tvarovanou šablonou, ne vazbami polí. Volejte ho zevnitř projektu pomocí akce workflow call_project_api, nebo se k němu dostanete zvenčí přes koncový bod api/mcp projektu.

Vlastnosti

progDataSource a progFields

Stejný tvar jako Zdroj dat, používá se, když API čte nebo zapisuje tabulku jako součást sestavení své odpovědi. progFields deklaruje pole dostupná šabloně odpovědi, table pro skutečné sloupce, virtual pro vypočítané.

scriptData: šablona odpovědi

Obsah je řetězcová šablona objektu v scriptData.value; vazby @field se vyhodnotí při volání, stejnou syntaxí výrazů jako všude jinde na platformě:

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

Volání programu API

Interně ho call_project_api spouští přesně tak, jako get_data nebo set_data spouštějí své typy programů, name.prog pojmenovává id API, name.parameters dodává jeho vstupy.

Pracovní příklad

Deklarujte rozhraní

progParams pro každou vstupní (dir: "in") a výstupní (dir: "out") hodnotu.

Navažte data, pokud je odpověď potřebuje

Volitelný progDataSource plus progFields pro sloupce, které šablonu napájejí.

Napište šablonu odpovědi

scriptData.value, řetězcový objekt se zástupnými @field, a nastavte apiOutput na formát, který mají volající dostat zpět.

Vytvořte uzel API pod Programy, nastavte apiOutput na jeho kartě Vlastnosti, volitelně navažte Zdroj dat a pak napište tvar odpovědi v editoru Odpověď.

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, zapsaný jako obyčejný výraz objektu, ne jako řetězec 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}" }
}