更新时间:2025-08-18 GMT+08:00
分享

查询单个规划

功能介绍

查询单个规划。

调用方法

请参见如何调用API

URI

GET /v3/plan/{project_id}/{plan_id}/info

表1 路径参数

参数

是否必选

参数类型

描述

plan_id

String

参数解释:

规划的id,通过分页查询当前项目用户可见的所有规划接口获取,响应消息体中的id字段的值就是规划的id。

约束限制

32位的数字和字母组成的字符串。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

32位的数字和字母组成的字符串。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

取值范围:

不涉及。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功

error :返回失败

表4 result

参数

参数类型

描述

id

String

参数解释:

规划id。

取值范围:

不涉及。

name

String

参数解释:

规划名称。

取值范围:

不涉及。

type

String

参数解释:

规划类型。

取值范围:

gantt(甘特规划)

mind(思维导图)

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

取值范围:

不涉及。

creator

creator object

参数解释:

建立规划的用户。

取值范围:

不涉及。

updater

updater object

参数解释:

更新规划的用户。

取值范围:

不涉及。

created_on

String

参数解释:

工作项的创建时间,时间戳格式(示例:1839340800000)。

取值范围:

不涉及。

updated_on

String

参数解释:

工作项的更新日期,时间戳格式(示例:1839340800000)。

取值范围:

不涉及。

表5 creator

参数

参数类型

描述

user_id

String

参数解释:

用户id。

取值范围:

不涉及。

domain_id

String

参数解释:

域名id。

取值范围:

不涉及。

nick_name

String

参数解释:

用户昵称。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

表6 updater

参数

参数类型

描述

user_id

String

参数解释:

用户id。

取值范围:

不涉及。

domain_id

String

参数解释:

域名id。

取值范围:

不涉及。

nick_name

String

参数解释:

用户昵称。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

请求示例

{endpoint}/v3/plan/381fcca9c056482d92da3e8b9da71db5/c573497c87414e97a29444c0054c1361/info

响应示例

状态码:200

查询单个规划的返回信息。

{
  "result" : {
    "id" : "f8f870c2b84548548cb75aa61382b894",
    "name" : "00000",
    "type" : "gantt",
    "project_id" : "c15cc54e338d4506afd9bd8103071ff0",
    "creator" : {
      "user_id" : "xxxxxx",
      "domain_id" : "xxxxxx",
      "nick_name" : "xxxxxx",
      "first_name" : "xxxxxx"
    },
    "updater" : {
      "user_id" : "xxxxxx",
      "domain_id" : "xxxxxx",
      "nick_name" : "xxxxxx",
      "first_name" : "xxxxxx"
    },
    "created_on" : "1752828658000",
    "updated_on" : "1752828658000"
  },
  "status" : "success"
}

状态码

状态码

描述

200

查询单个规划的返回信息。

错误码

请参见错误码

相关文档