Versions Compared

Version Old Version 3 New Version Current
Changes made by

Patrik Westlund

Patrik Westlund

Saved on

Key

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

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

Panel
titleClient

Defines a client in the system.

ParameterTypeValue
__objtypeString'Client'
idStringClient ID
nameStringClient login name
fullNameStringClient display name
activeBooleanTrue if the client is active
maxConcurrentUsersIntegerNumber of max concurrent user for this client. 0 if unlimited (limited by TermWeb license)
maxUserAccountsIntegerNumber of max user accounts for this client. 0 if unlimited (limited by TermWeb license)

Example:

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

Defines a concept entry.

XML-RPC object structure

ParameterTypeValue
__objtypeString'ConceptEntry'
idStringConceptEntry ID (internal use)
nameStringConcept ID value (visible in GUI)
conceptIDStringConcept ID value (visible in GUI)
dictionaryIDStringID of the dictionary to which the Concept belongs
sectionIDStringID of the concept's section
sectionNameStringName of the concept's section
domainIDsArray [String]IDs of domains for the concept
fieldsStruct [String→String]Map of field names to field values (concept level fields)
termsArray [TermEntry]Term objects in the concept entry
Code Block
titleConceptEntry
{
   "__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"
     }
   }
   ]
}

...

titleDictionary

...

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

Anchor
client
client
 

Panel
titleClient

Defines a client in the system.

ParameterTypeValue
__objtypeString'Client'
idStringClient ID
nameStringClient login name
fullNameStringClient display name
activeBooleanTrue if the client is active
maxConcurrentUsersIntegerNumber of max concurrent user for this client. 0 if unlimited (limited by TermWeb license)
maxUserAccountsIntegerNumber of max user accounts for this client. 0 if unlimited (limited by TermWeb license)

Example:

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

Anchor
conceptentry
conceptentry

code
Panel
titleConceptEntry

Defines a concept entry.

XML-RPC object structure

ParameterTypeValue
__objtypeString'
Dictionary
ConceptEntry'
idString
Dictionary
ConceptEntry ID (internal use)
nameString
Dictionary name
descriptionStringDescription text for the dictionary
conceptFieldsArray [Field]Array of concept level fields in the dictionary
termFieldsArray [Field]Array of term level fields in the dictionary
Concept ID value (visible in GUI)
conceptIDStringConcept ID value (visible in GUI)
dictionaryIDStringID of the dictionary to which the Concept belongs
sectionIDStringID of the concept's section
sectionNameStringName of the concept's section
domainIDsArray [String]IDs of domains for the concept
fieldsStruct [String→String]Map of field names to field values (concept level fields)
termsArray [TermEntry]Term objects in the concept entry

Example:

Code Block
titleConceptEntry
{
   "__objtype": "DictionaryConceptEntry",
   "id": "267514436",
   "name": "My dictionary80",
   "descriptionconceptID": "My dictionary description80",
   "dictionaryID": "312",
   "sectionID": "329",
     "conceptFieldssectionName": ["Animals",
   "domainIDs": [ ],
   "fields": [ ],
   {"terms": [
   {
     "__objtype": "TermEntry",
     "id": "437",
     "name": "fish",
     "__objtypetermID": "Field80-2",
     "toBeDeleted": false,
     "conceptEntryID": "436",
     "dictionaryID": "312",
     "language": "eng",
     "idfields": {
       "Process status": "263539",finalized"
     }
   },
   {
                               "name": "Definition",
                               "dataCat": "definition",
                               "dictionaryID": "263507",
                               "dataType": "NOTE_TEXT",
      "__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"
     }
   }
   ]
}

Anchor
conceptxmlresult
conceptxmlresult

Panel
titleConceptXmlResult

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

XML-RPC object structure

ParameterTypeValue
__objtypeString'ConceptXmlResult'
conceptIDListStringComma-separated string of concept IDs (visible in GUI)
xmlListArray [String]Array of concept XML data
moreResultsBooleanTrue if there are more results to be retrieved
resultSizeIntegerNumber 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
}

 

Anchor
dictionary
dictionary

Panel
titleDictionary

Contains data about a dictionary in the system.

