Skip to main content
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

ブラウザから API にアクセスする前に

共同作成者
PDF

Deploy のオンラインドキュメントページを使用する前に、いくつかの点に注意する必要があります。

導入計画

特定の導入タスクまたは管理タスクを実行する際に問題 API 呼び出しを行う場合は、導入計画を作成することを検討してください。これらのプランは正式なプランでも非公式なプランでもあり、通常は目標と使用する API 呼び出しが含まれています。詳細については、 Deploy REST API を使用したワークフロープロセスを参照してください。

JSON の例とパラメータの定義

各 API 呼び出しについて、ドキュメントページで一貫した形式で説明しています。このコンテンツには、実装メモ、クエリパラメータ、および HTTP ステータスコードが含まれます。また、 API の要求と応答で使用される JSON に関する詳細を次のように表示することもできます。

  • 値の例
    API呼び出しで_example value_をクリックすると、呼び出しの一般的なJSON構造が表示されます。この例は必要に応じて変更でき、要求の入力として使用できます。

  • モデル
    [Model]をクリックすると、JSONパラメータの完全なリストと各パラメータの概要が表示されます。

API 呼び出しを実行する際の注意事項

Deploy のドキュメントページを使用して実行する API 処理は、すべてライブ処理です。構成ファイルやその他のデータを誤って作成、更新、削除しないように、注意してください。