API
From Lingotek
addCompany
Add a company to the system
- parameters:
-
companyName- Name of the company to add
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the company added -
name- Name of the company added
-
- examples:
- Add a company with the name WidgetsInc.:
-
addContact
Add a contact to the contact list of the current active user
- parameters:
-
userEmail- Email address of the user to add as a contact -
comment(optional) - Comment about the contact being added
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the user associated with the contact being added -
comment- Comment about the contact being added
-
- examples:
- Add a contact with the email address user@server.com to the contact list:
- Add a contact with the email address user@server.com to the contact list, and also add the comment text 'I met this translator at TAUS last year.' for the contact:
http://apitest.lingotek.com/lingopoint/api/addContact?userEmail=user@server.com&comment=I met this translator at TAUS last year.
-
addDictionary
Add a dictionary to the system
- parameters:
-
dictionaryName- Name of the dictionary to add
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the dictionary which was added -
name- Name of the dictionary which was added
-
- examples:
- Add a dictionary with the name English-Spanish Dictionary:
-
addDocument
Add a document to a project
- parameters:
-
projectId- Id of the project in which to add this document -
file- Multi-part file parameter for uploaded file -
documentName- Display name of the document -
format- Format of the document The format parameter can be one of the following supported types: "WORD", "HTML", "ODT", "ODS", "ODP", "PLAINTEXT", "XML", "DOCX" -
encoding- Character set encoding of the document See the IANA registry for allowable character sets. Please note that not all of the IANA registered character sets are supported by all Java systems by default. A list of Java-supported encodings can be found here. -
translationSteps- Number of translation steps for the document This translation steps parameter can be one of the following values:1,2,3 -
sourceLanguage- Source language of the document The format of this parameter should be in the form ofLANGUAGECODE_COUNTRYCODEsuch asen_US. A list of language codes can be found here and a list of country codes can be found here. -
targetLanguage- Target language of the document The target language parameter is a multi-parameter. More than one value can be assigned for the parameter name in order to denote multiple target languages.The format of this parameter should be in the form ofLANGUAGECODE_COUNTRYCODEsuch asen_US. A list of language codes can be found here and a list of country codes can be found here. -
tmVaultId- Id of the vault into which the translation memory of this document will be stored -
tmTarget(optional) - Target language of the TMs contained in this document. This is only available for certain types of TM source documents, such as gettext .po files. The format of this parameter should be in the form ofLANGUAGECODE_COUNTRYCODEsuch asen_US. A list of language codes can be found here and a list of country codes can be found here. -
calculatePartialMatch(optional) - Calculate partial match flag Setting this flag totruewill allow partial matches to be retrieved from TM vaults when searching for hits. Please note that setting this flag totruewill slow performance of searching slightly. -
zipFile(optional) - Zip file flag Setting this flag totruewill allow import of a zip file.
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the document added -
name- Name of the document added -
description- Description of the document added -
sourceCharacterCount- Number of total characters in the translatable text of the document added -
sourceWordCount- Number of words in the translatable text of the document added -
sourceSentenceCount- Number of sentences in the translatable text of the document added -
uniqueWordCount- Number of unique words in the translatable text of the document added -
uniqueSentenceCount- Number of unique sentences in the translatable text of the document added -
duplicateWordCount- Number of duplicate words in the translatable text of the document added -
duplicateSentenceCount- Number of duplicate sentences in the translatable text of the document added
-
- examples:
- Add a text document in English with the name MyDocument.txt, to be translated into German and not reviewed.Note that the
fileparameter is not including in these example, as the thin web client should have utility methods for handling multi-part parameters for file uploads, and the example url would exceed the maximum url width otherwise.: - Add a gettext .po document with English keys and values associated with French, to be translated into German,French and Spanish with two review phases.:
- Add a series of Spanish OpenDocument Text files in a zip file, to be translated into German and French with noreview phase. The document names will be taken from the file names within the zip file.:
-
addPhase
Add a phase to a translation target within a document
- parameters:
-
translationTargetId- Id of the translation to which this phase will be added -
phaseName- Name of the phase -
phaseDescription(optional) - Description of the phase -
isCommunityAccess(optional) - Community access flag for the phase which is added when the phase template is applied Setting this flag totruewill make the phase associated with this phase template into a community phase -
isSelfAssigned(optional) - Self-assigned flag for the phase which is added when the phase template is applied Setting this flag totruewill make the phase associated with this phase template into a self-assigned phase
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the phase added -
name- Name of the phase added -
description- Description for the phase added -
communityAccess- Type of community access for the phaseopenif the phase is open to all members of the community to work on concurrently,singleif the phase is only open to the first translator in the community who accepts it, or empty if this phase doesn't have community access -
order- Order of the phase in the project workflow A value of0indicates a translation phase, and higher values indicate review phases
-
- examples:
- Add a phase with the name Translation and the description 'Professionally Translated':
-
addPhaseTemplate
Add a phase template for the current active user to the system
A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied
- parameters:
-
phaseTemplateName- Name of the phase template to add
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the phase template -
name- Name of the phase template -
phaseParameters[]- List of parameters for the phases that will be added when this phase template is applied-
id- Id of the phase parameter set -
name- Name of the phase -
description- Description of the phase -
order- Order of the phase, a value of0indicates a translation phase, and higher values indicate review phases
-
-
- examples:
- Add a phase template with the name MyWorkflow:
-
addPhaseToTemplate
Add the parameters for creating a phase to a phase template
A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied
- parameters:
-
phaseTemplateId- Id of the phase template into which the phase parameters will be added -
phaseName- Name of the phase which is added when the phase template is applied -
phaseDescription(optional) - Description of the phase which is added when the phase template is applied -
isCommunityAccess(optional) - Community access flag for the phase which is added when the phase template is applied Setting this flag totruewill make the phase associated with this phase template into a community phase -
isSelfAssigned(optional) - Self-assigned flag for the phase which is added when the phase template is applied Setting this flag totruewill make the phase associated with this phase template into a self-assigned phase
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the phase parameter set -
name- Name of the phase -
description- Description of the phase -
order- Order of the phase, a value of0indicates a translation phase, and higher values indicate review phases
-
- examples:
- Add a phase with the name Translation and the description 'Professionally Translated' to a phase template:
- Add a phase with the name Translation and the description 'Professionally Translated' that is open for translation to the community to a phase template:
http://apitest.lingotek.com/lingopoint/api/addPhaseToTemplate?translationId=1&phaseName=Translation&phaseDescription=Professionally Translated&isCommunityAccess=true&isSelfAssigned=true
-
addProject
Add a project to the system
- parameters:
-
projectName- Name of the project -
projectDueDate- Date of the deadline for completing the project The format of this parameter should be in the date format ofMM-dd-yyyysuch as12-31-2000. -
companyId- Id of the company to which this project is associated -
searchPublic(optional) - Search public vault flag Setting this flag totruewill search public vaults for hits as well as the vaults associated with this project's documents.
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the project added -
name- Name of the project added -
dueDate- Date of the deadline for completing the project which was added
-
- examples:
- Add a project with the name MyProject which has a deadline for completion on Jan 1st, 2000.:
- Add a project with the name MyProject which has a deadline for completion on Jan 1st, 2000, and will search for hits in public vaults as well as the vault associated with the project.:
-
addSegmentLabelTemplate
Add a segment label template for the current active user to the system
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
segmentLabelTemplateName- Name of the segment label template to add -
segmentLabels(optional) - The segment labels to add to the segment label template ThesegmentLabelsparameter is a multi-parameter. More than one value can be assigned for the parameter name in order to denote multiple segment labels.
-
- response:
-
results- Result of operation, eithersuccessorfail -
clientId- Id of the client who owns the label template -
name- Name of the label template -
labels[]- List of the labels in the label template
-
- examples:
- Save a new empty label template with the name MyTemplate.:
- Save a new label template with the name MyTemplate, which contains the labels
h2,@alt, anda@href.:
-
addSegmentLabelToTemplate
Add a segment label to a segment label template
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
segmentLabelTemplateName- Name of the segment label template into which the segment label will be added -
segmentLabels- The segment labels to add to the segment label template ThesegmentLabelsparameter is a multi-parameter. More than one value can be assigned for the parameter name in order to denote multiple segment labels.
-
- response:
-
results- Result of operation, eithersuccessorfail -
label- Name of the segment label which was added
-
- examples:
- Add a segment label for the alternate text in an image tag to a segment label template with the name MyTemplate:
-
addTMVault
Add a translation memory vault to the system
- parameters:
-
tmVaultName- Name of the translation memory vault -
isPublic(optional) - Public vault flag
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the translation memory vault which was added -
name- Name of the translation memory vault which was added
-
- examples:
- Add a translation memory vault with the name MyVault:
- Add a translation memory vault with the name MyVault and open it for public search hits:
-
addTranslationTarget
Add a translation for a particular target language to a document
- parameters:
-
documentId- Id of the document in which to add this translation target -
targetLanguage- Target language of the translation The format of this parameter should be in the form of _ such as "en_US". A list of language codes can be found at http://www.loc.gov/standards/iso639-2/englangn.html and a list of country codes can be found at http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html -
phaseTemplateId- Id of the phase set template to apply to the translation target The phase set template contains a list of templates for the phases that will be added to the translation
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the translation target which was added -
targetLanguage- Language code for the target language of the translation target which was added -
phases[]- List of phases for the translation target which was added-
id- Id of the phase -
order- Order of the phase, a value of0indicates a translation phase, and higher values indicate review phases -
name- Name of the phase -
description- Description of the phase -
community_access-trueif the phase is open to all members of the community,falseif the phase must be assigned by a project manager
-
-
- examples:
- Add a translation target for the language French:
-
analyzeDocument
Begin an analysis of a document
100% matches are automatically inserted into the target.
Progress can be obtained from a call to pollDocumentAnalysis
- parameters:
-
documentId- Id of the document to analyze
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Analyze a document for duplication and search hit matching and insert exact matches:
-
analyzeProject
Begin an analysis of all of the documents in a project
100% matches are automatically inserted into the target.
Progress can be obtained from a call to pollProjectAnalysis
- parameters:
-
projectId- Id of the project to analyze
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Analyze all the documents in a project for duplication and search hit matching and insert exact matches:
-
applySegmentLabelTemplate
Apply a segment label template to a document and recalculate that document's statistics
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
documentId- Id of the document to which the template is applied -
segmentLabelTemplateName- Name of the segment label template
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Apply the segment label template with the name MyTemplate to a document, marking all segments matching the labels in the template as non-translatable text:
-
assignPhaseTranslator
Assign a translator to a phase
- parameters:
-
phaseId- Id of phase to which the translator will be assigned -
translatorUserId- Id of the user associated with the translator to assign
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Assign a user as a translator to a phase:
-
assignProjectManager
Assign a manager to a project
- parameters:
-
projectId- Id of the project to which the manager will be assigned -
managerLoginName(optional) - Login name of manager, e.g.manager@domain.netThis parameter is optional, however you must specify eithermanagerLoginNameormanagerUserId. -
managerUserId(optional) - User id of manager This parameter is optional, however you must specify eithermanagerLoginNameormanagerUserId.
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Assign a user as a manager to a project:
- Assign the user with the login name user@server.com as a manager to a project:
-
dismissPhaseTranslator
Dismiss a translator from a phase
- parameters:
-
phaseId- Id of phase from which the translator will be dismiss -
translatorUserId- Id of the user associated with the translator to dismiss
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Dismiss a translator from a phase:
-
dismissProjectManager
Dismiss a manager from a project
- parameters:
-
projectId- Id of the project from which the manager will be dismissed -
managerUserId- User id of manager
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Dismiss a manager from a project:
-
downloadDocument
Download the original format of a translated document in a specific target language
This call is generally only applicable after the translation is complete.
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Download the translated version of a document for the German target language.:
-
downloadDocumentAsCSV
Download the translation memory associated with a specific target language of a document in CSV format
This call is generally only applicable after the translation is complete.
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Download the translation memory for a document in CSV format for the German target language.:
-
downloadDocumentAsTMX
Download the translation memory associated with a specific target language of a document in TMX format
This call is generally only applicable after the translation is complete.
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Download the translation memory for a document in TMX format for the German target language:
- Download the translation memory for a document in TMX format for all translation target languages:
-
downloadDocumentAsXliff
Download the translation memory associated with a specific target language of a document in XLIFF format
This call is generally only applicable after the translation is complete.
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Download the translation memory for a document in XLIFF format for the German target language:
- Download the translation memory for a document in XLIFF format for all translation target languages:
-
editCompany
Edit the details for a company
- parameters:
-
companyId- Id of the company to edit -
companyName(optional) - New name of the company
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the company added -
name- Name of the company added
-
- examples:
- Change the name associated with a company to MyCompany:
-
editContact
Edit the details for a contact in the contact list of the current active user
- parameters:
-
contactId- Id of the user corresponding to the contact to edit -
comment(optional) - Comment about the contact being added
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the comment associated with a contact to 'This person charges a fair price per word.':
http://apitest.lingotek.com/lingopoint/api/editContact?contactId=1comment=This person charges a fair price per word.
-
editDictionary
Edit the details for a dictionary within the system
- parameters:
-
dictionaryId- Id of the dictionary to edit -
dictionaryName(optional) - New name of the dictionary
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the name associated with a dictionary to MyDictionary:
-
editDocument
Edit the details for a document within a project
- parameters:
-
documentId- Id of the document to edit -
documentName(optional) - New display name of the document -
tmVaultId(optional) - Id of the new vault into which the translation memory of this document will be stored
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the name associated with a document to MyDocument:
- Change the name and translation memory vault associated with a document:
-
editPhase
Edit the details for a phase within a translation target of a document
- parameters:
-
phaseId- Id of the phase to edit -
phaseName(optional) - New name of the phase -
phaseDescription(optional) - New description of the phase -
isCommunityAccess(optional) - Community access flag for the phase which is added when the phase template is applied Setting this flag totruewill make the phase associated with this phase template into a community phase -
isSelfAssigned(optional) - Self-assigned flag for the phase which is added when the phase template is applied Setting this flag totruewill make the phase associated with this phase template into a self-assigned phase
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the name associated with a phase to MyPhase:
- Change the description associated with a phase to 'Professionally Translated':
-
editPhaseTemplate
Edit the details for a phase template for the current active user
A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied
- parameters:
-
phaseTemplateId- Id of the phase template to edit -
phaseTemplateName(optional) - New name of the phase template
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the name associated with a phase template to MyTemplate:
-
editProject
Edit the details for a project from the system
- parameters:
-
projectId- Id of the project to edit -
projectName(optional) - New name of the project -
projectDueDate(optional) - New ate of the deadline for completing the project The format of this parameter should be in the date format ofMM-dd-yyyysuch as12-31-2000. -
companyId(optional) - New id of the company to which this project is associated -
searchPublic(optional) - Search public vault flag Setting this flag totruewill search public vaults for hits as well as the vaults associated with this project's documents.
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the name associated with a project to MyProject:
- Change the due date associated with a project to January 31st, 2000:
- Change the name and company associated with a project, and store the translation memory for the project into a public translation memory vault:
-
editSegmentLabelTemplate
Edit the details for a segment label template for the current active user from the system
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
segmentLabelTemplateName- Name of the segment label template to edit
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
editTMVault
Edit the details for a translation memory vault within the system
- parameters:
-
tmVaultId- Id of the translation memory vault to edit -
tmVaultName(optional) - New name of the translation memory vault -
isPublic(optional) - Public vault flag
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Change the name associated with a translation memory vault to MyVault:
- Make a vault accessible to public search hits:
-
editTranslationTarget
Edit the details for a translation target within a document
- parameters:
-
translationTargetId- Id of the translation target to edit
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
extractTerminologyTerms
Begin extraction of terminology from one or more documents and list the terminology terms which have already been extracted for the documents
- parameters:
-
documentId- Id of the document to extract terminology from
-
- response:
-
results- Result of operation, eithersuccessorfail -
terminology[]-List of extracted terminologies for the document
-
- examples:
- Extract the terminology terms from a document.:
-
getCompany
Get the object representing a particular company
- parameters:
-
companyId- Id of the company
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the company -
name- Name of the company
-
- examples:
- List the details about a company:
-
getContact
Get the object representing a particular contact
- parameters:
-
contactId- Id of the user corresponding to the contact
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the user associated with the contact -
comment- Comment about the contact
-
- examples:
- List the details about a contact:
-
getDictionary
Get the object representing a particular dictionary
- parameters:
-
dictionaryId- Id of the dictionary
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the dictionary -
name- Name of the dictionary
-
- examples:
- List the details about a dictionary:
-
getDocument
Get the object representing a particular document
- parameters:
-
documentId- Id of the document
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the document -
name- Name of the document -
description- Description of the document -
sourceLanguage- Source language of the document -
tmVaultId- Id of the translation memoery vault which contains the translation memory for this document -
percentComplete- Percentage of the document which has been completed This is calculated from the average percentage of each translation target which has been completed for all of the translation targets in the document. -
sourceCharacterCount- Number of total characters in the translatable text of the document -
sourceWordCount- Number of words in the translatable text of the document -
sourceSentenceCount- Number of sentences in the translatable text of the document -
uniqueWordCount- Number of unique words in the translatable text of the document -
uniqueSentenceCount- Number of unique sentences in the translatable text of the document -
duplicateWordCount- Number of duplicate words in the translatable text of the document -
duplicateSentenceCount- Number of duplicate sentences in the translatable text of the document -
translationTargets[]- List of the translation targets for the document-
id- Id of the translation target -
language- Language for the translation target -
dueDate- Date of the deadline for completing the translation target -
percentComplete- Percentage of the translation target which has been completed. This is calculated from the average percentage of each phase which has been completed for all of the phases in the translation target -
matchSentences- Number of sentences which exactly match a translation memory in any of the vaults associated with the document -
matchWords- Number of words in the sentences which exactly match a translation memory in any of the vaults associated with the document
-
-
- examples:
- List the details about a document:
-
getPhase
Get the object representing a particular phase
- parameters:
-
phaseId- Id of the phase
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the phase added -
name- Name of the phase added -
description- Description for the phase added -
order- Order of the phase in the project workflow A value of0indicates a translation phase, and higher values indicate review phases -
communityAccess- Type of community access for the phaseopenif the phase is open to all members of the community to work on concurrently,singleif the phase is only open to the first translator in the community who accepts it, or empty if this phase doesn't have community access
-
- examples:
- List the details about a phase:
-
getPhaseTemplate
Get the object representing a particular phase template
A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied
- parameters:
-
phaseTemplateId- Id of the phase set template
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the phase template -
name- Name of the phase template -
phaseParameters[]- List of parameters for the phases that will be added when this phase template is applied-
id- Id of the phase parameter set -
name- Name of the phase -
description- Description of the phase -
order- Order of the phase, a value of0indicates a translation phase, and higher values indicate review phases
-
-
- examples:
- List the details about a phase template:
-
getProject
Get the object representing a particular project
- parameters:
-
projectId- Id of the project
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the project -
name- Name of the project -
dueDate- Date of the deadline for completing the project -
state- Current status of the project, eitherActiveorClosed -
companyId- Id of the company associated with this project -
percentComplete- Percentage of the project which has been completed. This is calculated from the average percentage of each document which has been completed for all of the documents in the project -
startDate- Date when the first document of the project was opened for translation. An empty value indicates that the project has not yet been started. -
completeDate- Date when the project was completed. An empty value indicates that the project has not yet been completed. -
createdDate- Date when the project was created. An empty value indicates that the project has not yet been started. -
documents[]- List of the documents within the project-
id- Id of the document -
name- Name of the document -
description- Description of the document -
tmVaultId- Id of the translation memory vault which contains the translation memory for this document -
percentComplete- Percentage of the document which has been completed This is calculated from the average percentage of each translation target which has been completed for all of the translation targets in the document.
-
-
- examples:
- List the details about a project:
-
getSegmentLabelTemplate
Get the object representing a particular segment label template
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
segmentLabelTemplateName- Name of the segment label template
-
- response:
-
results- Result of operation, eithersuccessorfail -
clientId- Id of the client who owns the label template -
name- Name of the label template -
labels[]- List of the labels in the label template
-
- examples:
- List the details about the segment label template with the name MyTemplate:
-
getTMVault
Get the object representing a particular translation memory vault
- parameters:
-
tmVaultId- Id of the translation memory vault
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the translation memory vault -
name- Name of the translation memory vault
-
- examples:
- List the details about a translation memory vault:
-
getTranslationTarget
Get the object representing a particular translation target
- parameters:
-
translationTargetId- Id of the translation target
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the translation target -
language- Language for the translation target -
dueDate- Date of the deadline for completing the translation target -
matchSentences- Number of sentences which exactly match a translation memory in any of the vaults associated with the document -
matchWords- Number of words in the sentences which exactly match a translation memory in any of the vaults associated with the document -
phases[]- List of phases for the translation target which was added-
id- Id of the phase -
order- Order of the phase, a value of0indicates a translation phase, and higher values indicate review phases -
name- Name of the phase -
description- Description of the phase -
order- Order of the phase in the project workflow A value of0indicates a translation phase, and higher values indicate review phases -
communityAccess- Type of community access for the phaseopenif the phase is open to all members of the community to work on concurrently,singleif the phase is only open to the first translator in the community who accepts it, or empty if this phase doesn't have community access
-
-
- examples:
- List the details about a translation target:
-
ignoreSegment
Flag a segment to be exclude from the translated text
- parameters:
-
segmentId- Id of the segment to ignore -
documentId- Id of the document to which the segment belongs
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the segment which was flagged
-
- examples:
- Exclude the segment with the id
61226404-8dbd-49d8-98bf-600d907b85d1from a document.:
-
listAssignedProjects
List all of the projects(both active and closed) which have been assigned to the current active user
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail -
projectAssignments[]- List of projects to which the client currently logged into the system has been assigned-
projectId- Id of the project -
projectName- Name of the project -
dueDate- Date of the deadline for completing the project -
percentComplete- Percentage of the project which has been completed. This is calculated from the average percentage of each document which has been completed for all of the documents in the project -
status- Current status of the project, eitherActiveorClosed
-
-
- examples:
- List the projects assigned to the current active user, as well as details about progress of the assigned projects:
-
listContacts
List all contacts in the contact list of the current active user
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail -
contacts[]- List of contacts in the contact list of the current active user-
id- Id of the user associated with this contact -
name- Name of the user associated with this contact -
email- Email address of the user associated with this contact -
translatorId- Id of the translator associated with this contact
-
-
- examples:
- List the contacts for the current active user:
-
listDictionaries
List all dictionaries which are owned by the current active user
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail -
dictionaries[]- List of dictionaries owned by the current active user-
id- Id of the glossary -
name- Name of the glossary
-
-
- examples:
- List the dictionaries for the current active user:
-
listDocumentSegmentLabels
List all of the segment labels for a document
- parameters:
-
documentId- Id of the document for which to list segment labels
-
- response:
-
results- Result of operation, eithersuccessorfail -
segmentLabels[]- List of segment labels for the document
-
- examples:
- List the segment labels found within a document:
-
listDocumentSegments
List the details about the source and target languages of a document, as well as all of the source sentences of the document
- parameters:
-
documentId- Id of the document to display segment information for
-
- response:
-
results- Result of operation, eithersuccessorfail -
description- Description of the document -
sourceLanguage- Source language of the document -
targetLanguages[]- List of the target languages of the document -
sentences[]- Unique source sentences within the document-
text- Text of source sentences -
segmentIds[]- List of ids for the segments corresponding to the source sentence.
-
-
- examples:
- List the details and source sentences of a document:
-
listLeaderboardResults
Show the leaderboard ranking statistics for a team, or if no team is specified, for the current active community
- parameters:
-
teamName(optional) - Name of the team to return leaderboard statistics for The team name parameter is optional. If not set, the statistics will be returned for the entire community. -
maxResults(optional) - Maximum number of results to return
-
- response:
-
results- Result of operation, eithersuccessorfail -
dayResults[]- List of leaderboard rankings for each user in the team or community for the past day-
userId- Id of the user -
userName- Name of the user -
points- Number of points the user has received in the past day -
rank- Rank of the user for the past day
-
-
weekResults[]- List of leaderboard rankings for each user in the team or community for the past week-
userId- Id of the user -
userName- Name of the user -
points- Number of points the user has received in the past week -
rank- Rank of the user for the past week
-
-
totalResults[]- List of leaderboard rankings for each user in the team or community-
userId- Id of the user -
userName- Name of the user -
points- Number of total points for the user -
rank- Overall rank of the user
-
-
- examples:
- List the leaderboard ranking results for the team with the name MyTeam.:
- List the leaderboard ranking results for the current community, and only display the top 10 users.:
-
listPhases
List details about all of the phases of a translation within a document
- parameters:
-
translationTargetId- Id of the translation target to list phases for
-
- response:
-
results- Result of operation, eithersuccessorfail -
phases[]- List of phases within the translation target-
id- Id of the phase -
name- Name of the phase -
description- Description of the phase -
communityAccess- Type of community access for the phaseopenif the phase is open to all members of the community to work on concurrently,singleif the phase is only open to the first translator in the community who accepts it, or empty if this phase doesn't have community access -
order- Order of the phase in the project workflow A value of0indicates a translation phase, and higher values indicate review phases
-
-
- examples:
- List the phases for a translation target within a document:
-
listPhaseTemplates
List all of the phase templates for the current active user
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail -
phaseTemplates[]- List of phase templates for the current active user-
id- Id of the phase template -
name- Name of the phase template -
phaseParameters[]- List of parameters for the phases that will be added when this phase template is applied-
id- Id of the phase parameter set -
name- Name of the phase -
description- Description of the phase -
order- Order of the phase, a value of0indicates a translation phase, and higher values indicate review phases
-
-
-
- examples:
- List the phase templates for the current active user:
-
listProjects
List all project which are owned or managed by the current active user
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail -
projects[]- List of projects owned or managed by the client currently logged into the system-
id- Id of the project -
name- Name of the project -
dueDate- Date of the deadline for completing the project -
state- Current status of the project, eitherActiveorClosed -
companyId- Id of the company associated with this project -
percentComplete- Percentage of the project which has been completed. This is calculated from the average percentage of each document which has been completed for all of the documents in the project -
createdDate- Date when the project was created. An empty value indicates that the project has not yet been started. -
documents[]- List of ids for documents in the project
-
-
- examples:
- List the projects for the current active user:
-
listTMDocuments
List all of the documents which have been indexed as translation memory in a particular translation memory vault
- parameters:
-
tmVaultId- Id of the vault from which to get the list of documents which have been indexed as translation memory
-
- response:
-
results- Result of operation, eithersuccessorfail -
tmDocuments[]- List of documents which have been indexed as translation memory in the vault-
tmVaultId- Id of translation memory vault which contains the translation memory document -
tmDocumentId- Id of the translation memory document -
name- Name of the translation memory document -
description- Description of the translation memory document -
state- Status of the translation memory document. A value ofMovingindicates that the document is being moved to a different vault. A value ofDeletingindicates that the document is being deleted from the vault. A value ofProcessingindicates that the document is being added to the vault. A value ofInvertingindicates that an inverted copy of the document, a copy where the source and target languages of the translation memories within the document are inverted, is being added to the vault. An empty value indicates that there is no current process associated with the translation memory document -
documentId- Id of the document associated with this translation memory document -
inverted-trueif an inverted copy of the document, a copy where the source and target languages of the translation memories within the document are inverted, has been created, otherwisefalse
-
-
- examples:
- List the translation memory documents in a translation memory vault:
-
listTMVaults
List all translation memory vaults that are owned or managed by the current active user
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail -
personalVaults[]- List of translation memoery vaults that are owned or managed by the current active user which are only available for search to those users who have been granted access-
id- Id of the translation memory vault -
name- Name of the translatio memory vault
-
-
publicVaults[]- List of translation memory vaults which are available for all users to search-
id- Id of the translation memory vault -
name- Name of the translation memory vault
-
-
- examples:
- List the translation memory vaults for the current active user:
-
listTranslationTargetSegments
List the translated sentences for a specific translation target within a document
- parameters:
-
translationTargetId- Id of the translation target to display segment information for
-
- response:
-
results- Result of operation, eithersuccessorfail -
segments[]- List of translated sentences for the translation target-
segId- Id for the segment -
paragraphId- Id for the paragraph of the segment -
sequence- Sequence index for the segment -
source- Text of source sentence -
target- Text of translated sentence
-
-
- examples:
- List the translated sentences for a translation target:
-
login
Login to the Lingotek system
A cookie is returned that will represent the session and must be sent back with all subsequent calls
- parameters:
-
userLogin- Login id -
password- Login password -
version- API version This parameter specifies the version of the API that your code is written for. -
returnXML(optional) - Return results as XML flag Setting this flag totruewill return results from API calls as XML. Setting this flag tofalsewill return results as JSON strings. -
community(optional) - Specifies the community to login to The community parameter is optional, with the default value of "Lingotek".
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Login to the system as the user
testuserwith the passwordfoo, using version 2.0 of the API.: - Login to the system as the user
testuserwith the passwordfoo, under the MyCommunity community using version 1.2 of the API, and return response as JSON strings.:
-
logout
Logout from the Lingotek system
- parameters:
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Log the current active user out of the system.:
-
pollDocumentAnalysis
Poll for the progress of an analysis process for a document
- parameters:
-
documentId- Id of the document to check the progress of analysis for
-
- response:
-
results- Result of operation, eithersuccessorfail -
translations[]- List of the translation targets for the document-
id- int Id of the translation target -
statsProgress- Percentage of the process of an analysis operation which has completed. If this value is0, there is no analysis process currently running.
-
-
- examples:
- Show the progress of an analysis process on a document:
-
pollProjectAnalysis
Poll for the progress of an analysis process for a project
- parameters:
-
projectId- Id of the project to check the progress of analysis for
-
- response:
-
results- Result of operation, eithersuccessorfail -
documents[]- List of the documents within this project-
id- int Id of the document -
translations[]- List of the translation targets for the document-
id- int Id of the translation target -
statsProgress- Percentage of the process of an analysis operation which has completed. If this value is0, there is no analysis process currently running.
-
-
-
- examples:
- Show the progress of an analysis process on a project:
-
regardSegment
Approve a segment to be included in the translated text
- parameters:
-
segmentId- Id of the segment to regard -
documentId- Id of the document to which the segment belongs
-
- response:
-
results- Result of operation, eithersuccessorfail -
id- Id of the segment which has been approved
-
- examples:
- Include the segment with the id
61226404-8dbd-49d8-98bf-600d907b85d1into a document.:
-
removeCompany
Remove a company from the system
- parameters:
-
companyId- Id of the company to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a company:
-
removeContact
Remove a contact from the contact list of the current active user
- parameters:
-
contactId- Id of the user corresponding to the contact to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a contact from the contact list:
-
removeDictionary
Remove a dictionary from the system
- parameters:
-
dictionaryId- Id of the dictionary to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a dictionary:
-
removeDocument
Remove a document from a project
- parameters:
-
documentId- Id of the document to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a document:
-
removePhase
Remove a phase within a translation target of a document
- parameters:
-
phaseId- Id of the phase to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a phase:
-
removePhaseFromTemplate
Remove a set of parameters for creating a phase from a phase template
A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied
The id of the parameter set for each phase in the phase template can be obtained from a call to getPhaseTemplate, or when adding a phase to the template with addPhaseToTemplate
- parameters:
-
phaseTemplateId- Id of the phase set template -
phaseParameterSetId- Id of the phase parameter set to remove
-
- response:
-
results- Result of operation, eithersuccessorfailo *
-
- examples:
- Remove a set of parameters for creating a phase from a phase template:
-
removePhaseTemplate
Remove a phase template for the current active user from the system
A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied
- parameters:
-
phaseTemplateId- Id of the phase template to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a phase template:
-
removeProject
Remove a project from the system
- parameters:
-
projectId- Id of the project to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a project:
-
removeSegmentLabelFromTemplate
Remove one or more segment labels from a segment label template
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
segmentLabelTemplateName- Name of the segment label template from which the segment label will be removed -
segmentLabels- The segment labels to remove from the segment label template ThesegmentLabelsparameter is a multi-parameter. More than one value can be assigned for the parameter name in order to denote multiple segment labels.
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a segment label for
h2 tag contents from the segment label template MyTemplate: - Remove the segment label for
h2 and <code>h1tag contents from the segment label template MyTemplate: </code>
-
removeSegmentLabelTemplate
Remove a segment label template for the current active user from the system
A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which when applied to a document will mark segments matching these tags or attributes as non-translatable text.
For example, the content of a header tag or alternative text for an image tag may in some cases be considered as non-translatable text.
- parameters:
-
segmentLabelTemplateName- Name of the segment label template to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a segment label template that has the name MyTemplate:
-
removeTMVault
Remove a translation memory vault from the system
- parameters:
-
tmVaultId- Id of the translation memory vault to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a translation memory vault:
-
removeTranslationTarget
Remove a translation target from a document
- parameters:
-
translationTargetId- Id of the translation target to remove
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Remove a translation target:
-
updateDocument
Update an existing document with a new version, keeping translations and formatting that were applied to any unchanged segments between the two versions
- parameters:
-
documentId- Id of the original document which will be updated -
file- Multi-part file parameter for uploaded file
-
- response:
-
results- Result of operation, eithersuccessorfail
-
- examples:
- Update to a newer version of a document. Note that the
fileparameter is not including in these example, as the thin web client should have utility methods for handling multi-part parameters for file uploads, and the example url would exceed the maximum url width otherwise.:
-
