Delete Objects

post/delete/{TypeCode}/batch/forcefilter

Deletes multiple objects based on filter settings.

Please Note: Invalid filter clauses are ignored. This could potentially lead to a full table truncate (the whole type without filter is deleted)! Use the forcefilter variant to enforce a filter in all cases!

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
required
string non-empty
Responses
200

OK

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

The number of deleted records.

status
number
Request samples
application/json
{
  • "data": {
    • "filterCriteria": {
      • "_constructor": "AdvancedCriteria",
      • "operator": "and",
      • "criteria": [
        • {
          }
        ]
      }
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • "string"
      ],
    • "status": 0
    }
}