蓝图APIs
Zoho CRM的Blueprint只是业务流程的在线复制品。它在软件中捕获了您整个离线流程的每一个细节。它促进了自动化、验证和团队协作,从而使您的流程更加高效,避免了漏洞。
获取蓝图数据
目的
获取该记录的下一个可用转换,每个转换可用的字段,每个字段的当前值,以及它们的验证(如果有的话)。
端点
- GET /{module_API_name}/{record_ID}/actions/blueprint
Request 详情
Request URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/blueprint
支持的模块
潜在客户,账户,联系人,交易,活动,任务,案例,事件,会议,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,笔记,以及自定义
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.ALL
(或者)
scope=ZohoCRM.modules.{模块名称}.{操作类型}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,案例,事件,会议,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,笔记,和自定义
可能的操作类型
ALL - 对记录的完全访问
READ - 从模块获取记录
注意
- 转换可以是自动的,也可以是手动的。在自动转换中,记录在当前阶段设定的时间周期结束后自动移动到下一阶段。在transitions下的type键指的是当前状态的转换类型,而在next_transitions下的type键代表下一转换的转换类型。
- 您可以选择一个状态的升级时间周期。一旦到达升级时间,您可以执行诸如发送电子邮件警报,触发webhook等操作。这个时间周期在process_info下的escalation键中定义。
- 在并行转换中,一个转换可以有多个子转换。只有当所有子转换都完成时,父转换才会自动完成。我们将在后期介绍这个功能。请参阅这个公告以获取更多详细信息。
样本请求
可能的错误
- INVALID_MODULEHTTP 400
给出的模块名称似乎无效
解决方案:您指定的模块名称无效,或者没有标签权限,或者该模块可能已从可用模块中删除。请指定一个有效的模块API名称。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持
解决方案:当前API不支持诸如文档和项目等模块。(一旦这些模块得到支持,此错误将不会显示)。请指定一个有效的模块API名称。 - RECORD_LOCKEDHTTP 400
由于记录已被锁定,您无法执行此操作。
解决方案:请等待记录解锁。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参考上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.modules.{module_name}.READ范围。创建具有有效范围的新客户端。请参阅上面的范围部分。 - NO_PERMISSIONHTTP 403
拒绝读取记录的权限
解决方案:用户没有读取蓝图数据的权限。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。 - RECORD_NOT_IN_PROCESSHTTP 400
记录未在处理中
解决方案:您指定的记录不在任何处理中。请指定另一个记录id。 - INVALID_REQUEST_METHODHTTP 400
所请求的 HTTP 方法类型无效
解决方案:您指定了无效的 HTTP 方法来访问API URL。请指定一个有效的请求方法。请参考上述端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来读取记录
解决方案:用户没有权限读取蓝图数据。请联系您的系统管理员。