API 呼び出し

Current version: 4.0

API 呼び出しアクションは、任意の外部 API を呼び出すことができます。

設定

[アクション] ユーザー インターフェイスを使用して、API 呼び出しを設定できます。

[!注] 新しいアクションの作成の詳細については、「アクションの作成」セクションを参照してください。

HTTP メソッド

API 呼び出しアクションは、次の 3 種類の HTTP メソッドをサポートします。

  • POST
  • PUT
  • GET

要求ヘッダー

API 呼び出しアクションでは、API 呼び出しにヘッダーを追加できます。

要求ヘッダーには、トリガー コンテキストから取得した動的な値を含めることができます。 作成/更新がトリガーされると、エンティティのプロパティ値とリレーション識別子がコンテキストに格納されます。 削除がトリガーされたときは、コンテキストには何も格納されず、使用可能なすべての情報は標準ヘッダーを介して送信されます。

コンテキスト変数の構文は表示テンプレートの構文と同じです。たとえば、{Title} を値フィールドに配置すると、エンティティの Title プロパティの値が取得されます。 リレーション名を使用する場合、その値にはターゲット エンティティの識別子が格納されます。 どちらの場合でも、複数の値が使用可能なときは、<tableseparator/> が区切り文字として使用されます。 自己リレーションを使用している場合、解決された値は次の形式になります。 <parent values separated with '<tableseparator/>'>;<child values separated with '<tableseparator/>'>.

メッセージ本文にこれらを配置するとき、値は context という最上位プロパティに追加されます。

保存アクションのペイロードの例を以下に示します。

RequestResponse
{
  "context": {
      "Title": "asset title"
  },
  "saveEntityMessage": {
    "EventType": "EntityUpdated",
    "IsNew": false,
    "TargetDefinition": "M.Asset",
    "TargetId": 10063,
    "TargetIdentifier": "DCQVyfb87kuL4RwvoYCIrA",
    "TimeStamp": "2019-03-05T14:30:47.9681811Z",
    "UserId": 6,
    "Version": 40,
    "ChangeSet": {
      "PropertyChanges": [
        {
          "Culture": "(Default)",
          "Property": "Title",
          "Type": "System.String",
          "OriginalValue": "drftgyhujo",
          "NewValue": "qwe"
        }
      ],
      "Cultures": [
        "(Default)"
      ],
      "RelationChanges": []
    }
  }
}

ヒント 要求ヘッダーは、API による認証に使用できます。

API 呼び出しのタイムアウト

API 呼び出しのタイムアウトを設定できます。この時間内に応答がなかった場合、その呼び出しは失敗します。

[!注] リスト内のタイムアウト値の単位は秒です。

API 接続のテスト

API 呼び出しを設定した後、API 接続をテストできます。

Do you have some feedback for us?

If you have suggestions for improving this article,