Zoho crm Logo

获取导出审计日志任务的状态

目的

要检索之前安排的导出审计日志任务的详细信息,可以使用POST 导出审计日志API。

端点

  • GET /settings/audit_log_export
  • GET /settings/audit_log_export/{export_job_ID}

请求详情

Request URLs

获取所有导出审计日志任务的状态:
{api-domain}/crm/{version}/settings/audit_log_export 

获取特定导出审计日志任务的状态: 
{api-domain}/crm/{version}/settings/audit_log_export/{export_job_ID}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.audit_logs.READ 

示例回应

Response JSON

  • audit_log_exportJSON 数组

    包含审计日志导出请求的详细信息。

    • idstring

      代表导出审计日志任务的唯一任务ID。

    • status string 

      代表导出审计日志工作的状态。 

      可能的值: 进行中,已安排,已完成,和失败。 

    • job_start_timestring

      表示导出作业开始的时间。

    • job_end_timestring

      表示导出作业完成的时间。

    • expiry_datestring

      代表导出的审计日志在下载链接中的到期时间。

    • created_byJSON object

      代表启动导出工作的Zoho CRM用户的ID和名称。

    • criteriaJSON object

      代表使用创建导出审计日志API为特定的导出审计日志工作指定的条件。

    • download_linksJSON 数组

      代表导出审计日志结果的唯一可下载链接。您可以点击链接通过您登录的Zoho CRM直接下载结果,或者使用GET - 下载导出审计日志结果API来检索结果。

Possible Errors

  • NO_CONTENTHTTP 400

    没有安排审计日志
    解决方案:使用创建导出审计日志API导出新的审计日志。

  • INVALID_REQUEST_METHODHTTP 400

    http请求方法类型不是有效的
    解决方案:您指定了一个无效的HTTP方法来访问API URL。
    指定一个有效的请求方法。请参考上述端点部分。请参考上述请求URL部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有有效的范围来查看导出的审计日志。创建一个具有有效范围的新令牌。请参考上面的范围部分。

  • AUTHENTICATION_FAILUREHTTP 401

    身份验证失败
    解决方案:在API调用的请求头中传递访问令牌。

  • NO_PERMISSIONHTTP 403

    权限被拒绝
    解决方案:联系系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方案: 指定的请求URL不正确。请指定一个有效的请求URL。 请参考上面的请求URL部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现意外且未处理的异常。请联系支持团队。

示例回应