AddEntity

Add a new entity of a specified class, and properties associated with the new entity.

Parameters

Parameter	JSON type	Behavior
_ref	integer, 1 through 100000	Optional. Declares a unique reference for later commands in this transaction. When omitted, no reference is available to later commands. If conditional insertion finds existing objects, the reference names those matches.
class	nonempty string, not starting with underscore	Required. Names the new entity class.
connect	connection object or array of connection objects	Optional. When omitted, no additional user connections are created. Each object requires an earlier node ref. Optional class chooses a connection class; direction is in or out (default out); properties sets connection properties. Omitted class uses this command’s default connection class. Connections are created only for a newly inserted object.
if_not_found	array expression	Optional. Checks existing objects of this type before insertion. When omitted, no duplicate lookup is performed. A match skips creation, properties, and new connections; status is 2 and _ref names all matches. An empty expression array is invalid. The lookup is restricted to class.
properties	object mapping property names to values	Optional. When omitted, no user properties are added. Stores booleans, numbers, strings, supported arrays, or single-key _date, _blob, and _json wrappers. Bare null is rejected; property names and wrapped values are validated. See the properties reference for nested value rules.

Details

The properties object stores key-value pairs on the new object.

The if_not_found condition inserts the object only when no existing object matches the condition.

The connect parameter creates connections between the new object and objects referenced earlier in the transaction.

Response and errors

An authenticated session with the objects create permission is required.

The response is an object under AddEntity with integer status. Status 0 means creation succeeded; status 2 means conditional insertion found existing objects. No output blob or created-object count is returned.

Invalid field types, missing required fields, malformed expressions, and invalid references fail validation. Execution failures include a nonzero status and an info message; inspect the transaction response before assuming a mutation succeeded.

Examples

Add a “Person” using AddEntity command:

[{
    "AddEntity": {
        "class": "Person",
        "properties": {
            "name": "Jane Doe",
            "gender": "F",
            "email": "jane.doe@xyz.com",
            "last_connected": 2022
        }
    }
}]

Successful response:

[{
    "AddEntity": {
        "status": 0
    }
}]

Conditionally add a “Person” if the email is not already registered:

[{
    "AddEntity": {
        "class": "Person",
        "if_not_found": ["$email", "==", "jane.doe@xyz.com"],
        "properties": {
            "name": "Jane Doe",
            "gender": "F",
            "email": "jane.doe@xyz.com",
            "last_connected": 2022
        }
    }
}]

Expected response:

[{
    "AddEntity": {
        "status": 2,
        "info": "Object Exists!"
    }
}]

Conditionally add a “Person” if the email is not already registered, add a “Visit” event, and create a connection between the “Person” and the “Visit”:

[{
    "AddEntity": {
        "_ref": 1,
        "class": "Person",
        "if_not_found": ["$email", "==", "alice@xyz.com"],
        "properties": {
            "name": "Alice",
            "gender": "F",
            "email": "alice@xyz.com"
        }
    }
}, {
    "AddEntity": {
        "class": "Visit",
        "properties": {
            "start_year": {
                "_date": "Mon Aug 7 10:59:24 PDT 2017"
            },
            "end_year": {
                "_date": "Mon Aug 7 12:59:24 PDT 2017"
            },
            "billing_id": 123
        },
        "connect": {
            "ref": 1,
            "class": "PersonMadeVisit"
        }
    }
}]

Successful response:

[{
    "AddEntity": {
        "status": 0
    }
}, {
    "AddEntity": {
        "status": 0
    }
}]