将自定义字段移出资源

将自定义字段从资源中移出。移除后，该资源将无法再使用该字段。目前资源的类型支持"tasklist"。

如果要移除自定义字段本来就不存在于资源，本接口将正常返回。

注意自定义字段是通过清单来实现授权的，如果将自定义字段从所有关联的清单中移除，就意味着任何调用身份都无法再访问改自定义字段。

Tip: 需要资源的可编辑权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/task/v2/custom_fields/:custom_field_guid/remove
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	task:custom_field:write 查看、创建、更新自定义字段

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
custom_field_guid	string	自定义字段GUID。自定义字段GUID。可以通过创建自定义字段接口创建, 或者通过列取自定义字段接口查询得到。 示例值："0110a4bd-f24b-4a93-8c1a-1732b94f9593"

请求体

名称	类型	必填	描述
resource_type	string	是	要从某个资源移除自定义字段的资源类型，目前只支持清单。 示例值："tasklist"
resource_id	string	是	要从某个资源移除自定义字段的资源id，resource_type为"tasklist"时，需填写清单的GUID。 示例值："0110a4bd-f24b-4a93-8c1a-1732b94f9593"

请求体示例

{
    "resource_type": "tasklist",
    "resource_id": "0110a4bd-f24b-4a93-8c1a-1732b94f9593"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	请求参数错误，如向resource_type传入了不支持的类型。	错误原因见返回的msg提示的信息。
403	1470403	缺少将自定义字段从资源移出的权限。	确认调用身份拥有资源的编辑权限。
404	1470404	要被移除的自定义字或者要移出的资源不存在或已删除。	确认要被移除的自定义字或者要移出的资源是否存在或已删除。
500	1470500	服务器错误。	尝试重试调用。如持续失败，请联系支持人员进行反馈。