Zoho crm Logo

获取布局中的管道

目的

获取交易模块中所有或特定管道的详细信息。

Request 详情

Request URL

全部 - {api-domain}/crm/{version}/settings/pipeline?layout_id={layout_id}
特定的 - {api-domain}/crm/{version}/settings/pipeline/{pipeline_ID}?layout_id={layout_id}

标题

Authorization: Zoho-oauthtoken <access_token>

范围

scope=ZohoCRM.settings.pipeline.READ

端点

  • GET /settings/pipeline?layout_id={layout_ID}
  • GET /settings/pipeline/{pipeline_ID}?layout_id={layout_ID}
参数
  • layout_idstring, mandatory

    您想从中获取管道详细信息的交易模块中布局的唯一ID。请注意,此参数对于获取所有管道和特定管道是必需的。否则,系统会抛出错误。

样本请求

可能的错误

  • INVALID_DATAHTTP 400

    布局ID无效。
    解决方案:指定正确的布局ID。使用布局元数据API获取布局的ID。

  • REQUIRED_PARAM_MISSINGHTTP 400

    您在请求中没有包含必需的参数"layout_id"。
    解决方案:"layout_id"是从交易模块获取所有或特定管道时的必需参数。

  • NO_CONTENTHTTP 204

    您在请求中为管道ID传递了错误的值,或者您在该布局中没有创建管道。
    解决方案:在请求中指定正确的管道ID。

样本回应