Rulebooks
rulebookを一覧表示
GET
/api/v1alpha1/rulebooks利用できるrulebookを、更新が新しい順に返します。
- アクセス: alphaを有効にしたAPI keyと
MANAGE_RULEBOOKS権限。 - 内容: このkeyがワークスペース内で所有するrulebookと、誰でも利用できる共有テンプレート。
- ページング:
limitの既定値は25、最大は100。next_cursorをそのままcursorとして渡します。
各行のcanEditとcanDeleteが変更可否を示します。テンプレートは常に読み取り専用です。
認証
apiKey 認証Bearer <token>
場所: header
クエリパラメーター
cursor?string
前の応答のnext_cursorとして返されたopaqueなcursorです。decode、編集、組み立てをせず、そのままcursorとして渡してください。
limit?number
1ページで返すresource数です。既定値は25で、1から100まで指定できます。
形式
int32範囲
1 <= value <= 100デフォルト
25レスポンスボディ
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/v1alpha1/rulebooks" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY"{ "data": [ { "can_delete": true, "can_edit": true, "content": "Inspect every emergency exit.", "created_at": "2026-08-10T10:05:00.000Z", "created_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "has_active_workflow_run": false, "id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "is_template": false, "name": "Warehouse Safety", "owner_id": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "rules": [ { "description": "The exit remains unobstructed.", "id": "SEC-04", "title": "Emergency exit is clear.", "version": 2 } ], "template_key": "template_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "updated_at": "2026-08-10T10:06:00.000Z", "updated_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" } ], "has_more": false, "next_cursor": "MDEyMzQ1Njc4OWFitSLKnTQIcJAwDPi07V5EGs76Im3F8rCuUshrBnHuUJY7_8Ie8Stea_TKuhKhDw5XkRdkBI3IKkvsKT9Kp60Wpx7CoTCGQW8FnalDILVbuy8wxvWWf_B8SA"}