要求と応答

要求

要求は、呼び出し元アプリケーションでエンドポイントに対して行う呼び出しであり、これによってデータに対してクエリを実行したりアクションを開始します。

要求は、URL を使用して行われます。要求 URL には、以下のコンポーネントが含まれています。

https://iap:8880/xc/rest/common/v1/activities/xc:207?fields=assignedGroup
\__________________/\______________________________/\___________________/ 
   application URL           endpoint path             query parameters

• アプリケーション URL：InsuranceSuite アプリケーションの URL
  • この値は必須です。
• エンドポイントパス：要求が求めている特定エンドポイントのパス
  • この値は必須です。
  • エンドポイントパスの末尾は、リソース名（.../activities など）または特定要素の ID（前述の例の .../activities/xc:207 など）です。特定要素の ID は、パスパラメータとも呼ばれます。
• クエリパラメータ：応答に含めるデータを詳細に定義するクエリパラメータのセットです。大部分のエンドポイントでは、クエリパラメータはオプションです。
  • 例えば、?fields=assignedGroup を追加する場合、応答で assignedGroup フィールドのみが返されるように指定します。

いくつかの要求ではペイロードが必要です。ペイロード は JSON 形式テキストのブロックであり、1 つ以上の操作関連リソースの情報が含まれています。一般的には以下のとおりです。

• GET および DELETE では、要求ペイロードは必要ありません。
  • GET の場合、必要な情報のリソースを特定することのみが必要であり、URL で行います。
  • DELETE の場合、削除する要素を特定することのみが必要であり、URL で行います。
• POST および PATCH では、要求ペイロードは必要ありません。
  • POST の場合、作成する要素に関するデータを指定する必要があります。
  • PATCH の場合、更新する必要がある要素に関するデータを指定する必要があります。

応答

応答 は、API エンドポイントで返す一連の情報であり、要求に対して呼び出し元アプリケーションに返されます。

一部の応答には、ペイロードが含まれています。操作で返される 1 つ以上のリソースに関する情報がペイロードには含まれています。例えば、特定ユーザーにアサインされているオープンなアクティビティをすべて取得する要求の場合、オープンなアクティビティに関する情報のあるペイロードが、応答に含まれています。ペイロードの構造の詳細については、GETを参照してください。

操作の結果は、応答コードとも呼ばれる HTTP ステータスコードで指定されます。これらのコードは 3 桁の数字です。これらのコードの一般的な意味を以下の表に示します。