Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Updates the list of options of a picklist custom field.

Not implemented. Currently hidden page.

 

URL

(PUT) /settings/customfields/options

PARAMETERS

The method has no parameters.


RESULTS

The result is a JSON array with one element per custom field:

domain

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

  • Segment
  • Project
  • Resource
  • Order
  • Company
  • Person
  • Job
  • Invoice

 

string

customFieldId

The unique ID of the custom field for a given domain.The IDs are CustomStr1, CustomStr2….

string

od

The ascending display order of the field when displayed in forms.

int

title

The name of the custom field as provided by the administrator.

string

desc

Optional internal description.

string

type

The field type. Can be any of:

  • String - A free text field
  • Combo - A picklist
  • ComboEditable - A picklist but user can also type free text
  • ComboMultiSelect - A picklist with multiple choices
  • Hyperlink - A hyperlink
  • Checkbox - A checkbox

 

string

max

Maximum value length for String and ComboEditable fields. Disregarded for all other field types.

int

mandatory

Indicates if a value must be supplied when editing a field.

bool

options

A list of picklist options proposed to user.

Used with field types Combo and ComboEditable.

string[]
enabled

Indicates if the field is enabled or not.

bool
accinternal

A numeric valie specifying the access to this field by internal users:

  • 0: No access
  • 1: Can view value
  • 2: Can view and edit value
int
accexternal

A numeric valie specifying the access to this field by internal users:

  • 0: No access
  • 1: Can view value
  • 2: Can view and edit value
int
modes

Optional list of advanced settings regarding use or accessibility of custom field.

Segment custom fields:

  • LOC: Language specific. Attached to each translation of the segment.
  • SEG / null: Not language specific. Attached to segment.

Resource custom fields:

  • TM: Used with translation memories only.
  • TERM: Used with term bases only.
  • TFHITS: If set then visible in global search.

Company custom fields:

  • CLIENT: Used with client companies only.
  • SUPP: Used with supplier companies only.

 

string[] 

 

EXAMPLES

The following example is for a manager user accessing a job which is proposed to him/her. As a manager, the user has management level actions as well.

[
]

 

 

  • No labels