文档中心 > API类目 > iHome CBD API

alibaba.ihome.cbd.saas.hx.order.files.get (纯客户端软件场景,查询子订单设计方案详情)

大北窑项目,三方软件获取需要拆审的订单文件详情,从而在其软件中执行拆审操作

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
data String 必须 {"subOrderId": "P123-1"} 业务的关键参数:子订单 ID

响应参数

名称 类型 示例值 描述
result Result 接口返回model
  • data
  • Data
  • 设计方案文件详情
  • └ file_url
  • String
  • https://xxx/yyy/zzz.json
  • 子订单的下单文件 OSS URL
  • └ file_type
  • String
  • json
  • 子订单的下单文件类型
  • └ label_graph_urls
  • String []
  • ["https://xxx/xx.jpg"]
  • 当 fileType == json 时,对应下单标注图文件的 OSS URL 列表
  • └ attachment_file_urls
  • String []
  • ["https://xxx/xx.jpg"]
  • 子订单的下单附件文件 OSS URL 列表
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ error_code
  • String
  • isv.invalid-parameter
  • 错误码
  • └ error_msg
  • String
  • 参数错误
  • 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIhomeCbdSaasHxOrderFilesGetRequest req = new AlibabaIhomeCbdSaasHxOrderFilesGetRequest();
req.setData("{\"subOrderId\": \"P123-1\"}");
AlibabaIhomeCbdSaasHxOrderFilesGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<alibaba_ihome_cbd_saas_hx_order_files_get_response>
    <result>
        <data>
            <file_url>https://xxx/yyy/zzz.json</file_url>
            <file_type>json</file_type>
            <label_graph_urls>
                <string>[&quot;https://xxx/xx.jpg&quot;]</string>
            </label_graph_urls>
            <attachment_file_urls>
                <string>[&quot;https://xxx/xx.jpg&quot;]</string>
            </attachment_file_urls>
        </data>
        <success>true</success>
        <error_code>isv.invalid-parameter</error_code>
        <error_msg>参数错误</error_msg>
    </result>
</alibaba_ihome_cbd_saas_hx_order_files_get_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部