帮助中心API对内容块的限制
如果为一篇或多篇文章启用了内容块,那么帮助中心API有一定的限制。本文描述了这些限制。
内容块允许文章作者在多篇文章中插入相同的内容。看到用内容块重用内容在Ze亚博ndesk帮助。帮助中心中的某些文章可能启用了内容块,而其他文章可能没有。
帮助中心API在未启用内容块的文章中表现正常。
展示或列出物品
你可以使用显示文章和文章列表端点,用于获取启用了内容块的文章。但是,在响应中,任何内容块的内容都被转换为普通的内联文本。例子:
“身体”:"
本文已启用内容块。
\n这是一个内容块。
\n这是文章的其余部分。
"
更新文章或翻译
的初始GET请求身体
对于具有要在更新请求中使用的内容块的文章,文章中任何内容块的内容都将在GET响应中转换为普通文本。
更新任何其他属性不会影响文章中的任何内容块。
存档文章
你可以使用档案的文章用于存档包含内容块的文章的端点。
在API请求中使用文章id
要为GET、PUT或DELETE请求标识一个条目,请使用条目id
由文章列表端点。不要使用指南管理界面中文章URL中显示的文章id。
当内容块为一篇文章启用,文章的URL在指南管理界面看起来如下:
https://z3ndocs-zsuite-enterprise.亚博zendesk.com/knowledge/editor/01FVDPK3FEJTBPQE3Q21FQE99M/en-us?brand_id=1260800167610
你不能用01 fvdpk3fejtbpqe3q21fqe99m
作为帮助中心API的参数。它是管理界面的特殊id。
启用内容块
该API不支持在新文章或现有文章上启用内容块。内容块必须在指南中启用。看到启用内容块在Ze亚博ndesk帮助。