XML-RPC object structure

ParameterTypeValue
__objtypeString'Dictionary'
idStringDictionary ID
nameStringDictionary name
descriptionStringDescription text for the dictionary
conceptFieldsArray [Field]Array of concept level fields in the dictionary
termFieldsArray [Field]Array of term level fields in the dictionary

Example:

Code Block
{
   "__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
                       }
               ]
}

Anchor
domain
domain

Panel
titleDomain
Contains data about a domain in a dictionary.

XML-RPC object structure

ParameterTypeValue
__objtypeString'Domain'
idStringDomain ID
nameStringDomain name
dictionaryIDStringID of dictionary to which the domain belongs
parentStringID of parent domain. 0 for a top level domain.
childrenArray [Domain]Array of subdomain objects to this domain.

Example:

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

Anchor
field
field

Panel
titleField

XML-RPC object structure

ParameterTypeValue
__objtypeString'Field'
idStringField ID
nameStringField name
dataCatStringData category. See DataCategory
dictionaryIDStringID for the dictionary to which the field belongs
dataTypeStringData type. See FieldDataType
picklistArray [String]Array of picklist values. Only set if dataType is PICKLIST
requiredBooleanTrue if the field is required to have a value
regExpStringRegular expression that the field value should match
minLenIntegerMinimum length for the field value
maxLenIntegerMaximum length for the field value

Example:

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

Anchor
filter
filter

Panel
titleFilter

Contains data about a filter in the system.

XML-RPC object structure

ParameterTypeValue
__objtypeString'Filter'
idStringFilter ID
nameStringFilter name
dictionaryIDStringID for the dictionary containing the filter
filterCriteriaArray [FilterCriteria]Array of filter criteria in the filter

Example:

Code Block
{
   "__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
   }
   ]
}

Anchor
filtercriteria
filtercriteria

Panel
titleFilterCriteria

Contains information about a single criteria within a Filter.

XML-RPC object structure

ParameterTypeValue
__objtypeString'FilterCriteria'
idStringFilterCriteria ID
fieldIDStringID for the field containing the value to compare
comparisonStringThe comparison operator. See CriteriaComparison.
valueStringThe value to compare the field value against
logicalOpStringThe logical operator following this criteria. See CriteriaOperator.
relDateBooleanTrue if the criteria value represents a date relative to now
termStartCriteriaBooleanTrue if the criteria is the start of a term field criteria group in the filter

Example:

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

Anchor
importsettings
importsettings

Panel
titleImportSettings

Settings for imports of term data.

XML-RPC object structure

ParameterTypeValue
__objtypeString'ImportSettings'
idStringImportSettings ID
nameStringImportSettings name
dictionaryIDStringID for the dictionary to which the import settings belong
userIDStringID for the user owning the import settings
conceptIDSyncStringHow concepts should be synchronized on conceptID. See ConceptSyncMethod for possible values.
indexTermSyncStringHow 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.
termSyncStringHow terms should be synchronized within a concept. See TermSyncMethod for possible values.
publiclyVisibleBooleanTrue if the settings should be available for all users within the client.
indexTermLanguagesArray [String]Array of iso3 language codes used for synchronization of concepts when indexTermSync is used
affectedConceptFieldsArray [String]Array of IDs of concept level fields that may be modified by the import
affectedLanguagesArray [String]Array of iso3 codes for languages which may be modified by the import
sectionIDMapStruct [String→String]Map from section names in import file to section IDs in dictionary
conceptFieldIDMapStruct [String→String]Map from concept level field names in import file to concept field IDs in dictionary
termFieldIDMapStruct [String→String]Map from term level field names in import file to term field IDs in dictionary
languageIsoMapStruct [String→String]Map from language names/codes in import file to language iso3 codes in dictionary

Example:

Code Block
{
   "__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"
   }
}

Anchor
importvalidationreport
importvalidationreport

Panel
titleImportValidationReport

Contains results of a validation of an import file.

XML-RPC object structure

