取消 UI 协议会话置顶

维护当前用户会话记录。

DELETE https://api.moi.matrixorigin.cn/v5/sessions/{session_id}/pin

调用前准备

BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

配置同环境的身份、工作区和数值记录 ID。该入口采用普通产品身份认证,附加的任务运行期授权头会被拒绝。

请求

curl --request DELETE \
  "$BASE_URL/sessions/$SESSION_ID/pin" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"

参数

位置

类型

必填

说明

X-Workspace-ID

请求头

string

是

目标工作区 ID。

session_id

路径

integer

是

当前用户记录的正整数 ID。

返回 HTTP 200 和操作结果对象,不是 204。 按 system/pinned 设置或移除关系;通过置顶读取确认,不以会话对象中的空 tags 判断结果。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "message": "unpinned"
  }
}

字段

类型

说明

code

string

成功为 OK;HTTP 状态码为 200。

msg

string

成功为 OK。

data.message

string

操作结果:pinned、unpinned 或 deleted。

错误响应

错误格式和结果确认区分会话详情的 not-found 与其他入口的通用服务错误。

最后更新于