Docsアクション
Web API定義には複数のアクションを含めることができます。各アクションは必要なHTTPメソッドを使用した特定のエンドポイントへの異なるリクエストを表します。APIに対して構成されたすべてのアクションはナビゲーションツリーに表示され、［アクション］ノードを選択するとメイン画面に表示されます。
［アクションを追加］をクリックして、API定義に対して新しいアクションを作成し、関連付けられているパラメーターを構成します。
基本API定義の設定
名前と説明を追加して、アクション固有の設定を適用します。
名前
アクションの一意の名前。この名前は、オブジェクトとプロセススタジオのアクションにビジネスオブジェクトを選択する際に使用されます。
説明
アクションに関する詳細情報を提供する任意の説明。
有効
オブジェクトやプロセスで選択できるようにするには、アクションを有効にする必要があります。
リクエストデータ出力パラメーターを有効化
選択すると、オブジェクトスタジオおよびプロセススタジオのアクションのリクエストデータ出力が作成されます。アクションが実行されると、関連付けられているデータアイテムにAPIリクエストデータが入力されます。
リクエストの送信を無効化
このオプションを選択すると、リクエストデータは生成されますがリクエストはサーバーに送信されません。サーバーに連絡せずにリクエストを生成し、リクエストをデバッグおよび評価するメカニズムを提供するには、［リクエストデータ出力パラメーターを有効化］と組み合わせて使用します。
パラメーター（アクション固有）
これらのパラメーターはアクションに固有のもので、オブジェクトとプロセスのアクションの入力として、共通パラメーターと組み合わせて使用されます。角括弧で囲まれている場合、パラメーター名はURL、ヘッダー値、リクエスト本文にパラメーター値を追加するために動的に使用されます。
詳細情報については、「パラメーター」を参照してください。
リクエスト
必要なHTTPメソッドを選択し、URLパス、本文のコンテンツ、ヘッダーを追加して、このAPIエンドポイントに送信されるHTTPリクエストを定義します。
メソッド
リクエストに使用されるHTTPメソッド。ドロップダウンには標準のHTTPメソッドが含まれていますが、任意のリクエスト動詞をフリーテキストフィールドに入力することもできます。許可されていない文字が入力されないよう、フィールドが検証されます。
URLパス
ベースURLとともに使用した場合の特定のリクエストを定義するアクションに特化したURLパス。URLパスは、角括弧で囲まれた共通およびリクエスト固有のパラメーターを使用してパラメーター化できます。
ベースURLの例：
http://staff.database.com
URLパスの例：
/api/[version]/employee/[id]
パラメーターが展開されてベースURLに追加されると、次のアドレスに対してリクエストが行われます。
http://staff.database.com/api/v1/employee/26855
本文
次のいずれかのコンテンツタイプを使用して、HTTPリクエストとともに送信されるコンテンツを構成します。
- なし - リクエストに本文のコンテンツは含まれません。これは、GETメソッドを使用するなど、情報を取得するアクションで一般的です。
- テンプレート - JSONやXMLなどテキストベースの本文のコンテンツを送信します。パラメーターを使用して、リクエスト本文にデータを追加できます。
- 単一ファイル - APIリクエストの一部としてファイルを送信します。API定義は、プロセス内のデータステージからファイルを参照するために使用される入力パラメーターを指定します。
- 複数ファイル - APIリクエストの一部として複数のファイルを送信します。API定義は、プロセス内のコレクションステージからファイルを参照するために使用される入力パラメーターを指定します。
- カスタムコード - 複雑なシナリオの場合、コードを使用してリクエスト本文を生成できます。必要に応じて、API定義の共通コード領域からコードを組み込むこともできます。
ヘッダー（アクション固有）
このアクションに固有の各ヘッダーの名前と値を追加します。リクエストで使用されるヘッダーは、API定義内の共通ヘッダーと、アクションレベルで設定されたヘッダーを組み合わせたものです。アクション固有のヘッダーが共通ヘッダーと同じ名前の場合、そのアクション固有の値がすべてのリクエストで使用されます。
詳細情報については、「ヘッダー」を参照してください。
応答
JSONパスまたはカスタムコードを使用してHTTP応答を変換し、必要なデータを抽出します。データはデータアイテムに格納できるため、オブジェクトまたはプロセスの他のステージで使用しやすくなります。カスタムコードを使用して、応答データに関する計算を実行するなど、より複雑な応答を構成できます。
応答出力は次のフィールドを使用して定義されます。
- パラメーター - 指定されたデータを格納するために作成された出力パラメーターの名前。
- データ型 - 出力パラメーターのデータ型。
- メソッド - メソッドはJSONPathまたはカスタムコードのいずれかになります。カスタムコードを使用する場合、出力は割り当てが必要な参照パラメーターになります。
- Jsonパス - JSONPathを使用している場合、JSONの特定の要素を出力パラメーターに抽出するために式が必要です。これらの出力パラメーターには指定されたBlue Prismデータ型があります。Jsonパスを使用して見つかったオブジェクトはそのデータ型に変換されます。
- 応答の構成に関する詳細は、「JSONPathを使用して応答データを抽出する」を参照してください。
先頭に戻る