RemoteGymp · API v1

写入数据

安全地更新自定义字段和维护窗口,运行自动化并重试写入。

API 和 MCP 支持排队作业、计划开关机、代理卸载、端点诊断、命令取消和第三方补丁策略。重用幂等性密钥并检查收据。临时管理员凭据只返回一次。流量监控需要现有许可;计费仍保留在应用程序中。

  1. 检查您的权限

    预设用于选择特定功能;它们不会更改访问级别。“设置”中的新凭据默认使用 FullAccess,但仅允许使用选定的功能。旧的 ReadWrite 凭据允许对自定义字段和维护进行已批准的更改。自动化和设备控制需要 FullAccess 及其特定功能。写入前请检查 GET 和 /v1/operations/capabilities。公司范围和当前所有者权限仍然有效。

  2. 避免覆盖其他更改

    读取自定义字段及其版本将您的新值和读取的版本发送到 PATCH /v1/custom-fields/{fieldId}.。如果出现 409 version_conflict 错误,则表示有人已先对其进行了更改。请再次读取并确定您的更新是否仍然适用。

  3. 安全重试

    对于 POST /v1/maintenance-windows,请发送 Idempotency-Key 标头。如果结果不确定,请重复使用相同的键和正文以检索原始窗口,而不是创建副本。使用相同键但已更改的正文将被拒绝。DELETE /v1/maintenance-windows/{windowId} 用于取消窗口。

  4. 跟踪操作回执

    自动化和管理写入操作在 JSON 正文中使用 idempotencyKey 并返回操作回执。 Completed 表示请求处理程序已完成;请检查结果或域运行情况,以了解设备是否已完成工作。对于 OutcomeUnknown,请在决定执行操作之前检查回执和当前状态。切勿使用新密钥自动重新发送:此操作可能会执行两次。

API 参考 →

内容修订3f225a253 · OpenAPI SHA-256: b12c42306a89