Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Download all options of a pick list. This method works with any kind of pick list.

Wordbee supports pick list custom fields. Such custom fields define different options from which a user can select from. Use settings/customfields to enumerate all fields and see which ones are pick lists (look for “Combo”). The present method returns the options configured for a specific custom field. Please note that options come in two flavors:

  • List of strings: Most field types only allow to configure a list of strings. This concerns fields Combo, ComboEditable and ComboMultiSelect.

  • List of strings with meta data: Fields of type ComboExt ComboAuto are like Combo regular pick lists but with a nice twist: You can also specify a list of strings but also add meta-data to each string. Read more.

URL

Code Block
(GET) /api/settings/customfields/{id}/options/items

...

id

The unique ID of the custom field. Easily find all your fields' IDs with: settings/customfields

Note: The ID is of the following format. The first number identifies the object to which the field relates (such as project, job, person, segment, etc.). The second number is a sequential field number.

Code Block
2-5

The first number is the object:

  • 1 : Segment

  • 2 : Project

  • 3 : Resource (project memory, translation memory or termbase)

  • 4 : Order

  • 5 : Company

  • 6 : Job

  • 7 : Invoice

  • 8 : Person

  • 9 : Service

string, Mandatory

RESULTS

The result is a JSON array with all the options. Each element represents one option with these properties:

...