Complete method list
- Patrik Westlund
This section lists all methods in the API in alphabetical order.
Methods
Parameters
String sessionID
Closes a session (logs out user) on the server.
Return Value
none
Errors
none
Parameters
String sessionID, Struct twObj
Creates the specified object with the session.
The following types are handled: ConceptEntry, Filter, ImportSettings, Project, Section, TermEntry, VirtualFile
Return value
String - The ID for the created object
Errors
Parameters
String sessionID, String dictName, String fileID
Creates a new dictionary from a virtual file. File should be in either TBX or Excel (optionally zipped) format.
Return value
Struct - The created Dictionary
Errors
Parameters
String sessionID, String typeClass, String id
Deletes the object with specified ID.
The following types are handled: ConceptEntry, Filter, ImportSettings, Project, TermEntry, VirtualFile
Return value
Boolean - True if the object was deleted
Errors
Parameters
String sessionID, String typeClass, String id
Checks if an object with specified type and ID exists.
The following types are handled: Client, ConceptEntry, Dictionary, Domain, Filter, ImportSettings, Language, Project, Section, TermEntry, User, VirtualFile
Return value
Boolean - True if the object exists
Errors
Parameters
String sessionID, String typeClass, String name
Checks if an object with the specified type and name exists.
The following types are handled: Client, Dictionary, Domain, Filter, ImportSettings, Language, Project, Section, User
Return value
Boolean - True if the object exists
Errors
Parameters
String sessionID, String typeClass, String id, String format
Exports an object to the specified format and returns it as a string.
| Supported types | Supported formats | Comment |
|---|---|---|
Dictionary | TW3, TBX, XDT | Exports dictionary definition |
Return value
String - The exported object.
Errors
Parameters
String sessionID, String format, int startIndex
From the selected dictionary, exports all concepts into a result object as XML segments in the specified DataFormat.
This method returns at most 100 concepts per call. If there are more changed concepts, this is indicated by the moreResults property in the ConceptXmlResult object, and you can call this method again and increase the start index value.
Return value
Struct - A ConceptXmlResult object.
Errors
Parameters
String sessionID, String format, boolean withAttachments
Exports all concepts in the selected dictionary to a virtual file in the specified DataFormat. Set withAttachments to true if the export should include attachments from the concepts.
Return value
String - The ID for the generated file
Errors
Parameters
String sessionID, String dateStr, String format, int startIndex
From the selected dictionary, exports all changed concepts after a specified date into a result object as XML segments.
This method returns at most 100 concepts per call. If there are more changed concepts, this is indicated by the moreResults property in the ConceptXmlResult object, and you can call this method again and increase the start index value.
| Accepted date string formats |
|---|
| yyyy-MMM-dd HH:mm:ss Z |
| yyyy-MM-dd HH:mm:ss |
| yyyy-MM-dd HH:mm |
| yyyy-MM-dd |
| yyyyMMdd |
Return value
Struct - A ConceptXmlResult object.
Errors
Parameters
String sessionID, String typeClass, String id, String format
Exports an object to the specified format and saves it as a virtual file.
| Supported types | Supported formats | Comment |
|---|---|---|
Dictionary | TW3, TBX, XDT | Exports dictionary definition |
Return value
String - The ID of the created virtual file
Errors
Parameters
String sessionID, String typeClass
Returns all objects for the specified type.
The following types are handled: Client, Dictionary, Domain, Filter, ImportSettings, Language, Project, Section, VirtualFile
Return value
Array- A list of the all objects.
Errors
Parameters
(none)
Returns the version of the API from the server.
Return Value
String - The version string
Errors
none
Parameters
String sessionID, String conceptEntryID
Returns the concept entry with specified ID.
Metadata will not be included in the object returned. Use generic getObject method to retrieve metadata fields.
Return value
Struct - The concept entry
Errors
Parameters
String sessionID, String conceptID
Returns the concept entry with specified concept ID.
Metadata will not be included in the object returned.
Return value
Struct - The concept entry
Errors
Parameters
String sessionID, Array sectionIdList
Returns the Concept IDs in the specified sections.
This is the Concept ID visible in the GUI, not the ConceptEntryID used internally.
Return value
String - A comma-separated string with all Concept IDs
Errors
Parameters
String sessionID, String searchExp
Returns the index term result objects for the specified search expression.
String sessionID, Struct searchCondMap
Returns the index term result objects for the specified search expression and/or start position.
String sessionID, Struct searchCondMap, String targetLang
Returns the index term result objects for the specified search expression, translated into specified target language.
Search condition map
| Parameter | Description |
|---|---|
| searchExp | The search expression |
| fromPos | The start index in the result list |
Return value
Array - A list of IndexTerm objects
Errors
Parameters
String sessionID, String typeClass, String id
Retrieves the object with specified type and ID.
The following types are handled: Client, ConceptEntry, Dictionary, Domain, Filter, ImportSettings, Language, Project, Section, TermEntry, VirtualFile
Return value
Struct - The object
Errors
Parameters
String sessionID, String typeClass, String name
Returns an object with specified type and name.
The following types are handled: Client, Dictionary, Domain, Filter, ImportSettings, Project, Section, VirtualFile
Return value
Struct - The object
Errors
Parameters
String sessionID, String typeClass
Returns the selected object of specified type.
The following types are handled: Client, Dictionary, Domain, Filter, Language, Section
Return value
Struct - The selected object
Errors
Parameters
String sessionID, String typeClass
Returns the selected objects of specified type.
The following types are handled: Domain, Section
Return value
Array - List of selected objects
Errors
Parameters
String sessionID
Returns the selected source language in the dictionary.
Return value
String - An iso3 language code
Errors
Parameters
String sessionID, Struct searchCondMap, String targetLangCode
Returns corresponding term entries in specified target language for the source language term entries matching the search expression.
Search condition map
| Parameter | Description |
|---|---|
| searchExp | The search expression |
| fromPos | The start index in the result list |
Return value
Array - List of TermEntry objects
Errors
Parameters
String sessionID, String termID
Returns the term entry with specified term ID.
Metadata will not be included in the object returned.
Return value
Struct - The TermEntry object
Errors
Parameters
(none)
Returns the TermWeb version from the server.
Return Value
String - The version string
Errors
none
Parameters
String sessionID, String fileID, Struct StructimportValidationReport, importSettings
Imports term data from a virtual file into a dictionary. The dictionary is the one specified in the ImportSettings, not the currently selected dictionary.
The import validation report is returned from a previous call to validateFile.The import settings specifies what should be imported.
Return value
Boolean - True if the import was successful
Errors
Parameters
String sessionID, String typeClass, String fileID
Imports an object from a virtual file.
| Supported types | Supported formats | Comment |
|---|---|---|
| Dictionary | TW3, TBX, XDT | Creates dictionary from a dictionary definition file |
Return value
Boolean - True if the import was successful
Errors
Parameters
String clientLogin, String userLogin, String password
Creates a new session for the specified client login, user name and password.
String clientLogin
Creates a new session for the guest user for specified client login.
(none)
Creates a new session for a Guest user with auto-login enabled.
Return value
String - The session ID
Errors
Parameters
String sessionID, String typeClass, String id
Checks if the object with specified type and ID is selected.
The following types are handled: Client, Dictionary, Domain, Filter, Language, Section
Return value
Boolean - True if the object with specified ID is selected.
Errors
Parameters
String sessionID, String typeClass
Sets all objects of specified type as selected.
The following types are handled: Domain, Section
Return value
Integer - 0
Errors
Parameters
String sessionID, String typeClass, String id
Sets the object with specified type and ID as selected.
The following types are handled: Client, Dictionary, Domain, Filter, Language, Section
Return value
Integer - 0
Errors
Parameters
String sessionID, String langCode
Selects the source language.
Return value
Integer - 0
Errors
Parameters
String sessionID, String xml, String format
Creates a new concept from XML in the currently selected section. If multiple sections are selected, the first one is set for the new concept.
See DataFormat for possible values for format.
Return value
String - The ConceptID of the created concept.
Errors
Parameters
String sessionID, Struct twObj
Updates the specified object.
The following types are handled: ConceptEntry, Filter, ImportSettings, Project, TermEntry
Return value
Boolean - True if the object was updated
Errors
Parameters
String sessionID, String dictID, Struct importValidationReport, String fileID
Updates the structure of an existing dictionary with the missing fields, sections, domains and languages from the specified validation report and virtual file. File should be in either TBX or Excel (optionally zipped) format.
The import validation report is returned from a previous call to validateFile.
Return value
Struct - ImportSettings that can be used to import term data from the file into the dictionary
Errors
Parameters
String sessionID, String fileID, String dictID
Validates a virtual file containing term data for import against a dictionary.
Return value
Struct - An import validation report object with results from the validation.