Data objects

These are the data objects that can be accessed and/or modified via the API.

Client

Defines a client in the system.

Parameter	Type	Value
__objtype	`String`	`'Client'`
id	`String`	Client ID
name	`String`	Client login name
fullName	`String`	Client display name
active	`Boolean`	True if the client is active
maxConcurrentUsers	`Integer`	Number of max concurrent user for this client. 0 if unlimited (limited by TermWeb license)
maxUserAccounts	`Integer`	Number of max user accounts for this client. 0 if unlimited (limited by TermWeb license)

Example:

{
   "__objtype": "Client",
   "id": "1073709059",
   "name": "admin",
   "fullName": "Administrator client",
   "active": true,
   "maxConcurrentUsers": 0,
   "maxUserAccounts": 0
}

ConceptEntry

Defines a concept entry.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'ConceptEntry'`
id	`String`	ConceptEntry ID (internal use)
name	`String`	Concept ID value (visible in GUI)
conceptID	`String`	Concept ID value (visible in GUI)
dictionaryID	`String`	ID of the dictionary to which the Concept belongs
sectionID	`String`	ID of the concept's section
sectionName	`String`	Name of the concept's section
domainIDs	`Array [String]`	IDs of domains for the concept
fields	`Struct [String→String]`	Map of field names to field values (concept level fields)
terms	`Array [TermEntry]`	Term objects in the concept entry

Example:

ConceptEntry

{
   "__objtype": "ConceptEntry",
   "id": "436",
   "name": "80",
   "conceptID": "80",
   "dictionaryID": "312",
   "sectionID": "329",
   "sectionName": "Animals",
   "domainIDs": [ ],
   "fields": [ ],
   "terms": [
   {
     "__objtype": "TermEntry",
     "id": "437",
     "name": "fish",
     "termID": "80-2",
     "toBeDeleted": false,
     "conceptEntryID": "436",
     "dictionaryID": "312",
     "language": "eng",
     "fields": {
       "Process status": "finalized"
     }
   },
   {
     "__objtype": "TermEntry",
     "id": "438",
     "name": "poisson",
     "termID": "80-4",
     "toBeDeleted": false,
     "conceptEntryID": "436",
     "dictionaryID": "312",
     "language": "fra",
     "fields": {
       "Gender": "masculine",
       "Process status": "finalized",
       "Part of speech": "noun"
     }
   }
   ]
}

ConceptXmlResult

Object for holding a list of concept entries in XML format retrieved from calls to exportAllConcepts or exportConceptChanges.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'ConceptXmlResult'`
conceptIDList	`String`	Comma-separated string of concept IDs (visible in GUI)
xmlList	`Array [String]`	Array of concept XML data
moreResults	`Boolean`	True if there are more results to be retrieved
resultSize	`Integer`	Number of concepts in this object

Example:

{
   "__objtype": "ConceptXmlResult",
   "conceptIDList": "163,162",
   "xmlList": [
     "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><conceptGrp><system type=\"entryClass\">3<\/system><concept>163<\/concept><descripGrp><descrip type=\"conceptID\">163<\/descrip><\/descripGrp><languageGrp><language lang=\"EN\" type=\"English\"\/><termGrp><term>tulip<\/term><descripGrp><descrip type=\"termID\">163-1<\/descrip><\/descripGrp><\/termGrp><\/languageGrp><\/conceptGrp>",
     "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><conceptGrp><system type=\"entryClass\">3<\/system><concept>162<\/concept><descripGrp><descrip type=\"conceptID\">162<\/descrip><\/descripGrp><languageGrp><language lang=\"EN\" type=\"English\"\/><termGrp><term>grass<\/term><descripGrp><descrip type=\"termID\">162-1<\/descrip><\/descripGrp><\/termGrp><\/languageGrp><\/conceptGrp>",
   ],
   "moreResults": false,
   "resultSize": 2
}

Dictionary

Contains data about a dictionary in the system.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Dictionary'`
id	`String`	Dictionary ID
name	`String`	Dictionary name
description	`String`	Description text for the dictionary
conceptFields	`Array [Field]`	Array of concept level fields in the dictionary
termFields	`Array [Field]`	Array of term level fields in the dictionary

Example:

