更新モード
データ統合呼び出しでは、完全更新モードまたは部分更新モードを使用してPOST要求を送信できます。
すべてのオブジェクトフィールドを含むのではなく、変更したオブジェクトフィールドのみを含むPOST要求を送信するには、部分モードを使用します。例えば、mttaskオブジェクトの接続を更新する場合、次の例のように部分モードを使用してPOST要求を送信できます。
POST api/v2/mttask/<taskId>
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>
Update-Mode: PARTIAL
{
"@type": "mtTask",
"parameters": [
{
"@type": "mtTaskParameter",
"name": "$NewSource$",
"type": "EXTENDED_SOURCE",
"sourceConnectionId": "<sourceConnectionId>"
}
]
}
部分モードを使用しない場合、要求にオブジェクト全体を含める必要があります。デフォルトでは、REST APIは完全モードを使用します。
部分モードは次のリソースで使用できます。
- •接続
- •fwConfig
- •masterTemplate
- •mttask
- •スケジュール
- •ワークフロー
部分モードでPOST要求を送信するときは、JSONを使用して要求をフォーマットし、ヘッダーに次の行を含めます。
Update-Mode=PARTIAL
本文には更新されたオブジェクトの@type属性を含めます。
一部のフィールドはコレクションにグループ化されます。コレクションに存在するフィールドを更新するには、POST要求にコレクションのキーフィールドを含めます。以下の表に、コレクションと対応するキーフィールドを示します。
リソース/オブジェクト | コレクション | キーフィールド |
---|
fwConfig | fwColumn | name |
masterTemplate | mtParameter | name type |
mttask | mtTaskInOutParameter | name |
mttask | sequenceDefinition | txName |
mttask | mtTaskOverriddenField | name |
mttask | mtTaskParameter | name type |
extendedObject(mttask内のオブジェクト) | オブジェクト | name |
workflow | workflowTask | taskId |