OpenMax
免费试用

Apps API · Blueprints

Blueprints: 5 个接口

← 全部分组

GET /api/v1/blueprints/{blueprint_id}

Get blueprint

权限(scope): work:blueprint:read · 调用方式: appToken · operationId: get-blueprint

Required app scope: work:blueprint:read.

Returns a blueprint by ID. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
blueprint_id path string (uuid) 是 Blueprint UUID
include_steps query boolean Whether to include steps

回包

PUT /api/v1/blueprints/{blueprint_id}/steps

Set blueprint steps

权限(scope): work:blueprint:write · 调用方式: appToken · operationId: set-blueprint-steps

Required app scope: work:blueprint:write.

Replaces all blueprint steps. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
blueprint_id path string (uuid) 是 Blueprint UUID

请求体

application/json · SetStepsRequestBody

字段 类型 必填 说明
steps array of StepInput 是 Replacement blueprint steps

回包

POST /api/v1/blueprints/{blueprint_id}/submit-for-approval

Submit blueprint for approval

权限(scope): work:blueprint:write · 调用方式: appToken · operationId: submit-blueprint-for-approval

Required app scope: work:blueprint:write.

Submits the blueprint for approval. Kept for compatibility; generic approvals use /api/v1/approvals.

参数

名字 位置 类型 必填 说明
blueprint_id path string (uuid) 是 Blueprint UUID

回包

GET /api/v1/issues/{issue_id}/blueprints

List blueprint versions

权限(scope): work:blueprint:read · 调用方式: appToken · operationId: list-blueprint-versions

Required app scope: work:blueprint:read.

Returns blueprint versions for an issue. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc

回包

POST /api/v1/issues/{issue_id}/blueprints

Create blueprint

权限(scope): work:blueprint:write · 调用方式: appToken · operationId: create-blueprint

Required app scope: work:blueprint:write.

Creates a blueprint for an issue. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · CreateBlueprintRequestBody

字段 类型 必填 说明
estimated_budget object Estimated budget JSON object
notes string Blueprint notes
steps array of StepInput 是 Blueprint steps

回包