# 说明

获取需求自定义字段配置

# SDK 方法名

nodeJs:

SDK使用方式 (opens new window)

插件中使用SDK

方法名::

getStoryCustomFieldsSettings
1

# url

https://api.tapd.cn/stories/custom_fields_settings

# 支持格式

JSON/XML(默认JSON格式)

# HTTP请求方式

GET

# 请求数限制

一次只能获取一个项目的配置

# 请求参数

字段名 必选 类型及范围 说明 特殊规则
workspace_id integer 项目ID

# 调用示例及返回结果

# 获取需求自定义字段配置

# curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' 'https://api.tapd.cn/stories/custom_fields_settings?workspace_id=10158231'

# 返回结果

{
    "status": 1,
    "data": [
        {
            "CustomFieldConfig": {
                "id": "1010158231214877065",
                "workspace_id": "10158231",
                "entry_type": "story",
                "custom_field": "custom_field_100",
                "type": "radio",
                "name": "是否",
                "options": "{\"1\":\"yes\",\"2\":\"no\"}",
                "enabled": "1",
                "sort": null,
                "memo": null
            }
        }
    ],
    "info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 返回字段说明

字段 说明
id 自定义字段配置的ID
workspace_id 所属项目ID
entry_type 所属实体对象
custom_field 自定义字段标识(英文名)
type 输入类型
name 自定义字段显示名称
options 自定义字段可选值
enabled 是否启用
sort 显示时排序系数
上次更新: 2024-05-16 14:58:20