ParameterTypeValue
__objtypeString'ImportValidationReport'
fileFormatStringThe detected format of the import file
conceptCountMapStruct [String->Integer]Map from section names to number of concepts in each section
termCountIntegerTotal number of terms found in the file
sectionNamesArray [String]Array of section names found in the file that exist in the dictionary
missingSectionNamesArray [String]Array of section names found in file that do not exist in the dictionary
languageNamesArray [String]Array of names of languages found in file that exist in the dictionary
languageCodesArray [String]Array of iso3 codes of languages found in file that exist in the dictionary
missingLanguageCodesArray [String]Array of language codes found in the file that do not exist in the dictionary
conceptFieldNamesArray [String]Array of concept field names found in the file that exist in the dictionary
termFieldNamesArray [String]Array of term field names found in the file that exist in the dictionary
missingConceptFieldNamesArray [String]Array of concept field names found in the file that do not exist in the dictionary
missingTermFieldNamesArray [String]Array of term field names found in the file that do not exist in the dictionary
domainPathsArray [String]Array of domain name paths, each domain name in a path separated by semicolon
unresolvedIDsArray [String]Only for internal use
fatalErrorsArray [String]Array of fatal error messages found during validation

Example:

Code Block
{
   "__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",[]
}

Anchor
indexterm
indexterm

Panel
titleIndexTerm

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

XML-RPC object structure

ParameterTypeValue
__objtypeString'IndexTerm'
termStringTerm name
conceptEntryIDStringID for the concept entry
termEntryIDStringID for the term entry

Example:

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

Anchor
language
language

Panel
titleLanguage

Contains data about a language in a dictionary.

XML-RPC object structure

ParameterTypeValue
__objtypeString'Language'
idStringLanguage ID
nameStringLanguage name
dictionaryIDStringID for the dictionary to which the language belongs
isoCode2StringThe ISO 639-1 code for the language. May be empty.
isoCode3StringThe ISO 639-2 code for the language

Example:

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

Anchor
project
project

Panel
titleProject

Contains a Project definition.

XML-RPC object structure

ParameterTypeValue
__objtypeString'Project'
idStringProject ID
nameStringProject name
activeBooleanTrue if the project is active
descriptionStringDescription for the project
dictionaryIDStringID for the dictionary connected to this project
variablesStructMap of variable names and values for the project
filterIDStringID for the filter selecting concepts belonging to this project
filterCriteriaArray [FilterCriteria]Array of filter criteria in the project's filter
workflowsArray [ProjectWorkflow]Array of workflows in the project

Example:

Code Block
{
   "__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",
           "requiredid": false"1161412",
                  "fieldID": "1946608740",
            "minLencomparison": 0"GREATER_THAN",
           "value":       "2016-03-01 00:00",
            "maxLenlogicalOp": 16383"AND",
           "relDate": false,
          } "termStartCriteria": false
       },
     ],    {
           "termFields__objtype": [
  "FilterCriteria",
           "id": "1161411",
       {    "fieldID": "1946608740",
              "comparison": "LESS_THAN",
           "__objtypevalue": "Field2014-04-01 00:00",
                "logicalOp": "NOP",
              "idrelDate": "263567"false,
           "termStartCriteria": false
       }
   ],
      "nameworkflows": "Part[
of speech",      {
             "__objtype": "ProjectWorkflow",
           "dataCatid": "partOfSpeech1179204",
           "name": "March      concepts created",
            "dictionaryIDdescription": "263507Signal new concepts",
           "dictionaryID": "312",
                  "dataType"active": "PICKLISTtrue",
           "tasklist": [
               "CreateConcept"
  "picklist": [        ],
           "conditionlist": [
               {
  "noun",                 "__objtype": "WorkflowCondition",
                    "fieldID": "verb347",
                   "logicalOp": "NOP",
                   "adjectivecompareOp": "CONTAINS",
                   "value": "product"
               }
  "adverb",         ],
           "functioncalllist": [
               {
 "properNoun",                  "__objtype": "WorkflowFunctionCall",
                   "function": "otherSendEmail",
                   "parameter_map": {
          ],             "content.type": "1",
                  "required": false,       "digest.type": "1",
                        "minLensubject": 0,
       "${workflow_name} ${%addl}",
                       "maxLendigest.enabled": 16383"true",
                       }"digest.jobnumber.oid": "13vk9",
                       {
  "wflow.name": "March concepts created",
                            "__objtype"msg.text": "FieldPlease add!",
       
                       "iddigest.displayed.langs": "263623eng,deu,swe",
                               "name"rcpt.type": "Example1",
      
                        "dataCatdigest.number": "example2",
                               "dictionaryID"digest.id": "26350713vk8",
 
                             "dataType"email": "NOTE_TEXTtranslators@example.com",
  
                            "required": false,
      "project.oid": "13e65",
                        "minLendigest.schedule.value": "0, * * * *"
                       }
   "maxLen": 16383           }
           ]
}        }
       ]
}

