Web-API:Custom Fields

From Cerberus Helpdesk Wiki

Custom Fields

Retrieve

Retrieving custom fields is a little different from all of the other objects you can retrieve via the Web-API.

Ticket Custom Fields

$out = $cerb5->get($base_url . 'customfields/ticket.json');

Address Custom Fields

$out = $cerb5->get($base_url . 'customfields/address.json');

Org Custom Fields

$out = $cerb5->get($base_url . 'customfields/org.json');

Feedback Custom Fields

$out = $cerb5->get($base_url . 'customfields/feedback.json');

Worker Custom Fields

$out = $cerb5->get($base_url . 'customfields/worker.json');

The returned custom fields contain the following fields:

• id (int)
• name (string)
• type (string: S (text: single-line), T (text: multi-line), N (number), E (date), D (picklist), C (checkbox), X (multi-checkbox), W (worker) or U (URL))
• context (string: cerberusweb.contexts.address, cerberusweb.contexts.call, cerberusweb.contexts.comment, cerberusweb.contexts.contact_person, cerberusweb.contexts.feedback, cerberusweb.contexts.group, cerberusweb.contexts.kb_article, cerberusweb.contexts.kb_category, cerberusweb.contexts.message, cerberusweb.contexts.notification, cerberusweb.contexts.opportunity, cerberusweb.contexts.org, cerberusweb.contexts.snippet, cerberusweb.contexts.task, cerberusweb.contexts.ticket, cerberusweb.contexts.timetracking, cerberusweb.contexts.worker)
• group_id (int)
• options (string ("\n" separates each option in a list of options for X and D type fields))

Note that you can use any of the above contexts to retrieve the custom fields as well. Eg:

Ticket Custom Fields (using context)

$out = $cerb5->get($base_url . 'customfields/cerberusweb.context.ticket.json');