REST API Reference

Back Next

Update modes

For

Data Integration

calls, you can submit a POST request using full update mode or partial update mode.

Use partial mode to submit a POST request that only includes the changed object fields, instead of including all of the object fields. For example, if you want to update the connection in an mttask object, you can submit a POST request using partial mode that might look like the following example:

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>"
    }
  ]
}

If you do not use partial mode, you need to include the entire object in the request. By default, the REST API uses full mode.

Partial mode is available for the following resources:

connection

fwConfig

masterTemplate

mttask

schedule

workflow

When you submit a POST request in partial mode, format the request using JSON and include the following line in the header:

Update-Mode=PARTIAL

Include the @type attribute for the updated object in the body.

Some fields are grouped in collections. To update a field that resides in a collection, include the key field for the collection in the POST request. The following table lists the collections and corresponding key fields:

Resource/object	Collection	Key Field
fwConfig	fwColumn	name
masterTemplate	mtParameter	name type
mttask	mtTaskInOutParameter	name
mttask	sequenceDefinition	txName
mttask	mtTaskOverriddenField	name
mttask	mtTaskParameter	name type
extendedObject (object in mttask)	objects	name
workflow	workflowTask	taskId