Anchor
projectworkflow
projectworkflow

parent
Panel
titleDomainProjectWorkflow
Contains data about a domain

Represents a Workflow defined in a

dictionary

Project.

 XML-RPC object structure:

{ "__objtype": "Domain", "id": "1356", "name": "FOOD & AGRI", "dictionaryID": "1167", "parent": "0", "children": [ {
ParameterTypeValue
__objtypeString'
Domain
ProjectWorkflow'
idString
Domain
Workflow ID
nameString
Domain
Workflow name
dictionaryID
activeBooleanTrue if the workflow is active
descriptionString
ID of dictionary to which the domain belongs
Description for the workflow
dictionaryIDStringID
of parent domain. 0 for a top level domain.children
for the dictionary connected to this workflow
tasklistArray [
Domain
String]Array of
subdomain objects to this domain.
Code Block
tasks that triggers this workflow. See WorkflowTask.
conditionListArray [WorkflowCondition]Array of conditions in this workflow
functionCallListArray [WorkflowFunctionCall]Array of of function calls in this workflow

Example:

Code Block
{
   "__objtype": "DomainProjectWorkflow",
       "id": "13571179204",
       "name": "agricultureMarch concepts created",
   
   "dictionaryIDdescription": "1167Signal new concepts",
   
   "parentdictionaryID": "1356312",
 
     "children": []
     }
}
Panel
titleField

XML-RPC object structure

ParameterTypeValue
__objtypeString'Field'
idStringField ID
nameStringField name
dataCatStringData category. See DataCategory
dictionaryIDStringID for the dictionary to which the field belongs
dataTypeStringData type. See FieldDataType
picklistArray [String]Array of picklist values. Only set if dataType is PICKLIST
requiredBooleanTrue if the field is required to have a value
regExpStringRegular expression that the field value should match
minLenIntegerMinimum length for the field value
maxLenIntegerMaximum length for the field value
Code Block
{
   "__objtype": "Field",
   "id": "263601",
   "name": "Usage status",
   "dataCat": "administrativeStatus",
   "dictionaryID": "263507",
   "dataType": "PICKLIST",
   "picklist": [
     "preferredactive": "true",
   "tasklist": [
     "CreateConcept"
   ],
   "conditionlist": [
     {
       "__objtype": "WorkflowCondition",
       "fieldID": "347",
       "logicalOp": "NOP",
       "compareOp": "CONTAINS",
       "value": "product"
     }
   ],
   "functioncalllist": [
     {
       "__objtype": "WorkflowFunctionCall",
       "function": "SendEmail",
       "admittedparameter_map",: {
    "notRecommended",     "content.type": "obsolete1",
   ],      "requireddigest.type": false"1",
    "minLen": 0,    "maxLensubject": 16383
}
Panel
titleFilter

XML-RPC object structure

ParameterTypeValue
__objtypeString'Filter'
idStringFilter ID
nameStringFilter name
dictionaryIDStringID for the dictionary containing the filter
filterCriteriaArray [FilterCriteria]Array of filter criteria in the filter
Code Block
{
   "__objtype": "Filter",
   "id": "4729661",
   "name": "Concept 36",
   "dictionaryID": "267514",
   "filterCriteria": [
   {"${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",
         "__objtypedigest.number": "FilterCriteria2",
         "digest.id": "472968313vk8",
         "fieldIDemail": "264306685translators@example.com",
         "comparisonproject.oid": "EQUALS13e65",
 
   "value": "36",      "logicalOpdigest.schedule.value": "NOP",0 * * * *"
 "relDate": false,     }
"termStartCriteria": false    }
   ]
}

Anchor
section
section

{ "__objtype": "FilterCriteria", "id": "4729683", "fieldID": "264306685", "comparison": "EQUALS
Panel
titleFilterCriteriaSection

Contains information data about a single criteria within a Filtera section in a dictionary.

XML-RPC object structure

ParameterTypeValue
__objtypeString'
FilterCriteria
Section'
idString
FilterCriteria ID
fieldIDStringID for the field containing the value to compare
comparisonStringThe comparison operator. See CriteriaComparison.
valueStringThe value to compare the field value against
logicalOpStringThe logical operator following this criteria. See CriteriaOperator.
relDateBooleanTrue if the criteria value represents a date relative to now
termStartCriteriaBooleanTrue if the criteria is the start of a term field criteria group in the filter
Code Block
Section ID
nameStringSection name
dictionaryIDStringID for the dictionary to which the section belongs

Example:

Code Block
{
   "__objtype": "Section",
   "valueid": "361593347",
   "logicalOpname": "NOPMy section",
   "relDatedictionaryID": false,
  "termStartCriteria1167": false
}

Anchor
termentry
termentry

Settings for imports of term data.

Map from language names/codes in import file to language iso3 codes in dictionary
Panel
titleImportSettings
TermEntry

Contains information about a term entry in a dictionary. 

 XML-RPC object structure 

ParameterType
Value
__objtypeString'ImportSettings'
idStringImportSettings ID
nameStringImportSettings name
dictionaryIDStringID for the dictionary to which the import settings belong
userIDStringID for the user owning the import settings
conceptIDSyncStringHow concepts should be synchronized on conceptID. See ConceptSyncMethod for possible values.
indexTermSyncStringHow concepts should be synchronized on index term for a language. SeeConceptSyncMethod for possible values. If this value is different fromConceptSyncMethod.NO_SYNC it overrides the value for conceptIDSync.
termSyncStringHow terms should be synchronized within a concept. See TermSyncMethod for possible values.
publiclyVisibleBooleanTrue if the settings should be available for all users within the client.
indexTermLanguagesArray [String]Array of iso3 language codes used for synchronization of concepts when indexTermSync is used
affectedConceptFieldsArray [String]Array of IDs of concept level fields that may be modified by the import
affectedLanguagesArray [String]Array of iso3 codes for languages which may be modified by the import
sectionIDMapStruct [String→String]Map from section names in import file to section IDs in dictionary
conceptFieldIDMapStruct [String→String]Map from concept level field names in import file to concept field IDs in dictionary
termFieldIDMapStruct [String→String]Map from term level field names in import file to term field IDs in dictionary
languageIsoMapStruct [String→String]
Value
__objtypeString'TermEntry'
idStringTermEntry ID (internal use)
nameStringTerm name
termIDStringTerm ID value (visible in GUI)
toBeDeletedBooleanSet to true if this term should be deleted from the concept
conceptEntryIDStringID of the concept to which the Term belongs
dictionaryIDStringID of the dictionary to which the Term belongs
languageStringISO3 language code for the term
regionStringRegion code for the term (since 2.10)
scriptStringScript code for the term (since 2.10)
fieldsStruct [String->String]Map of field names to field values (term level fields)

Example:

Code Block
{
   "__objtype": "ImportSettingsTermEntry",
   "id": "4731072437",
   "name": "Merge importfish",
   "dictionaryIDtermID": "26751480-2",
   "userIDtoBeDeleted": "1073709057"false,
   "conceptIDSyncconceptEntryID": "DEFINITION436",
   "indexTermSyncdictionaryID": "MERGE312",
   "termSynclanguage": "DEFINITIONeng",
   "publiclyVisibleregion": false"GB",
   "indexTermLanguagesscript": [
      "eng"
   ] "Latn",
   "affectedConceptFieldsfields": {
[     "Process status": "267518finalized"
   ],
   "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"
   }
}
Panel
titleImportValidationReport
Contains results of a validation of an import file
}
}

Anchor
user
user

Panel
titleUser

Contains data about a user in the system.

XML-RPC object structure

ParameterTypeValue
__objtypeString'User'
idStringUser ID
nameStringUser login name
fullNameStringUser full name
emailStringUser's email address
activeBooleanTrue if the user account is enabled

Example:

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

Anchor
virtualfile
virtualfile

Panel
titleVirtualFile

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

XML-RPC object structure

ParameterTypeValue
__objtypeString'VirtualFile'
idStringVirtualFile ID
nameStringVirtualFile name
typeStringFile type
descriptionStringDescription for the file
database64File content

Example:

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

Anchor
workflowcondition
workflowcondition

sectionNames
Panel
titleWorkflowCondition

Defines a condition in a workflow.

XML-RPC object structure

ParameterTypeValue
__objtype
String'ImportValidationReport'
fileFormatStringThe detected format of the import file
conceptCountMapStruct [String->Integer]Map from section names to number of concepts in each section
termCountIntegerTotal number of terms found in the file
Array [
String
]Array of section names found in the file that exist in the dictionarymissingSectionNamesArray [String]Array of section names found in file that do not exist in the dictionarylanguageNamesArray [String]Array of names of languages found in file that exist in the dictionarylanguageCodesArray [String]Array of iso3 codes of languages found in file that exist in the dictionarymissingLanguageCodesArray [String]Array of language codes found in the file that do not exist in the dictionaryconceptFieldNamesArray [String]Array of concept field names found in the file that exist in the dictionarytermFieldNamesArray [String]Array of term field names found in the file that exist in the dictionarymissingConceptFieldNamesArray [String]Array of concept field names found in the file that do not exist in the dictionarymissingTermFieldNamesArray [String]Array of term field names found in the file that do not exist in the dictionarydomainPathsArray [String]Array of domain name paths, each domain name in a path separated by semicolonunresolvedIDsArray [String]Only for internal usefatalErrorsArray [String]Array of fatal error messages found during validation
'WorkflowCondition'
fieldIDStringID of the field which this condition checks
logicalOpStringLogical operation that connects this condition with the next in the workflow. See CriteriaOperator.
comparisonOpStringComparison operator for the field value. See CriteriaComparison.
valueStringThe field value to compare against.

Example:

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

Anchor
workflowfunctioncall
workflowfunctioncall

Panel
titleWorkflowFunctionCall

Defines a function call inside a workflow.

 XML-RPC object structure

ParameterTypeValue
__objtypeString'WorkflowFunctionCall'
functionStringWorkflow function to call. See WorkflowFunction.
parameter_mapStructMap of parameter names and values for the function call. Available parameters depends on the workflow function.

Example:

Code Block
{
   "__objtype": "ImportValidationReportWorkflowFunctionCall",
   "fileFormatfunction": "TBXSendEmail",
   "conceptCountMapparameter_map": {},
   "termCount":11,    "sectionNamescontent.type":[] "1",
   "missingSectionNames":[    "digest.type":  "Section 1",
   ],    "languageNamessubject":[
     "en", "fr""${workflow_name} ${%addl}",
   ],    "languageCodesdigest.enabled":[ "true",
       "eng",digest.jobnumber.oid": "fra13vk9",
   ],    "missingLangCodeswflow.name":[], "March concepts  created"conceptFieldNames":[],
   "termFieldNames":[
     "contextmsg.text",: "partOfSpeechPlease add!",
   ],    "missingConceptFieldNamesdigest.displayed.langs":[      "relatedConceptBroader", "relatedConcept"
   ]"eng,deu,swe",
   "missingTermFieldNames":[],    "domainPathsrcpt.type":[],    "unresolvedIds1":[],

  "fatalErrors",[] }
Panel
titleIndexTerm

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

ParameterTypeValue
__objtypeString'IndexTerm'
termStringTerm name
conceptEntryIDStringID for the concept entry
termEntryIDStringID for the term entry
Code Block
{    "__objtypedigest.number": "IndexTerm2",
      "term "digest.id": "13vk8",
       "email": "fishtranslators@example.com",
   "conceptEntryID    "project.oid": "43613e65",
   "termEntryID    "digest.schedule.value": "437"0 * * * *"
   }
}