Rulebooks
rulebookのCSV取り込みを確定
POST
/api/v1alpha1/rulebooks/csv-imports確認済みのpreviewからrulebookを作成します。書き込みを行うのはこの呼び出しです。
- アクセス: alphaを有効にしたAPI keyと
MANAGE_RULEBOOKS権限。 - 送信する内容:
POST /api/v1alpha1/rulebooks/csv-imports/previewで得たsessionIdを、期限内に指定します。 - 返る内容: 作成されたrulebookの件数と、その内容。
- 再試行: 任意の
Idempotency-Keyにより、再送による二重の取り込みを防げます。
認証
apiKey 認証Bearer <token>
場所: header
ヘッダーパラメーター
Idempotency-Key?string
このPOSTを安全にretryするための任意のkeyです。keyは24時間保持され、request payloadと具体的なpath parameterと比較されます。
長さ
length <= 255リクエストボディ
application/json
TypeScript 型定義
TypeScript では request body 型を使用します。
レスポンスボディ
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 POST "https://example.com/api/v1alpha1/rulebooks/csv-imports" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "default_rulebook_name": "Imported Safety Rules", "mapping": { "additional_description_columns": [ "Notes" ], "rule_description": "Details", "rule_id": "Rule ID", "rule_title": "Requirement", "rulebook_name": "Section" }, "session_id": "rbi_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" }'{ "created_count": 2, "rulebooks": [ { "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" } ]}