Bulks

Endpoint

Creating or updating a large batch of resources is often necessary when doing large synchronizations. All endpoints are designed to handle creation or update jobs by batches of maximum 1000 objects, by supplementing /bulk to the URL.

https://api.gestal.cloud/<any valid endpoint URL>/bulk

Maximum bulk size

Bulk sizes greater than 1000 will be rejected.

Send a batch

Upon submitting a batch, a batch_update object is returned, giving status information on data processing.

The Batch Update object

Attribute	Type	Description
cloud_id	string	Unique identifier for the object.
update_type	string	The type of batch update (here sow_mirrors).
state	string	The state of the current batch. Can be: active, completed or failed
total	integer	The total number of resources to process in this batch.
failures	integer	How many batch jobs failed.
pending	integer	How many batch jobs are pending.
created_at	datetime	Date and time at which the batch update was created.
completed_at	datetime	Date and time at which the batch update was completed.
canceled_at	datetime	Date and time at which the batch update was canceled.

Example request

POST https://api.gestal.cloud/integration/sow-mirrors/bulk 'Payload: JSON <batch>'

where batch equals

[
  {
    "vendor_id": "70b096b7-047b-41ab-b36c-261f608ea701",
    "pin_tag": "1234",
    "rfid1": 12345678,
    "rfid2": 87654321
  }
]

Example response

{
  "cloud_id": "bu_aYD83ogODTtHsiNjclTFAVOdiq4Y47K5",
  "update_type": "sow_mirrors",
  "state": "active",
  "total": 1,
  "failures": 0,
  "pending": 1,
  "created_at": "2001-01-01T01:01:01.000Z",
  "completed_at": null,
  "cancelled_at": null
}