RemoteGymp · API v1

Scríobh sonraí

Nuashonraigh réimsí saincheaptha agus fuinneoga cothabhála, rith uathoibriú agus déan iarracht scríobh arís go sábháilte.

Tacaíonn an API agus MCP le poist i líne, cumhacht sceidealaithe, díshuiteáil gníomhaire, diagnóisí deiridhphointe, cealú ordú agus beartais péirse tríú páirtí. Déan eochracha idempotency a athúsáid agus iniúchadh a dhéanamh ar admhálacha. Filleann deimhnithe sealadacha riarthóra uair amháin. Éilíonn monatóireacht tráchta cead atá ann cheana; fanann billeáil san iarratas.

  1. Seiceáil do cheadanna

    Roghnaíonn réamhshocruithe cumais aonair; ní athraíonn siad an leibhéal rochtana. Úsáideann dintiúir nua i Socruithe FullAccess de réir réamhshocraithe, ach ní cheadaítear ach na cumais roghnaithe. Ceadaíonn dintiúir ReadWrite níos sine athruithe ceadaithe ar réimsí saincheaptha agus cothabhála. Teastaíonn FullAccess móide a gcumas sonracha ó uathoibriú agus rialú gléasanna. Seiceáil GET /v1/operations/capabilities sula scríobhtar. Tá feidhm fós ag raon feidhme na cuideachta agus ceadanna an úinéara reatha.

  2. Seachain athrú eile a róscríobh

    Léigh an réimse saincheaptha agus a leagan. Seol do luach nua agus an leagan a léigh tú chuig PATCH /v1/custom-fields/{fieldId}. A 409 version_conflict Ciallaíonn sé gur athraigh duine éigin é ar dtús. Léigh arís é agus cinntigh an bhfuil do nuashonrú fós oiriúnach.

  3. Athiarracht shábháilte

    I gcás POST /v1/maintenance-windows, seol ceanntásc Idempotency-Key. Tar éis toradh neamhchinnte, déan an eochair agus an corp céanna a athdhéanamh chun an fhuinneog bhunaidh a aisghabháil seachas dúblach a chruthú. Diúltaítear corp athraithe leis an eochair chéanna. Cealaíonn DELETE /v1/maintenance-windows/{windowId} fuinneog.

  4. Admhálacha gníomhaíochta leantacha

    Úsáideann uathoibriú agus scríobh bainistíochta idempotencyKey i gcorp JSON agus seoltar admháil oibríochta ar ais. Ciallaíonn Completed gur chríochnaigh an láimhseálaí iarratais; seiceáil an toradh nó an rith fearainn chun a fháil amach an bhfuil an fheiste críochnaithe leis an obair. I gcás OutcomeUnknown, déan iniúchadh ar an admháil agus ar an staid reatha sula ndéanann tú cinneadh faoi cad atá le déanamh. Ná hathsheol go huathoibríoch faoi eochair nua: d'fhéadfadh an gníomh rith faoi dhó.

Tagairt API →

3f225a253 athbhreithnithe ábhair · OpenAPI SHA-256: b12c42306a89