Skip to main content

settings/customfields

Retrieves the custom fields defined for orders, projects, companies, persons, jobs etc. Custom fields are fields the platform owner can add to objects. 

URL

(GET) /api/settings/customfields

PARAMETERS

The method has no parameters.


RESULTS

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

id

A globally unique ID of this custom field.

string

customFieldIdNumber of the database table column in which this field is storedint

domain

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

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


string

dbid

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
  • ComboAuto - A web service pick list with auto complete capability. Read more.
  • Hyperlink - A hyperlink
  • Checkbox - A checkbox
  • Image - An image.


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
displayFilter

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[] 
tmxIf used in the context of TMX exports or imports, this is the code used for field values in a TMX file.string
rowsNumber of rows of text box if the field is text based (text, hyperlink)byte


EXAMPLES

See this example:

CODE
[
    {
        "id": "1-14",
        "dbid": "CustomStr14",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 14,
        "type": "ComboEditable",
        "title": "show title",
        "desc": "",
        "domain": "Segment",
        "displayOrder": "1",
        "displayFilter": ";TFHITS;SEG",
        "tmx": "x-wb-customstr14",
        "enabled": true,
        "mandatory": false,
        "options": [
            "1",
            "2",
            "3",
            "4",
            "dadadadadad"
        ],
        "max": 100,
        "rows": 1
    },
    {
        "id": "1-1",
        "dbid": "CustomStr1",
        "accinternal": 1,
        "accexternal": 2,
        "customFieldId": 1,
        "type": "String",
        "title": "Stringblabla",
        "desc": "String field",
        "domain": "Segment",
        "displayOrder": "2",
        "displayFilter": ";;",
        "tmx": "x-wb-customstr1",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "1-2",
        "dbid": "CustomStr2",
        "accinternal": 0,
        "accexternal": 0,
        "customFieldId": 2,
        "type": "Combo",
        "title": "Pick list field",
        "desc": "Pick list field",
        "domain": "Segment",
        "displayOrder": "3",
        "displayFilter": ";TFHITS;SEG",
        "tmx": "x-wb-customstr2",
        "enabled": true,
        "mandatory": false,
        "options": [
            "CATEGORY",
            "Character Name (Primary)",
            "Character Name (Secondary)",
            "Episode Title",
            "Location (Primary)",
            "Location (Secondary)",
            "Option 1",
            "Option 2",
            "Option 3",
            "Option 4",
            "Option 5",
            "Prop",
            "Property",
            "Quotation",
            "Song",
            "test"
        ],
        "max": 1000,
        "rows": 1
    },
    {
        "id": "1-4",
        "dbid": "CustomStr4",
        "accinternal": 0,
        "accexternal": 0,
        "customFieldId": 4,
        "type": "ComboMultiSelect",
        "title": "Pick list, multiple choice",
        "desc": "Pick list, multiple choice",
        "domain": "Segment",
        "displayOrder": "5",
        "displayFilter": ";TFHITS;",
        "tmx": "x-wb-customstr4",
        "enabled": true,
        "mandatory": false,
        "options": [
            "Options (Multi) 1",
            "Options (Multi) 2",
            "Options (Multi) 3",
            "Options (Multi) 4",
            "Options (Multi) 5"
        ],
        "max": 1000,
        "rows": 1
    },
    {
        "id": "1-5",
        "dbid": "CustomStr5",
        "accinternal": 0,
        "accexternal": 0,
        "customFieldId": 5,
        "type": "Hyperlink",
        "title": "Hyperlink",
        "desc": "Hyperlink",
        "domain": "Segment",
        "displayOrder": "6",
        "displayFilter": ";TFHITS;",
        "tmx": "x-wb-customstr5",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "1-6",
        "dbid": "CustomStr6",
        "accinternal": 0,
        "accexternal": 0,
        "customFieldId": 6,
        "type": "Image",
        "title": "Image",
        "desc": "Image",
        "domain": "Segment",
        "displayOrder": "7",
        "displayFilter": ";TFHITS;",
        "tmx": "x-wb-customstr6",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "2-2",
        "dbid": "CustomStr2",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 2,
        "type": "CheckBox",
        "title": "CheckBox Test",
        "desc": "test",
        "domain": "Project",
        "displayOrder": "2",
        "displayFilter": null,
        "tmx": "x-wb-customstr2",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "3-2",
        "dbid": "CustomStr2",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 2,
        "type": "Combo",
        "title": "◀New field▶",
        "desc": "",
        "domain": "Resource",
        "displayOrder": "2",
        "displayFilter": null,
        "tmx": "x-wb-customstr2",
        "enabled": true,
        "mandatory": false,
        "options": [
            "1"
        ],
        "max": 1000,
        "rows": 1
    },
    {
        "id": "3-3",
        "dbid": "CustomStr3",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 3,
        "type": "String",
        "title": "blabla",
        "desc": "",
        "domain": "Resource",
        "displayOrder": "3",
        "displayFilter": null,
        "tmx": "x-wb-customstr3",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "4-5",
        "dbid": "CustomStr5",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 5,
        "type": "CheckBox",
        "title": "Geheimer Auftrag",
        "desc": "Migros",
        "domain": "Order",
        "displayOrder": "5",
        "displayFilter": null,
        "tmx": "x-wb-customstr5",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "5-6",
        "dbid": "CustomStr6",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 6,
        "type": "ComboEditable",
        "title": "◀New field▶",
        "desc": "",
        "domain": "Company",
        "displayOrder": "6",
        "displayFilter": null,
        "tmx": "x-wb-customstr6",
        "enabled": true,
        "mandatory": false,
        "options": [
            "1"
        ],
        "max": 100,
        "rows": 1
    },
    {
        "id": "5-7",
        "dbid": "CustomStr7",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 7,
        "type": "ComboMultiSelect",
        "title": "Textinhalt",
        "desc": "Migros",
        "domain": "Company",
        "displayOrder": "7",
        "displayFilter": "SUP",
        "tmx": "x-wb-customstr7",
        "enabled": true,
        "mandatory": false,
        "options": [
            "allgemein",
            "kreativ",
            "juristisch",
            "technisch",
            "finanziell"
        ],
        "max": 1000,
        "rows": 1
    },
    {
        "id": "8-1",
        "dbid": "CustomStr1",
        "accinternal": 2,
        "accexternal": 2,
        "customFieldId": 1,
        "type": "Image",
        "title": "Photo",
        "desc": "A photo of the person",
        "domain": "Person",
        "displayOrder": "1",
        "displayFilter": null,
        "tmx": "x-wb-customstr1",
        "enabled": true,
        "mandatory": false,
        "options": null,
        "max": 100,
        "rows": 1
    },
    {
        "id": "8-4",
        "dbid": "CustomStr4",
        "accinternal": 2,
        "accexternal": 1,
        "customFieldId": 4,
        "type": "ComboEditable",
        "title": "Hobby",
        "desc": "The person's hobby",
        "domain": "Person",
        "displayOrder": "4",
        "displayFilter": null,
        "tmx": "x-wb-customstr4",
        "enabled": true,
        "mandatory": false,
        "options": [
            "Bird Watching",
            "Gardening",
            "Singing"
        ],
        "max": 100,
        "rows": 1
    }
]



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.