Custom Fields

Custom fields can be stored against a variety of resources and allow developers to extend the Omneo schema to suite their specific requirements.

Specifying an owner

As custom fields can be attached to a variety of resources, you need to specify an owner when instantiating the module. You may attach custom fields to profiles and tenants.

$profile = new Omneo\Profile(['id' => 123]);

$omneo->customFields($profile)->browse();

If you do not specify an owner, the tenant will be used. This is comparable to binding custom fields to the Omneo account itself.

$omneo->customFields()->browse();

Browse

Fetch collection of custom fields.

$omneo->customfields()->browse(); // Illuminate\Support\Collection

Fetch a filtered collection of custom fields.

$omneo->customfields()->browse(
    (new Omneo\Constraint)->where('namespace', 'zendesk')
); // Illuminate\Support\Collection

Last updated