bulkCreateOrUpdate

Warning: Support for using this method with external objects (such as those mapped to external tables, to OpenEdge Service objects, or through a HDP connection) is a beta feature. This method is supported in production systems, except for external objects.

Purpose

Updates existing records or creates new records from a bulk CSV upload. The output parameter is optional.

In your REST request you must specify a content-type HTTP header with a value text/csv as your request body contains CSV data. Refer to online resources for more information on HTTP headers.

HTTP Method

POST

URL

https://app.infiniteblue.com/rest/api/bulkCreateOrUpdate

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

mapId

The original ID of a previously created Data Import Map.

[fieldId][triggerId]

The ID of unique field used to identify records to be updated or the original ID of a Unique Fields Combination trigger.

synch

If true, process the import synchronously and return the IDs of the created records. If false (default), process the import asynchronously. The user will receive an email with the results of the import.

importMode

Specifies the import mode. Can be one of the following:

  • 0 — Normal; runs all triggers and creates picklist values on the fly if createAction is true. Best to use with medium-sized uploads.

  • 1 — Test; limits upload to five records and displays results including debug information from triggers. Creates picklist values on the fly if createAction is true. Use to test before loading a full set of data.

  • 2 — Bulk; does not run triggers and does not create picklist values on the fly. Optimized for fast processing of large imports.

createAction

Boolean that specifies whether to create picklist values on the fly while importing. When true, picklist values are created. When false, picklist values are not created. The importMode parameter must be 0 or 1 for picklist values to be created.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Edit permission for the object type of each requested record. Create permission for the object type of each new record.

Response

Report on created/updated record similar to report after CSV import.