Rulebooks
rulebookの利用状況を取得
GET
/api/v1alpha1/rulebooks/{rulebook_id}/usage1件のrulebookに依存しているものを返します。変更や削除の影響を判断できます。
- アクセス: alphaを有効にしたAPI keyと
MANAGE_RULEBOOKS権限。 - 返る内容:
workflowCount、findingsTotal、関係するproject、hasActiveWorkflowRun。 - 範囲: 集計は自身の利用分のみです。同じ共有テンプレートに対する他者のrunは含まれません。
認証
apiKey 認証Bearer <token>
場所: header
パスパラメーター
rulebook_id*string
このkeyが読み取れるrulebookの識別子です。
レスポンスボディ
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/rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab/usage" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY"{ "findings_total": 3, "has_active_workflow_run": false, "projects": [ { "finding_count": 3, "name": "warehouse-shift-01.mp4", "source_id": "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" } ], "rulebook_id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "workflow_count": 1}