スクリプティング

JSON 入力、ページ分割、再試行、スクリプト向けの出力を説明します。


--request で、リクエスト全体のパラメータを JSON・ファイル・標準入力から渡せます。個別のオプションで指定した値は、その JSON の同じ項目より優先されます。case start と case update の --input は案件に渡す入力値だけを指定し、プレイブックの input_schema はその形式を定義します。

ワークスペースで作成する場合は、保存済みの既定ワークスペースを使う場合も、--private、--team-ids "$TEAM_ID"(カンマ区切りまたは JSON 配列)、設定全体を渡す --access のいずれか1つを選びます。--request JSON では private、teamIds、access を使い、併用しません。個人スペースでは共有指定を省略できます。チーム経由で編集できる作成者には、重複する直接共有を追加しません。

epismo playbook create --request @playbook.json
epismo case record append <case-id> --request @record.json
epismo playbook suggestion create <playbook-id> --request - < suggestion.json

成功すると JSON を標準出力に返し、終了コード 0 で終了します。失敗すると JSON 形式のエラーを標準エラー出力に返し、0以外の終了コードで終了します。自動化では、説明文ではなく code と retryable を使って処理を分岐してください。--diagnostic-format human は、ターミナルでエラーを読むときに使います。

一覧や検索では、--page-size と --cursor でページを切り替えます。全ページを取得するには --all、件数を制限するには --limit を使います。1行に1件ずつ出力するには --output jsonl を指定します。

--output value --field checkout_url は指定した項目の値を取り出します。組み込みの --jq では、.playbooks[] | .id のように必要な項目を抽出できます。

データを変更する操作では、冪等性キーを省略すると CLI が UUID を生成します。応答を受け取れず、同じ内容を再送するときだけ同じキーを使ってください。内容を変えた場合は新しいキーを使います。

案件やタスクの更新には、最新のロックバージョンが必要です。競合したら最新状態を取得し、変更内容を再検討します。アーカイブ、削除、認証情報の失効、案件の終了、共有設定の変更などは、--dry-run で送信前に確認できます。