RemoteGymp · API v1

Kirjoita tiedot

Päivitä mukautetut kentät ja ylläpitoikkunat, suorita automaatio ja yritä kirjoittaa uudelleen turvallisesti.

API ja MCP tukevat jonoitettuja tehtäviä, ajastettua virtaa, agentin poistamista, päätelaitteen diagnostiikkaa, komennon peruuttamista ja kolmannen osapuolen korjauskäytäntöjä. Käytä uudelleen idempotenssiavaimia ja tarkista kuitit. Väliaikaiset ylläpitäjän käyttöoikeudet palautetaan kerran. Liikenteen valvonta vaatii olemassa olevan luvan; laskutus pysyy sovelluksessa.

  1. Tarkista käyttöoikeutesi

    Esiasetukset valitsevat yksittäisiä ominaisuuksia; ne eivät muuta käyttöoikeustasoa. Uudet tunnistetiedot asetuksissa käyttävät oletusarvoisesti FullAccess:aa, mutta vain valitut ominaisuudet sallitaan. Vanhemmat ReadWrite-tunnistetiedot sallivat hyväksytyt mukautettujen kenttien ja ylläpidon muutokset. Automaatio ja laitehallinta tarvitsevat FullAccess:n sekä omat ominaisuutensa. Tarkista GET /v1/operations/capabilities ennen kirjoittamista. Yrityksen laajuus ja nykyisen omistajan käyttöoikeudet ovat edelleen voimassa.

  2. Vältä toisen muutoksen päällekirjoittamista

    Lue mukautettu kenttä ja sen versio. Lähetä uusi arvo ja lukemasi versio osoitteeseen PATCH /v1/custom-fields/{fieldId}. Vika 409 version_conflict tarkoittaa, että joku muutti sitä ensin. Lue se uudelleen ja päätä, onko päivityksesi edelleen sopiva.

  3. Yritä uudelleen turvallisesti

    POST /v1/maintenance-windows varten, lähetä Idempotency-Key otsikko. Epävarman tuloksen jälkeen toista sama avain ja runko saadaksesi alkuperäisen ikkunan sen sijaan, että loisit kopion. Muutettu runko samalla avaimella hylätään. DELETE /v1/maintenance-windows/{windowId} peruuttaa ikkunan.

  4. Seuraa toimintokuittauksia

    Automaatio- ja hallintakirjoitukset käyttävät idempotencyKey-arvoa JSON-rungossa ja palauttavat toimintokuittauksen. Completed tarkoittaa, että pyynnön käsittelijä on valmis; tarkista tulos tai toimialueen suoritus selvittääksesi, onko laite suorittanut työn loppuun. OutcomeUnknown-pyynnön tapauksessa tarkista kuitti ja nykyinen tila ennen kuin päätät, mitä tehdä. Älä koskaan lähetä automaattisesti uudelleen uudella avaimella: toiminto voi käynnistyä kahdesti.

API-viite →

Sisällön versio 3f225a253 · OpenAPI SHA-256: b12c42306a89