For Developers

Standard Operations

Creating Entities

To create an entity you can use the create() function on the relevant map. It accepts an external_id and the entity. You cannot create Districts.

$input.people.create(
    'external_id',
    Person.from({
        first_name: 'John',
        last_name: 'Doe',
        display_name: 'John Doe'
    })
);

When creating a new entity that references another entity, the referenced entity must exist before you create the new entity. Read more

Deleting Entities

To delete an entity you can use the delete() function on the relevant entity. You cannot delete Districts.

$input.people.get('edlink_id').delete();

Deleting entities with dependents can impact other entities. Read more

Modifying Entities

To modify an entity you can simply make changes to the reference you receive from the revelant map.

$input.people.get('edlink_id').first_name = 'Jane';

Modifying entities with dependents can impact other entities. Read more