为了: 管理员
使用中心键向案例添加备注
使用您自己的软件创建案件内部备注,向他们提供文档和文件,并选择哪些角色可以查看这些备注。
在本文中7 个部分
开始之前
此页面介绍了如何使用中心键添加和读取某个案例的注释笔记 案件内部记录,只有拥有相应权限的人员才能查看;除非公司更改规定,否则客户无法查看。。相关路径位于https://prd-api-app.caseactive.com/v1/<hub id>/<case id>之下。
电话
| 称呼 | 它的作用 |
|---|---|
GET /notes/templates | 列出您的笔记模板 |
POST /notes | 创建一条笔记 |
GET /notes | 列出案件的各项记录,最新的内容排在最前面。 |
GET /notes/<note_id> | 只读取了一条注释 |
PUT /notes/<note_id> | 修改音符的标题,或者改变查看该音符的人。 |
DELETE /notes/<note_id> | 删除一条笔记以及与之相关的文件。 |
笔记是一种用于记录团队相关信息的文档,其中包含与笔记相关的所有文件。笔记的内容就是这些文档本身:可以基于模板创建笔记,也可以在笔记已经创建之后直接上传PDF或Word文件。系统中没有文本输入字段。也不会有人知道何时有新的笔记被添加或修改,同时笔记也不会发送任何Web钩通知。
创建笔记
| 场地 | 它的作用 | 必需的 | 默认 |
|---|---|---|---|
name | 这张纸条上的标题。只包含字母、数字、空格以及& ' - _ ( ) . /符号;不允许使用逗号、冒号、问号或引号。 | 是的 | — |
permissions | 该文本已经是中文,不需要再进行翻译。如果你有其他问题或需要帮助,请随时告诉我。 角色/职责角色 一组权限,用于决定某人(例如员工或客户)可以查看和处理案件的哪些内容。 能够看到它的人,比如 ["role::staff"]. 只有能够读取注释的角色才能执行这些操作。 | 不 | 该模板的权限,即所有可以读取笔记的权限。 |
template | 从 {"owner": "host", "template_id": "<asset_id>"} 地点,携带模板的文档和文件到 GET /notes/templates 地点;或者复制与本案相关的笔记到 {"owner": "case", "template_id": "<note_id>"} 地点。 | 不 | 没有 |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/notes \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Case representation letter", "permissions": ["role::staff"], "template": {"owner": "host", "template_id": "note::20260915101500_5e4d3c2b1a0f90"}}'
这回答了问题。 201 随着 note_id.
- 从模板中,该笔记会获得模板中的文档、文件以及相关角色信息;而诸如客户名称之类的代码则会在创建笔记时一次性被填充进去。至于表示创建者身份的代码,比如他们的名字,则会使用虚拟助理的详细信息来进行填写,而这些详细信息又包含了公司的名称。该笔记的标题不会被复制:直接发送
name即可。 - 这份案件的副本仍然保留着原来所书写或绘制的文字内容,除非你选择用
schema来替换这些内容。在制作副本时,所有的代码都会重新填写一遍。 - 如果没有模板,接下来请上传文档:使用
media_group=schemas来指定地址,然后上传PDF或Word文件,并使用PUT /notes/<note_id>/schema/media进行附件添加。Word文件会被转换为PDF格式。一个“笔记”可以包含多个文档。详见如何使用中心键上传和添加文件部分说明。 - 其他文件,比如照片或录音等,可以使用
PUT /notes/<note_id>/media进行附件上传。
谁看到了它
处于该笔记所属角色的用户可以打开该笔记。而由管理员担任的审核角色能够查看所有笔记。客户则无法查看这些笔记,除非管理员授予了客户相应的访问权限;有关如何更改角色权限的具体操作,请参见如何改变角色的权限范围部分说明。
札记
GET /notes接受limit(默认值为20,最高可达1000)和start_key作为参数,并且像所有列表一样进行分页处理。每个键对应列表中的一个条目。每个条目包含以下内容:
| 场地 | 它包含什么 |
|---|---|
note_id, case_id | 它们的标识符 |
name | 它的标题 |
user_id | 是谁制作了它?是虚拟助手的身份识别系统,还是通过某种自动化流程实现的呢? |
permissions | 那些能够看到它的人会扮演一定的角色。而当所有能够阅读笔记的人都能看到它时,原本被排除在外的人也就有了发挥作用的机会。 |
schema_media | 其文档的media_id部分 |
media, media_ct | 这些文档和文件按照类型进行了分类,数量也相当可观。可以按照使用中心密钥进行下载并上传文件的方式来获取它们。 |
schema | 人们在即时JSON格式文件中输入或绘制的内容 |
template_id | 该模板正是用来制作这个内容的 |
created_on, updated_on | 该内容完成并最后一次更新时的时间,以UTC格式表示。 |
GET /notes/templates 列出了您已发布的笔记 模板模板 可重复使用的动态帖子、表单、电子签名、笔记或任务保存在库中,并复制到案例中。,这些模板按照更新顺序排序,最新的在最上方。每个模板的 asset_id、title、description 和 permissions 属性也会有所显示。
更改和删除
PUT /notes/<note_id>接受name和permissions作为参数,并且只修改你提供的那些部分。键可以改变案例中的任何音符。如果permissions列表为空,则会被拒绝;请务必提供该音符应该属于的角色信息。如果主体中没有这一音符,同样会被拒绝。
DELETE /notes/<note_id>会删除所有的笔记,包括相关的文档和文件。没有人会被通知这一点。
如果电话被拒绝
| 地位 | message | 为什么 |
|---|---|---|
| 400 | SchemaFieldsException | 某个字段缺失或无效,例如 name 中的逗号位置错误、permissions 列表为空,或者您的中心没有该角色;errors 中已标注了相关字段的名称。 |
| 400 | SchemaFieldsException,其中ItemCopyNotAllowedException位于template处 | 该模板尚未发布,也无法被机器人角色访问,或者其文件目前仍在处理中。 |
| 400 | SchemaFieldsException,其中NoteRoleCannotReadNotesException位于permissions.<n>处 | 在permissions中扮演的角色无法读取注释信息。 |
| 403 | HostModuleDisabledException | 这些笔记已关闭,不再显示在你的中心设备上;或者它们被隐藏在了这个保护套之中。 |
| 403 | CaseClosedException | 此案已经结案。 |
| 404 | ItemNotFoundException | 这张纸条并不存在。 |
关于错误 bodies 以及其他代码格式,请参考 处理 API 错误和状态代码 的相关说明。