Bulk Upsert - Update or Create Multiple Domain Records

post

https://{environment}.origamirisk.com/OrigamiApi/api/{domain}/BulkUpsert

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Insert or Update a collection of records in one post by providing the domain along with a collection of records with field attributes for the new/existing records.

There is a configurable cap on the number of records that can be processed per API call. If this cap is exceeded, an exception will be raised and no records will be processed. For most clients, the default cap is 25 records per API call, though this limit may vary depending on client-specific configurations

Path Params

domain

string

required

This should match to the Domain Name in the system. It is case-sensitive. For Client Defined Entities it should start with 'Custom.'

Query Params

matchFields

string

required

A comma separated string of fields names to be used for matching existing records (i.e. ReferenceNumber,LossDate). Match fields should be limited to just text, numeric, or date fields (coded or lookup fields are not allowed). Field names are case sensitive. All of the fields MUST be present in the upsertJson.

fireEvents

boolean

Defaults to false

This field lets you decide whether creating this domain record should trigger a corresponding system event. If you’ve got external workflows or Data Entry Events and you don’t want them firing, be sure to set the value to false.

echoFields

string

This field lets you customize the shape of your response object. Just pass in a comma-separated list of the field names or attributes you want returned if the insert is successful. It’s a great way to confirm that your insert worked and get back the specific values you care about without having to make a separate API call. Think of it as a personalized snapshot of your newly created record.

Body Params

RAW_BODY

json

required

Defaults to [ { "Field1": "Value1", "Field2": "Value2" }, { "Field1": "ValueA", "Field2": "ValueB" } ]

Ensure the schema you provide here matches the schema of your intended target domain. See Origami Data Dictionaries for domain-specific schemas.

The structure of the body's schema is an array of object, where each object represents a single record to be updated.

[
  {
    "Field1": "Value1",
    "Field2": "Value2"
  },
  {
    "Field1": "ValueA",
    "Field2": "ValueB"
  }
]

Responses

200OK

400One or More Records Failed