ArrayUpdateSpec

ArrayUpdateSpec
ArrayUpdateSpec

An ArrayUpdateSpec data object type is a common superclass for supporting incremental updates to arrays.

The common code pattern is:

     class MyTypeSpec extrends ArrayUpdateSpec {
           MyTypeInfo info;
     }

The ArrayUpdateSpec contains the following:

  • operation: the type of operation being performed.
  • removeKey: In the case of a remove operation, the key value that identifies the array to be removed.
AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "operation": "string",
    "removeKey": {
        "_typeName": "string"
    }
}
ArrayUpdateOperation_enum
operation
Required

This list specifies the type of operation being performed on the array.

Possible values:

  • add: indicates an addition to the array.

  • remove: indicates the removal of an element in the array.

    In this case the key field must contain the key of the element to be removed.

  • edit: indicates changes to an element in the array.

Possible values are : add, remove, edit,
Any
removeKey
Optional

The base of all data types. Not to be used directly on the wire.

Property Of
Used By