API 呼び出し

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

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

• POST
• PUT
• GET

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

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

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

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

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

{
"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 呼び出しを設定し (POST メソッドを使用)、[接続のテスト] をクリックします。