3.4.5.2 Message: PutObject

Topic Version1Published10/31/2016
For StandardETP v1.1

Adds an object to a store. Uses "upsert" semantics (where update and insert use the same message) and, if the object does not exist, then the object is created.

The store MUST reject any object that is not explicitly included in the store's capabilities (either by name or by wild card) and send the EUNSUPPORTED_OBJECT ProtocolException.

The store MUST reject any document that is not schema valid and send the EINVALID_OBJECT ProtocolException.

The supplied object, if identified as 'growing' in the relevant data specification, SHOULD NOT include the growing portion. If the growing portion is present, the server MUST ignore it on insert.

Message Type ID: 2

Correlation Id Usage: n/a

Multi-part: False

Sent by: customer

Attribute

Description

Data Type

Min

Max

dataObject

The data object to be updated or added in the store.

DataObject

1

1

Avro Source

{

      "type": "record",

      "namespace": "Energistics.Protocol.Store",

      "name": "PutObject",

      "messageType": "2",

      "protocol": "4",

      "senderRole": "customer",

      "protocolRoles": "store,customer",

      "fields":

     [

         { "name": "dataObject", "type": "Energistics.Datatypes.Object.DataObject" }

     ]

}