Siirry sisältöön
Tarkistettu

API

Projektin kutsuttava päätepiste, sisäinen komennolla call_project_api tai ulkoinen api/mcp-päätepisteen kautta.

API-ohjelma on orkestrointikerros, jolla on yksi tuloste: se voi sitoa datalähteen, koordinoida get_data-, set_data- ja batch-kutsuja omissa tapahtumissaan ja palauttaa yhden vastauksen, joka muotoillaan mallilla kenttäsidontojen sijaan. Kutsu sitä projektin sisältä työnkulkutoiminnolla call_project_api tai tavoita se ulkopuolelta projektin api/mcp-päätepisteen kautta.

Ominaisuudet

progDataSource ja progFields

Sama muoto kuin Datalähteellä, käytetään, kun API lukee tai kirjoittaa taulua osana vastauksensa muodostamista. progFields ilmoittaa vastausmallille käytettävissä olevat kentät, table oikeille sarakkeille ja virtual lasketuille.

scriptData: vastausmalli

Sisältö on merkkijonoksi muutettu objektimalli kohdassa scriptData.value. @field-sidonnat ratkaistaan kutsuhetkellä, samalla lausekesyntaksilla kuin kaikkialla muualla alustassa:

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

API-ohjelman kutsuminen

Sisäisesti call_project_api ajaa sen täsmälleen kuten get_data tai set_data ajaa omat ohjelmatyyppinsä: name.prog nimeää API:n tunnuksen, name.parameters antaa sen syötteet.

Käyttöesimerkki

Ilmoita rajapinta

progParams jokaiselle syöte- (dir: "in") ja tulosarvolle (dir: "out").

Sido data, jos vastaus tarvitsee sitä

Valinnainen progDataSource sekä progFields sarakkeille, jotka syöttävät mallia.

Kirjoita vastausmalli

scriptData.value, merkkijonoksi muutettu objekti @field-paikkamerkeillä, ja aseta apiOutput siihen muotoon, jonka kutsujien pitäisi saada takaisin.

Luo API-solmu Ohjelmat-kohdan alle, aseta apiOutput sen Ominaisuudet-välilehdellä, sido tarvittaessa Datalähde ja kirjoita sitten vastauksen muoto Vastaus-editorissa.

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>

.xu-tiedoston <response>-lohko on scriptData.value, kirjoitettuna tavallisena objektilausekkeena JSON-merkkijonon sijaan.

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