Skip to main content
POST
查询产物列表

限制说明

使用说明

  • scope 可选 all(默认 —— 调用者自己的个人产物 + 其所属全部团队的产物)、personal(仅自己创建的)、team(仅所属团队的团队产物)。
  • team_ids 可在可见范围内进一步限定团队 —— 调用者不属于的团队不会有任何返回。
  • 默认按 updated_at 倒序;设置 orderbycreated_at 可更换排序字段,asc: true 改为升序。
  • 使用 app_key 调用时,可见范围按 key 所属成员的身份计算 —— 返回该成员的个人产物及其所在团队的产物。

授权

app_key
string
query
必填

App key issued from the Flashduty console. Required on every public API call. Keep it secret — it grants the same access as the owning account.

请求体

application/json

产物库列表的过滤与分页参数。

scope
enum<string>
默认值:all

可见范围。all(默认)= 调用者自己的个人产物 + 其所在团队的产物;personal = 仅调用者自己创建的;team = 仅调用者所属团队的团队产物。

可用选项:
all,
personal,
team
team_ids
integer<int64>[]

只看指定团队的产物,与调用者可见范围取交集 —— 不属于调用者的团队不会有任何返回。

query
string

按产物标题做大小写不敏感的子串匹配。

page
integer
默认值:1

页码,从 1 开始。

必填范围: x >= 1
limit
integer
默认值:20

每页条数。默认 20,最大 100。

必填范围: x <= 100
orderby
enum<string>

排序字段:created_atupdated_at。留空按 updated_at 倒序。

可用选项:
created_at,
updated_at
asc
boolean

为 true 时升序,为 false 时降序。仅在设置了 orderby 时生效。

响应

Success

Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.

request_id
string
必填

本次请求的唯一 ID,与 Flashcat-Request-Id 响应头一致。反馈问题时请携带该 ID。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

响应结构中的错误 payload,仅在非 2xx 响应时出现。

data
object

一页产物列表。