Gå til indhold
Bekræftet

API

Et kaldbart endpoint i projektet, internt via call_project_api eller eksternt via endpointet api/mcp.

Et API-program er et orkestreringslag med ét output: det kan binde en datakilde, koordinere get_data-, set_data- og batch-kald i sine egne hændelser og give ét svar tilbage, formet af en skabelon i stedet for af feltbindinger. Kald det indefra projektet med workflow-handlingen call_project_api, eller nå det udefra gennem projektets endpoint api/mcp.

Egenskaber

progDataSource og progFields

Samme form som Datakilde, bruges når API'et læser eller skriver en tabel som led i at bygge sit svar. progFields erklærer de felter, der er tilgængelige for svarskabelonen, table for rigtige kolonner, virtual for beregnede.

scriptData: svarskabelonen

Payloaden er en skabelon som streng-objekt i scriptData.value. @field-bindinger opløses ved kaldet, med den samme udtrykssyntaks som alle andre steder på platformen:

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

Kald et API-program

Internt kører call_project_api det præcis som get_data eller set_data kører deres programtyper, name.prog angiver API'ets id, og name.parameters leverer dets input.

Eksempel

Erklær grænsefladen

progParams for hver inputværdi (dir: "in") og outputværdi (dir: "out").

Bind data, hvis svaret har brug for det

En valgfri progDataSource samt progFields for de kolonner, der fodrer skabelonen.

Skriv svarskabelonen

scriptData.value, et streng-objekt med @field-pladsholdere, og sæt apiOutput til det format, kalderne skal have tilbage.

Opret en API-node under Programmer, sæt apiOutput under fanen Egenskaber, bind eventuelt en Datakilde, og skriv derefter svarets form i editoren Svar.

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>

Blokken <response> i .xu er scriptData.value, skrevet som et almindeligt objektudtryk i stedet for en JSON-streng.

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}" }
}