1. APIのアクセス（認証）について¶
Bearer認証を使用して、API実行を行う場合、各利用者向けの「APIのアクセス（認証）について - Bearer認証」 の参照して、認証方式を変更してください。
警告
API実行時の言語について
最終ログイン時の言語情報が参照されます。
Tip
作成直後のユーザー情報で、Basic認証を使用したAPI実行について
初回ログイン後の設定が行われていない為、認証エラーとなります。 「初回ログイン」参照して、必要な対応を実施してください。
{
"data": null,
"message": "認証に失敗しました。",
"result": "401-00002",
"ts": "2023-10-13T08:19:22.913Z"
}
2. 登録、編集のAPI、関連APIの実行例¶
以下、登録、編集のAPI、及び関連APIの実行の例について記載します。
以下のAPI実行の説明において、認証方式は、Basic認証を使用しています。
Bearer認証を使用したAPIの実行を行う場合、「Bearer認証」を参照してください。
Tip
APIのエンドポイントで使用するメニュー名の確認方法ついて
「」から該当するメニューのレコードを確認し、「 」の値を使用してください。
Tip
パラメータで使用する、JSONデータ、FOEMデータに関する補足
パラメータ指定時の形式、指定方法について
コンテンツタイプ、パラメータ指定の方法や、curlの実行環境等により、適切なもので対応してください。
JSONデータをJSONファイルで保存し、パラメータにJSONファイルを指定して使用する
JSONデータのシングルクォーテーション「'」が使用できない場合、ダブルクォーテーション「 "」 を用いて、かつ内部で使用されたダブルクォーテーションをエスケープした書き方に変更する
末尾の「\」、「^」については、ご利用環境で適切なものに変更する
以下、コンテンツタイプによるパラメータの指定方法の詳細は、「Content-Typeによるパラメータの構造の違いについて」を参照してください。
curl -X POST \
"http://servername/api/organization_1/workspaces/workspace_1/ita/menu/playbook_files/maintenance/all/" \
-H "Authorization: Basic dXNlcl9pZDpwYXNzd29yZA==" \
-H "Content-Type: application/json" \
--data-raw [ { \"file\": { \"playbook_file\": \"LSBuYW1lOiBydW4gImVjaG8iCiAgY29tbWFuZDogZWNobyB7eyBWQVJfU1RSXzEgfX0=\" }, \"parameter\": { \"discard\": \"0\", \"item_no\": null, \"playbook_name\": \"echo\", \"playbook_file\": \"echo.yml\", \"remarks\": null, \"last_update_date_time\": null, \"last_updated_user\": null }, \"type\": \"Register\" } ]
curl -X POST \
"http://servername/api/organization_1/workspaces/workspace_1/ita/menu/playbook_files/maintenance/all/" \
-H "Authorization: Basic dXNlcl9pZDpwYXNzd29yZA==" \
-H "Content-Type: application/json" \
-d @playbook_files_sample.json
[
{
"file": {
"playbook_file": "LSBuYW1lOiBydW4gImVjaG8iCiAgY29tbWFuZDogZWNobyB7eyBWQVJfU1RSXzEgfX0="
},
"parameter": {
"discard": "0",
"item_no": null,
"playbook_name": "echo",
"playbook_file": "echo.yml",
"remarks": null,
"last_update_date_time": null,
"last_updated_user": null
},
"type": "Register"
}
]
curl -X POST \
"http://servername/api/organization_1/workspaces/workspace_1/ita/menu/playbook_files/maintenance/all/" \
-H "Authorization: Basic dXNlcl9pZDpwYXNzd29yZA==" \
-F "json_parameters=[{\"parameter\":{\"discard\":\"0\",\"item_no\":null,\"playbook_name\":\"echo\",\"playbook_file\":\"echo.yml\",\"remarks\":null,\"last_update_date_time\":null,\"last_updated_user\":null},\"type\":\"Register\"}] " \
-F "0.playbook_file=@echo.yml"