Object - Remove

Type identifier: object:remove Category: Object Operations

Description

Removes Records that match filter criteria. Supports querying by any property and removes matching Records along with their relationships. Returns the removed Records for downstream processing.

Input Handles

Input Handle Details

Variable Handles

Input handles are dynamically generated based on the variables configuration:

• Handle ID: Variable's id property
• Type: Defined by the variable's type configuration

• Notes:

  • Variables are used in filter expressions
  • Default variable is id for Record ID lookup

Output Handles

Output Handle Details

removed

• Type: Object (if firstOnly) or Array (if multiple)

• Includes:

  • All Record properties
  • id: Record ID
  • schemaId: Schema ID
  • createdAt: Creation timestamp
  • updatedAt: Last update timestamp
  • createdById: Creator ID
  • updatedById: Last updater ID
• Notes: File entries are augmented with Record context

Configuration Options

Configuration Details

variables

• Type: array
• Default: Single id variable with string type

• Notes:

  • Each variable creates an input handle
  • Used to populate filter expressions
  • Built-in spaceIdentityId always available

filter

• Type: object

• Structure:

  {
    "path": "propertyName",
    "type": "property",
    "value": { "type": "contextValue", "valueId": "variableId" },
    "operator": "eq"
  }

• Notes: Supports complex nested filters with AND/OR logic

Behaviour

V2 Execution

The node supports filters, ordering, offset, and limit. Removal is bounded to at most 1000 Records per execution; an omitted limit defaults to 1000 in v2 (the node's configured default remains 1). Offset must be a non-negative integer. A filter may be omitted, in which case the bounded page is removed.

firstOnly changes the shape of the removed output; it does not change how many Records are removed. The default limit of 1 therefore removes one Record unless a different limit is configured. With no matches, removed is null when firstOnly is enabled and an empty array otherwise. Configured filter variables must be connected; an unconnected variable routes to error without removing anything. Expected validation and authorization failures route to error; unexpected infrastructure failures fail the execution.

Error Handling

Examples

Remove by ID

{
  "type": "object:remove",
  "data": {
    "label": "Remove User",
    "schemaId": "user-schema-uuid",
    "variables": [
      {
        "id": "id",
        "type": { "name": "id", "type": "string", "required": true }
      }
    ],
    "filter": {
      "path": "id",
      "type": "property",
      "value": { "type": "contextValue", "valueId": "id" },
      "operator": "eq"
    },
    "firstOnly": true,
    "limit": 1
  }
}

Remove by Status

{
  "type": "object:remove",
  "data": {
    "label": "Remove Expired Orders",
    "schemaId": "order-schema-uuid",
    "variables": [
      {
        "id": "status",
        "type": { "name": "status", "type": "string", "required": true }
      }
    ],
    "filter": {
      "path": "status",
      "type": "property",
      "value": { "type": "contextValue", "valueId": "status" },
      "operator": "eq"
    },
    "firstOnly": false,
    "limit": 100
  }
}

Remove With Complex Filter

{
  "type": "object:remove",
  "data": {
    "label": "Cleanup Old Records",
    "schemaId": "log-schema-uuid",
    "filter": {
      "type": "and",
      "filters": [
        {
          "path": "processed",
          "type": "property",
          "value": { "type": "literal", "value": true },
          "operator": "eq"
        },
        {
          "path": "createdAt",
          "type": "property",
          "value": { "type": "contextValue", "valueId": "cutoffDate" },
          "operator": "lt"
        }
      ]
    },
    "firstOnly": false,
    "order": "asc",
    "orderBy": "createdAt"
  }
}