{
   "__objtype": "Dictionary",
   "id": "267514",
   "name": "My dictionary",
   "description": "My dictionary description",
               "conceptFields": [
               {
                               "__objtype": "Field",
                               "id": "263539",
                               "name": "Definition",
                               "dataCat": "definition",
                               "dictionaryID": "263507",
                               "dataType": "NOTE_TEXT",
                               "required": false,
                               "minLen": 0,
                               "maxLen": 16383
                       }
               ],
               "termFields": [
                       {
                               "__objtype": "Field",
                               "id": "263567",
                               "name": "Part of speech",
                               "dataCat": "partOfSpeech",
                               "dictionaryID": "263507",
                               "dataType": "PICKLIST",
                               "picklist": [
                                       "noun",
                                       "verb",
                                       "adjective",
                                       "adverb",
                                       "properNoun",
                                       "other"
                               ],
                               "required": false,
                               "minLen": 0,
                               "maxLen": 16383
                       },
                       {
                               "__objtype": "Field",
                               "id": "263623",
                               "name": "Example",
                               "dataCat": "example",
                               "dictionaryID": "263507",
                               "dataType": "NOTE_TEXT",
                               "required": false,
                               "minLen": 0,
                               "maxLen": 16383
                       }
               ]
}

Domain

Contains data about a domain in a dictionary.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Domain'`
id	`String`	Domain ID
name	`String`	Domain name
dictionaryID	`String`	ID of dictionary to which the domain belongs
parent	`String`	ID of parent domain. 0 for a top level domain.
children	`Array [Domain]`	Array of subdomain objects to this domain.

Example:

