ブックの一覧を取得する
GraphQLクエリー
query getBooks($q: String!) {
organization {
books(q: $q, first: 100) {
nodes {
uid
name
description
pathname
bookType
workspace {
uid
name
}
}
}
}
}パラメーター
パラメーター名 | 必須 | 説明 |
|---|---|---|
q | 必須 | ブックの名称（一部でも可） |
GraphQLレスポンス
項目名 | 説明 |
|---|---|
books.nodes.uid | ブックのUID |
books.nodes.name | ブックの名称 |
books.nodes.description | ブックの説明 |
books.nodes.pathname | ブックのパス名 |
books.nodes.bookType | ブックの種類 |
books.nodes.workspace.uid | ワークスペースのUID |
books.nodes.workspace.name | ワークスペースの名称 |
レスポンスの例
{
"data": {
"organization": {
"books": {
"nodes": [
{
"uid": "bk_4ctwfhy1g2482hgtt1sec0hmb0",
"name": "サンプルのブック",
"description": "ドキュメントのサンプルです。",
"pathname": "42bcdf43edw7fwdmfx4ekyemen",
"bookType": "document",
"workspace": {
"uid": "ws_6sw5ppvcw5dg1hdkh3pp04thmm",
"name": "Runbookサンプル"
}
},
...
]
}
}
}
}最終更新:
