Skip to content

Organization API ​

由 scripts/generate-api-docs.ts 自动生成 —— 请勿手改 共 12 个端点

GET /organization ​

列出组织(主数据,已合并的别名不出现)

响应 ​

状态码说明
200

POST /organization ​

创建组织(orgId 由平台生成,调用方只给名称与币种)

请求体 ​

json
{
  "$ref": "#/components/schemas/UpsertOrganizationDto"
}

响应 ​

状态码说明
201

GET /organization/{orgId} ​

读组织(含当前审批策略与两个版本号)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

响应 ​

状态码说明
200

PUT /organization/{orgId} ​

创建或更新组织(版本 +1)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

请求体 ​

json
{
  "$ref": "#/components/schemas/UpsertOrganizationDto"
}

响应 ​

状态码说明
200

POST /organization/{orgId}/agents ​

把 agent 绑到组织(需是该 agent 的 owner + 该组织管理员)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

请求体 ​

json
{
  "$ref": "#/components/schemas/BindAgentDto"
}

响应 ​

状态码说明
201

POST /organization/{orgId}/agents/{agentId}/unbind ​

把 agent 从组织解绑(需是该 agent 的 owner + 该组织管理员)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅
agentIdpathstring✅

响应 ​

状态码说明
201

GET /organization/{orgId}/approval-policy ​

读当前审批策略(未配置 ⇒ 默认空链,version=0)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

响应 ​

状态码说明
200

PUT /organization/{orgId}/approval-policy ​

更新审批策略(每次实质变更追加一版,留痕;无差异不造版本)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

请求体 ​

json
{
  "$ref": "#/components/schemas/UpsertApprovalPolicyDto"
}

响应 ​

状态码说明
200

GET /organization/{orgId}/approval-policy/history ​

审批链变更留痕(只追加,每条带与上一版的差异)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

响应 ​

状态码说明
200

POST /organization/{orgId}/approvals ​

跑一次审批决策:读真实策略 → 同一纯函数 → 落 state(带策略版本)

请求参数 ​

参数名位置类型必填说明
orgIdpathstring✅

请求体 ​

json
{
  "$ref": "#/components/schemas/DecideApprovalDto"
}

响应 ​

状态码说明
201

GET /organization/accessible ​

我可读写业务数据的组织(owner ∪ member,业务界面用)

响应 ​

状态码说明
200

GET /organization/mine ​

我以 owner 身份可管理的组织(客户侧身份,不依赖平台角色)

响应 ​

状态码说明
200

Released under the MIT License.