Skip to main content

Field Operation Change

Represents a field operation that is created, changed, or deleted.

Event Name

FieldOperationChanged

Supported Events

The supported field operation change events are as follows:

  • Mix Container Changed
  • Note Added
  • Note Removed
  • Tag Added (see example payload below)
  • Tag Removed
  • Product Depot Changed
  • Created
  • Assignment Added (see example payload below)
  • Assignment Removed
  • Assignment Viewed
  • Acknowledged
  • Verified
  • Completion Added
  • Completion Removed
  • Stopped
  • Started
  • Datum Set
  • Datum Removed
  • Released
  • Deleted

Payload

Within an event, there are multiple pieces of information sent as outlined in the table below.

KeyTypeDescription
kindstringThe kind represents the type of event being registered. This includes the item which is being acted upon as well as the event being registered.
idguidThe reference id of the object that has changed.
[varies per event type][varies per event type]The data that is changing for the given event type. It can be a key value string or a complex object. It also could be multiple it items.
metadatametadata objectInformation regarding the initiator of the event. This includes the: version of the object, dateTime it was changed, user of whom performed the change, and the organizationId upon which the change was performed.

Example Payloads

Some example payloads are shown below.

Tag Added

{
"kind": "AgSync.Drive.Core.FieldOperationEvent+TagAdded",
"id": "cfc741b3-caf1-4328-9298-7f8a7ff2658a",
"tag": "this is a tag",
"metadata": {
"version": 188,
"dateTime": "2020-07-13T15:00:51.6570989Z",
"user": {
"id": 2908,
"name": "john@doe.com"
},
"organizationId": 761
}
}

Assignment Added

{
"kind": "AgSync.Drive.Core.FieldOperationEvent+AssignmentAdded",
"id": "38223d5e-aa99-4657-8234-c510840d339b",
"assignment": {
"equipmentId": "9556bc79-75d4-4cd6-baac-ba5b8b6c88b5",
"received": null,
"viewed": null
},
"metadata": {
"version": 195,
"dateTime": "2020-07-13T15:00:02.9887554Z",
"user": {
"id": 2908,
"name": "john@doe.com"
},
"organizationId": 761
}
}