{
   "__objtype": "Domain",
   "id": "1356",
   "name": "FOOD & AGRI",
   "dictionaryID": "1167",
   "parent": "0",
   "children": [
     {
       "__objtype": "Domain",
       "id": "1357",
       "name": "agriculture",
       "dictionaryID": "1167",
       "parent": "1356",
       "children": []
     }
}

Field

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Field'`
id	`String`	Field ID
name	`String`	Field name
dataCat	`String`	Data category. See `DataCategory`
dictionaryID	`String`	ID for the dictionary to which the field belongs
dataType	`String`	Data type. See `FieldDataType`
picklist	`Array [String]`	Array of picklist values. Only set if dataType is PICKLIST
required	`Boolean`	True if the field is required to have a value
regExp	`String`	Regular expression that the field value should match
minLen	`Integer`	Minimum length for the field value
maxLen	`Integer`	Maximum length for the field value

Example:

{
   "__objtype": "Field",
   "id": "263601",
   "name": "Usage status",
   "dataCat": "administrativeStatus",
   "dictionaryID": "263507",
   "dataType": "PICKLIST",
   "picklist": [
     "preferred",
     "admitted",
     "notRecommended",
     "obsolete"
   ],
   "required": false,
   "minLen": 0,
   "maxLen": 16383
}

Filter

Contains data about a filter in the system.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Filter'`
id	`String`	Filter ID
name	`String`	Filter name
dictionaryID	`String`	ID for the dictionary containing the filter
filterCriteria	`Array [FilterCriteria]`	Array of filter criteria in the filter

Example:

{
   "__objtype": "Filter",
   "id": "4729661",
   "name": "Concept 36",
   "dictionaryID": "267514",
   "filterCriteria": [
   {
     "__objtype": "FilterCriteria",
     "id": "4729683",
     "fieldID": "264306685",
     "comparison": "EQUALS",
     "value": "36",
     "logicalOp": "NOP",
     "relDate": false,
     "termStartCriteria": false
   }
   ]
}

FilterCriteria

Contains information about a single criteria within a Filter.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'FilterCriteria'`
id	`String`	FilterCriteria ID
fieldID	`String`	ID for the field containing the value to compare
comparison	`String`	The comparison operator. See `CriteriaComparison`.
value	`String`	The value to compare the field value against
logicalOp	`String`	The logical operator following this criteria. See `CriteriaOperator`.
relDate	`Boolean`	True if the criteria value represents a date relative to now
termStartCriteria	`Boolean`	True if the criteria is the start of a term field criteria group in the filter

Example:

{
  "__objtype": "FilterCriteria",
  "id": "4729683",
  "fieldID": "264306685",
  "comparison": "EQUALS",
  "value": "36",
  "logicalOp": "NOP",
  "relDate": false,
  "termStartCriteria": false
}

ImportSettings

Settings for imports of term data.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'ImportSettings'`
id	`String`	ImportSettings ID
name	`String`	ImportSettings name
dictionaryID	`String`	ID for the dictionary to which the import settings belong
userID	`String`	ID for the user owning the import settings
conceptIDSync	`String`	How concepts should be synchronized on conceptID. See `ConceptSyncMethod` for possible values.
indexTermSync	`String`	How concepts should be synchronized on index term for a language. See `ConceptSyncMethod` for possible values. If this value is different from `ConceptSyncMethod.NO_SYNC` it overrides the value for `conceptIDSync`.
termSync	`String`	How terms should be synchronized within a concept. See `TermSyncMethod` for possible values.
publiclyVisible	`Boolean`	True if the settings should be available for all users within the client.
indexTermLanguages	`Array [String]`	Array of iso3 language codes used for synchronization of concepts when indexTermSync is used
affectedConceptFields	`Array [String]`	Array of IDs of concept level fields that may be modified by the import
affectedLanguages	`Array [String]`	Array of iso3 codes for languages which may be modified by the import
sectionIDMap	`Struct [String→String]`	Map from section names in import file to section IDs in dictionary
conceptFieldIDMap	`Struct [String→String]`	Map from concept level field names in import file to concept field IDs in dictionary
termFieldIDMap	`Struct [String→String]`	Map from term level field names in import file to term field IDs in dictionary
languageIsoMap	`Struct [String→String]`	Map from language names/codes in import file to language iso3 codes in dictionary

Example:

{
   "__objtype": "ImportSettings",
   "id": "4731072",
   "name": "Merge import",
   "dictionaryID": "267514",
   "userID": "1073709057",
   "conceptIDSync": "DEFINITION",
   "indexTermSync": "MERGE",
   "termSync": "DEFINITION",
   "publiclyVisible": false,
   "indexTermLanguages": [
      "eng"
   ],
   "affectedConceptFields": [
      "267518"
   ],
   "affectedLanguages": [
      "deu"
   ],
   "sectionIDMap": {
      "Devices": "267552"
   },
   "conceptFieldIDMap": {
      "Product": "1946608740",
      "Definition": "267518"
   },
   "termFieldIDMap": {
      "Source": "2313788816",
      "Term ID": "2023876473"
   },
   "languageIsoMap": {
      "English": "eng",
      "French": "fra",
      "German": "deu",
      "Korean": "kor",
      "Portuguese": "por"
   }
}

ImportValidationReport

Contains results of a validation of an import file.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'ImportValidationReport'`
fileFormat	`String`	The detected format of the import file
conceptCountMap	`Struct [String->Integer]`	Map from section names to number of concepts in each section
termCount	`Integer`	Total number of terms found in the file
sectionNames	`Array [String]`	Array of section names found in the file that exist in the dictionary
missingSectionNames	`Array [String]`	Array of section names found in file that do not exist in the dictionary
languageNames	`Array [String]`	Array of names of languages found in file that exist in the dictionary
languageCodes	`Array [String]`	Array of iso3 codes of languages found in file that exist in the dictionary
missingLanguageCodes	`Array [String]`	Array of language codes found in the file that do not exist in the dictionary
conceptFieldNames	`Array [String]`	Array of concept field names found in the file that exist in the dictionary
termFieldNames	`Array [String]`	Array of term field names found in the file that exist in the dictionary
missingConceptFieldNames	`Array [String]`	Array of concept field names found in the file that do not exist in the dictionary
missingTermFieldNames	`Array [String]`	Array of term field names found in the file that do not exist in the dictionary
domainPaths	`Array [String]`	Array of domain name paths, each domain name in a path separated by semicolon
unresolvedIDs	`Array [String]`	Only for internal use
fatalErrors	`Array [String]`	Array of fatal error messages found during validation

Example:

{
   "__objtype": "ImportValidationReport",
   "fileFormat":"TBX",
   "conceptCountMap":{},
   "termCount":11,
   "sectionNames":[],
   "missingSectionNames":[
     "Section 1"
   ],
   "languageNames":[
     "en", "fr"
   ],
   "languageCodes":[
     "eng", "fra"
   ],
   "missingLangCodes":[],
   "conceptFieldNames":[],
   "termFieldNames":[
     "context", "partOfSpeech"
   ],
   "missingConceptFieldNames":[
     "relatedConceptBroader", "relatedConcept"
   ],
   "missingTermFieldNames":[],
   "domainPaths":[],
   "unresolvedIds":[],
   "fatalErrors",[]
}

IndexTerm

Data object for listing terms and search results. Contains the term name and IDs for the corresponding ConceptEntry and TermEntry.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'IndexTerm'`
term	`String`	Term name
conceptEntryID	`String`	ID for the concept entry
termEntryID	`String`	ID for the term entry

Example:

{
   "__objtype": "IndexTerm",
   "term": "fish",
   "conceptEntryID": "436",
   "termEntryID": "437"
}

Language

Contains data about a language in a dictionary.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Language'`
id	`String`	Language ID
name	`String`	Language name
dictionaryID	`String`	ID for the dictionary to which the language belongs
isoCode2	`String`	The ISO 639-1 code for the language. May be empty.
isoCode3	`String`	The ISO 639-2 code for the language

Example:

{
"__objtype": "Language",
"id": "1183",
"name": "Dutch",
"dictionaryID": "1167",
"isoCode2": "nl",
"isoCode3": "nld"
}

Project

Contains a Project definition.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Project'`
id	`String`	Project ID
name	`String`	Project name
active	`Boolean`	True if the project is active
description	`String`	Description for the project
dictionaryID	`String`	ID for the dictionary connected to this project
variables	`Struct`	Map of variable names and values for the project
filterID	`String`	ID for the filter selecting concepts belonging to this project
filterCriteria	`Array [FilterCriteria]`	Array of filter criteria in the project's filter
workflows	`Array [ProjectWorkflow]`	Array of workflows in the project

Example:

{
   "__objtype": "Project",
   "id": "1161413",
   "name": "New concepts March 2016",
   "active": "true",
   "dictionaryID": "312",
   "variables": {
       "%addl": "Please add term in your language"
   },
   "filterID": "1161410",
   "filterCriteria": [
       {
           "__objtype": "FilterCriteria",
           "id": "1161412",
           "fieldID": "1946608740",
           "comparison": "GREATER_THAN",
           "value": "2016-03-01 00:00",
           "logicalOp": "AND",
           "relDate": false,
           "termStartCriteria": false
       },
       {
           "__objtype": "FilterCriteria",
           "id": "1161411",
           "fieldID": "1946608740",
           "comparison": "LESS_THAN",
           "value": "2014-04-01 00:00",
           "logicalOp": "NOP",
           "relDate": false,
           "termStartCriteria": false
       }
   ],
   "workflows": [
       {
           "__objtype": "ProjectWorkflow",
           "id": "1179204",
           "name": "March concepts created",
           "description": "Signal new concepts",
           "dictionaryID": "312",
           "active": "true",
           "tasklist": [
               "CreateConcept"
           ],
           "conditionlist": [
               {
                   "__objtype": "WorkflowCondition",
                   "fieldID": "347",
                   "logicalOp": "NOP",
                   "compareOp": "CONTAINS",
                   "value": "product"
               }
           ],
           "functioncalllist": [
               {
                   "__objtype": "WorkflowFunctionCall",
                   "function": "SendEmail",
                   "parameter_map": {
                       "content.type": "1",
                       "digest.type": "1",
                       "subject": "${workflow_name} ${%addl}",
                       "digest.enabled": "true",
                       "digest.jobnumber.oid": "13vk9",
                       "wflow.name": "March concepts created",
                       "msg.text": "Please add!",
                       "digest.displayed.langs": "eng,deu,swe",
                       "rcpt.type": "1",
                       "digest.number": "2",
                       "digest.id": "13vk8",
                       "email": "translators@example.com",
                       "project.oid": "13e65",
                       "digest.schedule.value": "0 * * * *"
                   }
               }
           ]
       }
   ]
}

ProjectWorkflow

Represents a Workflow defined in a Project.

XML-RPC object structure:

Parameter	Type	Value
__objtype	`String`	`'ProjectWorkflow'`
id	`String`	Workflow ID
name	`String`	Workflow name
active	`Boolean`	True if the workflow is active
description	`String`	Description for the workflow
dictionaryID	`String`	ID for the dictionary connected to this workflow
tasklist	`Array [String]`	Array of tasks that triggers this workflow. See `WorkflowTask`.
conditionList	`Array [WorkflowCondition]`	Array of conditions in this workflow
functionCallList	`Array [WorkflowFunctionCall]`	Array of of function calls in this workflow

Example:

{
   "__objtype": "ProjectWorkflow",
   "id": "1179204",
   "name": "March concepts created",
   "description": "Signal new concepts",
   "dictionaryID": "312",
   "active": "true",
   "tasklist": [
     "CreateConcept"
   ],
   "conditionlist": [
     {
       "__objtype": "WorkflowCondition",
       "fieldID": "347",
       "logicalOp": "NOP",
       "compareOp": "CONTAINS",
       "value": "product"
     }
   ],
   "functioncalllist": [
     {
       "__objtype": "WorkflowFunctionCall",
       "function": "SendEmail",
       "parameter_map": {
         "content.type": "1",
         "digest.type": "1",
         "subject": "${workflow_name} ${%addl}",
        "digest.enabled": "true",
         "digest.jobnumber.oid": "13vk9",
         "wflow.name": "March concepts created",
         "msg.text": "Please add!",
         "digest.displayed.langs": "eng,deu,swe",
         "rcpt.type": "1",
         "digest.number": "2",
         "digest.id": "13vk8",
         "email": "translators@example.com",
         "project.oid": "13e65",
         "digest.schedule.value": "0 * * * *"
       }
     }
   ]
}

Section

Contains data about a section in a dictionary.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'Section'`
id	`String`	Section ID
name	`String`	Section name
dictionaryID	`String`	ID for the dictionary to which the section belongs

Example:

{
   "__objtype": "Section",
   "id": "1593347",
   "name": "My section",
   "dictionaryID": "1167"
}

TermEntry

Contains information about a term entry in a dictionary.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'TermEntry'`
id	`String`	TermEntry ID (internal use)
name	`String`	Term name
termID	`String`	Term ID value (visible in GUI)
toBeDeleted	`Boolean`	Set to true if this term should be deleted from the concept
conceptEntryID	`String`	ID of the concept to which the Term belongs
dictionaryID	`String`	ID of the dictionary to which the Term belongs
language	`String`	ISO3 language code for the term
region	`String`	Region code for the term ^{(since 2.10)}
script	`String`	Script code for the term ^{(since 2.10)}
fields	`Struct [String->String]`	Map of field names to field values (term level fields)

Example:

{
   "__objtype": "TermEntry",
   "id": "437",
   "name": "fish",
   "termID": "80-2",
   "toBeDeleted": false,
   "conceptEntryID": "436",
   "dictionaryID": "312",
   "language": "eng",
   "region": "GB",
   "script": "Latn",
   "fields": {
     "Process status": "finalized"
   }
}

User

Contains data about a user in the system.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'User'`
id	`String`	User ID
name	`String`	User login name
fullName	`String`	User full name
email	`String`	User's email address
active	`Boolean`	True if the user account is enabled

Example:

{
  "__objtype": "User",
  "id": "1073709057",
  "name": "admin",
  "fullName": "Administrator",
  "email": "bob@example.com",
  "active": true
}

VirtualFile

Defines a file object that can be transferred via the API.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'VirtualFile'`
id	`String`	VirtualFile ID
name	`String`	VirtualFile name
type	`String`	File type
description	`String`	Description for the file
data	`base64`	File content

Example:

{
   "__objtype": "VirtualFile",
   "id": "1593347",
   "name": "termdata",
   "type": "xml",
   "description": "Full dictionary",
   "data","0M8R4KGxGuEAAAAA..."
}

WorkflowCondition

Defines a condition in a workflow.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'WorkflowCondition'`
fieldID	`String`	ID of the field which this condition checks
logicalOp	`String`	Logical operation that connects this condition with the next in the workflow. See `CriteriaOperator`.
comparisonOp	`String`	Comparison operator for the field value. See `CriteriaComparison`.
value	`String`	The field value to compare against.

Example:

{
   "__objtype": "WorkflowCondition",
   "fieldID": "347",
   "logicalOp": "NOP",
   "compareOp": "CONTAINS",
   "value": "product"
}

WorkflowFunctionCall

Defines a function call inside a workflow.

XML-RPC object structure

Parameter	Type	Value
__objtype	`String`	`'WorkflowFunctionCall'`
function	`String`	Workflow function to call. See `WorkflowFunction`.
parameter_map	`Struct`	Map of parameter names and values for the function call. Available parameters depends on the workflow function.

Example:

{
   "__objtype": "WorkflowFunctionCall",
   "function": "SendEmail",
   "parameter_map": {
       "content.type": "1",
       "digest.type": "1",
       "subject": "${workflow_name} ${%addl}",
       "digest.enabled": "true",
       "digest.jobnumber.oid": "13vk9",
       "wflow.name": "March concepts created",
       "msg.text": "Please add!",
       "digest.displayed.langs": "eng,deu,swe",
       "rcpt.type": "1",
       "digest.number": "2",
       "digest.id": "13vk8",
       "email": "translators@example.com",
       "project.oid": "13e65",
       "digest.schedule.value": "0 * * * *"
   }
}