文档中心 > API类目 > 书旗内容文巢

alibaba.shuqi.content.backend.search.getitemlist (查询item列表)

查询item列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
emp_id String 可选 1 工号
item_type String 可选 1 item生成类型,1:UC同步,2:自动生成,3:原创
book_status Number 可选 1 书籍Android状态,1上架,2隐藏可阅读-新章节可读,3隐藏可阅读-新章节不可读,4下架
shelf_status Number 可选 1 item上下线状态 * 0:初始状态 * 1:上线 * 2:下线
item_title String 可选 1 标题,支持模糊查询
info_status Number 可选 1 标题导语状态 * 0:初始 * 1:待审核(初次编辑完成,驳回修改后) * 2:审核驳回(审核驳回标题导语) * 3:审核通过(审核通过标题导语)
cp_id Number 可选 1 cp的id
item_ids String 可选 1 item ID,多个以逗号分隔
need_export Boolean 可选 true true是需要导出,不传或者false不导出
signs String 可选 1 签名
page_size Number 可选 10 每页数量,默认每页数量10,最大不超过50
type Number 可选 1 1:item列表查询,2:标题导语列表查询,3:正文列表查询
book_name String 可选 1 书名,支持模糊查询
content_status Number 可选 1 正文审核状态 * 0:初始 * 1:待审核(初次标题导语审核通过,驳回修改后) * 2:审核驳回(审核驳回正文) * 3:审核通过(审核通过正文,item status也通过,item上线状态)
item_status Number 可选 1 0:初始(待编辑) * 1:审核中(编辑完成,驳回后再提交) * 2:标题导语驳回 * 3:正文驳回 * 4:标题导语审核通过(标题导语,正文都通过)
emp_name String 可选 1 员工名字
bids String 可选 1 书旗BID,多个以逗号分隔
start_time Date 可选 2022-11-11 11:11:11 进审起始时间
page Number 可选 1 第几页,起始页为1
end_time Date 可选 2022-11-11 11:11:11 进审结束时间
email String 可选 1 邮箱
timestamps Number 可选 1 时间戳

响应参数

名称 类型 示例值 描述
data PageResponse 返回值
  • list
  • ItemSearchBizResponse []
  • 返回数据
  • └ item_id
  • Number
  • 1
  • item id
  • └ book_id
  • Number
  • 1
  • 书籍id
  • └ book_name
  • String
  • 1
  • 书名
  • └ author_name
  • String
  • 1
  • 作者名
  • └ book_status
  • Number
  • 1
  • 书籍Android状态,1上架,2隐藏可阅读-新章节可读,3隐藏可阅读-新章节不可读,4下架
  • └ cp_name
  • String
  • 1
  • cp名称
  • └ item_title
  • String
  • 1
  • 标题
  • └ item_summary
  • String
  • 1
  • 导语
  • └ item_type
  • Number
  • 1
  • 类型,0:未知,1:UC同步,2:自动生成,3:原创
  • └ trial_time
  • Date
  • 2022-11-11 11:11:11
  • 进审时间
  • └ shelf_status
  • Number
  • 1
  • 上下线状态 * 0:初始状态 * 1:上线 * 2:下线
  • └ item_status
  • Number
  • 1
  • 状态 * 0:初始(待编辑) * 1:审核中(编辑完成,驳回后再提交) * 2:标题导语驳回 * 3:正文驳回 * 4:标题导语审核通过(标题导语,正文都通过)
  • └ info_status
  • Number
  • 1
  • 标题导语状态 * 0:初始 * 1:待审核(初次编辑完成,驳回修改后) * 2:审核驳回(审核驳回标题导语) * 3:审核通过(审核通过标题导语)
  • └ content_status
  • Number
  • 1
  • 正文审核状态 * 0:初始 * 1:待审核(初次标题导语审核通过,驳回修改后) * 2:审核驳回(审核驳回正文) * 3:审核通过(审核通过正文,item status也通过,item上线状态)
  • └ reject_reason
  • String
  • 1
  • 驳回原因
  • └ offline_reason
  • String
  • 1
  • 下线原因
  • └ total
  • Number
  • 1
  • 数量
  • └ sum_page
  • Number
  • 1
  • 总页码
state Number 200 状态码
message String success 状态信息
status Number 200 状态码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiContentBackendSearchGetitemlistRequest req = new AlibabaShuqiContentBackendSearchGetitemlistRequest();
req.setEmpId("1");
req.setItemType("1");
req.setBookStatus(1L);
req.setShelfStatus(1L);
req.setItemTitle("1");
req.setInfoStatus(1L);
req.setCpId(1L);
req.setItemIds("1");
req.setNeedExport(true);
req.setSigns("1");
req.setPageSize(10L);
req.setType(1L);
req.setBookName("1");
req.setContentStatus(1L);
req.setItemStatus(1L);
req.setEmpName("1");
req.setBids("1");
req.setStartTime(StringUtils.parseDateTime("2022-11-11 11:11:11"));
req.setPage(1L);
req.setEndTime(StringUtils.parseDateTime("2022-11-11 11:11:11"));
req.setEmail("1");
req.setTimestamps(1L);
AlibabaShuqiContentBackendSearchGetitemlistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_shuqi_content_backend_search_getitemlist_response>
    <data>
        <list>
            <item_search_biz_response>
                <item_id>1</item_id>
                <book_id>1</book_id>
                <book_name>1</book_name>
                <author_name>1</author_name>
                <book_status>1</book_status>
                <cp_name>1</cp_name>
                <item_title>1</item_title>
                <item_summary>1</item_summary>
                <item_type>1</item_type>
                <trial_time>2022-11-11 11:11:11</trial_time>
                <shelf_status>1</shelf_status>
                <item_status>1</item_status>
                <info_status>1</info_status>
                <content_status>1</content_status>
                <reject_reason>1</reject_reason>
                <offline_reason>1</offline_reason>
            </item_search_biz_response>
        </list>
        <total>1</total>
        <sum_page>1</sum_page>
    </data>
    <state>200</state>
    <message>success</message>
    <status>200</status>
</alibaba_shuqi_content_backend_search_getitemlist_response>

异常示例

  • XML示例
  • JSON示例
<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

返回
顶部