Mass Update

post/massedit/{TypeCode}

Performs a mass update operation on the specified object. This operation is not available for all types of objects – "massEditable" = "true" must be set on the object to allow the mass edit operation.
Set the filter criteria to restrict the scope of the mass edit operation.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

The object's type code. See the list of Type Codes.

Request Body schema: application/json
required
object
required
object
_constructor
required
string non-empty
operator
required
string non-empty
required
Array of objects non-empty unique
Array (non-empty)
fieldName
required
string non-empty
operator
required
string non-empty
value
Array of strings
_constructor
required
string non-empty
required
Array of objects non-empty unique
Array (non-empty)
fieldName
required
string non-empty

The name of the field you want to update.

massEditOperator
required
string non-empty

Can be either one of these valid operators: + - * If omitted, the provided value is set (= operator). Otherwise the specified operation is applied.

fieldValue
required
string non-empty
precision
any

The new value of the field. If omitted, the field is set to null.

Responses
200

OK

Response Schema: application/json
object
node
string non-empty
data
Array of strings

The number of updated records. This number can be different from what the client UI initially thinks because the server takes edit restrictions into account.

status
number
Request samples
application/json
{
  • "data": {
    • "filterCriteria": {
      • "_constructor": "AdvancedCriteria",
      • "operator": "and",
      • "criteria": [
        • {
          }
        ]
      },
    • "massEditRecords": [
      • {
        • "fieldName": "currency",
        • "massEditOperator": "=",
        • "fieldValue": "USD",
        • "precision": null
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • "string"
      ],
    • "status": 0
    }
}