Custom labels

This method retrieves the complete list of custom labels defined in the system.

 

Custom fields can be defined for various entities in the system. For example, to get all project labels, look at the records where LabelCategory equals "Project".


URL

(GET) settings/customlabels

PARAMETERS

token

The token obtained on connection

Required

 

RESULTS

Returns a list of ApiCustomLabel records. Each record has these fields:

 

LabelCategory

The object to which this custom field is attached. This can be any of:

  • CategoryResources (used with TMs, Project memories and segments)
  • CategoryProjects
  • CategoryJobs
  • CategoryOrders
  • CategoryCompanies
  • CategoryPersons
  • CategoryInvoices

LabelId

he globally unique ID of the label.

TLabelName

Used for sorting fields in user interfaces.

Title

The name of the label as provided by the administrator.

AlwaysVisible

True if the label is always shown or false if the label needs to be attached to an object explicitly by the user.

Options

A list of all label options/colors:

DBCode: A code identifying this specific label option. This code uniquely identifies a specific label and option.

Name: The administrator given name of the option

Color: The color of the label option

Value: the integer value of the label option



Copyright Wordbee - Buzzin' Outside the Box since 2008