lingotek-client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +0 -0
- data/README.md +0 -0
- data/VERSION +1 -0
- data/lib/VERSION +1 -0
- data/lib/lingotek-client/api.rb +58 -0
- data/lib/lingotek-client/api_schema.rb +178 -0
- data/lib/lingotek-client/schema.rb +37 -0
- data/lib/lingotek-client/version.rb +3 -0
- data/lib/lingotek-client.rb +5 -0
- data/update_schema/table.html +1481 -0
- data/update_schema/test +357 -0
- data/update_schema/update_schema +52 -0
- metadata +109 -0
|
@@ -0,0 +1,1481 @@
|
|
|
1
|
+
<table border="1">
|
|
2
|
+
<tbody>
|
|
3
|
+
<tr>
|
|
4
|
+
<td>
|
|
5
|
+
<a href="#acceptExternalInvite">acceptExternalInvite</a><br>
|
|
6
|
+
Accept an external invitation</td>
|
|
7
|
+
<td>
|
|
8
|
+
<code>invite_id</code></td>
|
|
9
|
+
</tr>
|
|
10
|
+
<tr>
|
|
11
|
+
<td>
|
|
12
|
+
<a href="#addCommunityDictionaryEntry">addCommunityDictionaryEntry</a><br>
|
|
13
|
+
Adds an entry of the specified type to the community dictionary. See <a href="#community_dictionary">Community Dictionary</a> for a list of types.</td>
|
|
14
|
+
<td>
|
|
15
|
+
<code>type</code><br>
|
|
16
|
+
<code>entry</code></td>
|
|
17
|
+
</tr>
|
|
18
|
+
<tr>
|
|
19
|
+
<td>
|
|
20
|
+
<a href="#addCompany">addCompany</a><br>
|
|
21
|
+
Add a client to the current user. Each project is assigned to a client/company, and the client must be created before the project can be created.</td>
|
|
22
|
+
<td>
|
|
23
|
+
<code>companyName</code></td>
|
|
24
|
+
</tr>
|
|
25
|
+
<tr>
|
|
26
|
+
<td>
|
|
27
|
+
<a href="#addContact">addContact</a><br>
|
|
28
|
+
Add a contact to the contact list of the current user. In order to be assigned as a translator or project manager on one of your projects, a user must be in your contact list.</td>
|
|
29
|
+
<td>
|
|
30
|
+
<code>userEmail</code><br>
|
|
31
|
+
<i><code>comment*</code></i></td>
|
|
32
|
+
</tr>
|
|
33
|
+
<tr>
|
|
34
|
+
<td>
|
|
35
|
+
<a href="#addContentDocument">addContentDocument</a><br>
|
|
36
|
+
Add a plaintext document to a project</td>
|
|
37
|
+
<td>
|
|
38
|
+
<code>projectId</code><br>
|
|
39
|
+
<code>content</code><br>
|
|
40
|
+
<code>documentName</code><br>
|
|
41
|
+
<i><code>documentDesc*</code></i><br>
|
|
42
|
+
<code>sourceLanguage</code><br>
|
|
43
|
+
<code>tmVaultId</code><br>
|
|
44
|
+
<code>format</code><br>
|
|
45
|
+
<i><code>note*</code></i><br>
|
|
46
|
+
<i><code>srxFileContents*</code></i><br>
|
|
47
|
+
<i><code>itsFileContents*</code></i><br>
|
|
48
|
+
<i><code>fprmFileContents*</code></i><br>
|
|
49
|
+
<i><code>secondaryFilter*</code></i><br>
|
|
50
|
+
<i><code>secondaryFprmFileContents*</code></i><br>
|
|
51
|
+
<i><code>placeholderMode*</code></i><br>
|
|
52
|
+
<i><code>priority*</code></i></td>
|
|
53
|
+
</tr>
|
|
54
|
+
<tr>
|
|
55
|
+
<td>
|
|
56
|
+
<a href="#addDocument">addDocument</a><br>
|
|
57
|
+
Add a document to a project</td>
|
|
58
|
+
<td>
|
|
59
|
+
<code>projectId</code><br>
|
|
60
|
+
<code>file</code><br>
|
|
61
|
+
<code>documentName</code><br>
|
|
62
|
+
<code>format</code><br>
|
|
63
|
+
<code>encoding</code><br>
|
|
64
|
+
<code>sourceLanguage</code><br>
|
|
65
|
+
<code>tmVaultId</code><br>
|
|
66
|
+
<i><code>tmTarget*</code></i><br>
|
|
67
|
+
<i><code>zipFile*</code></i><br>
|
|
68
|
+
<i><code>note*</code></i><br>
|
|
69
|
+
<i><code>srxFile*</code></i><br>
|
|
70
|
+
<i><code>itsFile*</code></i><br>
|
|
71
|
+
<i><code>fprmFile*</code></i><br>
|
|
72
|
+
<i><code>secondaryFilter*</code></i><br>
|
|
73
|
+
<i><code>secondaryFprmFile*</code></i><br>
|
|
74
|
+
<i><code>placeholderMode*</code></i><br>
|
|
75
|
+
<i><code>priority*</code></i></td>
|
|
76
|
+
</tr>
|
|
77
|
+
<tr>
|
|
78
|
+
<td>
|
|
79
|
+
<a href="#addDocumentURL">addDocumentURL</a><br>
|
|
80
|
+
Add a document to a project by URL</td>
|
|
81
|
+
<td>
|
|
82
|
+
<code>projectId</code><br>
|
|
83
|
+
<code>url</code><br>
|
|
84
|
+
<i><code>format*</code></i><br>
|
|
85
|
+
<code>sourceLanguage</code><br>
|
|
86
|
+
<code>tmVaultId</code><br>
|
|
87
|
+
<i><code>target*</code></i><br>
|
|
88
|
+
<i><code>tmTarget*</code></i><br>
|
|
89
|
+
<i><code>template*</code></i><br>
|
|
90
|
+
<i><code>depth*</code></i><br>
|
|
91
|
+
<i><code>srxFile*</code></i><br>
|
|
92
|
+
<i><code>itsFile*</code></i><br>
|
|
93
|
+
<i><code>fprmFile*</code></i><br>
|
|
94
|
+
<i><code>secondaryFilter*</code></i><br>
|
|
95
|
+
<i><code>secondaryFprmFile*</code></i><br>
|
|
96
|
+
<i><code>placeholderMode*</code></i><br>
|
|
97
|
+
<i><code>priority*</code></i></td>
|
|
98
|
+
</tr>
|
|
99
|
+
<tr>
|
|
100
|
+
<td>
|
|
101
|
+
<a href="#addDocumentWithTargets">addDocumentWithTargets</a><br>
|
|
102
|
+
Add a document to a project with a specified phase template applied.</td>
|
|
103
|
+
<td>
|
|
104
|
+
<code>projectId</code><br>
|
|
105
|
+
<code>file</code><br>
|
|
106
|
+
<code>applyWorkflow</code><br>
|
|
107
|
+
<code>documentName</code><br>
|
|
108
|
+
<code>format</code><br>
|
|
109
|
+
<code>encoding</code><br>
|
|
110
|
+
<code>phaseTemplateId</code><br>
|
|
111
|
+
<code>sourceLanguage</code><br>
|
|
112
|
+
<i><code>targetLanguage*</code></i><br>
|
|
113
|
+
<i><code>targetAsJSON*</code></i><br>
|
|
114
|
+
<code>tmVaultId</code><br>
|
|
115
|
+
<i><code>tmTarget*</code></i><br>
|
|
116
|
+
<i><code>zipFile*</code></i></td>
|
|
117
|
+
</tr>
|
|
118
|
+
<tr>
|
|
119
|
+
<td>
|
|
120
|
+
<a href="#addGlossary">addGlossary</a><br>
|
|
121
|
+
Create a glossary on the system, attached to the current user.</td>
|
|
122
|
+
<td>
|
|
123
|
+
<code>glossaryName</code><br>
|
|
124
|
+
<code>asTerminology</code></td>
|
|
125
|
+
</tr>
|
|
126
|
+
<tr>
|
|
127
|
+
<td>
|
|
128
|
+
<a href="#addLabel">addLabel</a><br>
|
|
129
|
+
Create a new label</td>
|
|
130
|
+
<td>
|
|
131
|
+
<code>name</code><br>
|
|
132
|
+
<i><code>status*</code></i></td>
|
|
133
|
+
</tr>
|
|
134
|
+
<tr>
|
|
135
|
+
<td>
|
|
136
|
+
<a href="#addPhase">addPhase</a><br>
|
|
137
|
+
Add a phase to a translation target within a document</td>
|
|
138
|
+
<td>
|
|
139
|
+
<code>translationTargetId</code><br>
|
|
140
|
+
<code>phaseName</code><br>
|
|
141
|
+
<i><code>phaseDescription*</code></i><br>
|
|
142
|
+
<i><code>isCommunityAccess*</code></i><br>
|
|
143
|
+
<i><code>isSelfAssigned*</code></i></td>
|
|
144
|
+
</tr>
|
|
145
|
+
<tr>
|
|
146
|
+
<td>
|
|
147
|
+
<a href="#addPhaseTemplate (deprecated)">addPhaseTemplate (deprecated)</a><br>
|
|
148
|
+
Create a phase template for the current user
|
|
149
|
+
<p>A phase template represents a group of phases which can be added to a translation target.</p>
|
|
150
|
+
</td>
|
|
151
|
+
<td>
|
|
152
|
+
<code>phaseTemplateName</code></td>
|
|
153
|
+
</tr>
|
|
154
|
+
<tr>
|
|
155
|
+
<td>
|
|
156
|
+
<a href="#addPhaseToTemplate (deprecated)">addPhaseToTemplate (deprecated)</a><br>
|
|
157
|
+
Add the parameters for adding a phase to an existing phase template
|
|
158
|
+
<p>A phase template represents the parameters for a group of phases, which will be added to the translation target when the template is applied</p>
|
|
159
|
+
</td>
|
|
160
|
+
<td>
|
|
161
|
+
<code>phaseTemplateId</code><br>
|
|
162
|
+
<code>phaseName</code><br>
|
|
163
|
+
<i><code>phaseDescription*</code></i><br>
|
|
164
|
+
<i><code>isCommunityAccess*</code></i><br>
|
|
165
|
+
<i><code>isSelfAssigned*</code></i></td>
|
|
166
|
+
</tr>
|
|
167
|
+
<tr>
|
|
168
|
+
<td>
|
|
169
|
+
<a href="#addPreference">addPreference</a><br>
|
|
170
|
+
Create a new client preference. If the preference already exists, it will edit an existing preference if a value is sent.</td>
|
|
171
|
+
<td>
|
|
172
|
+
<code>key</code><br>
|
|
173
|
+
<i><code>value*</code></i></td>
|
|
174
|
+
</tr>
|
|
175
|
+
<tr>
|
|
176
|
+
<td>
|
|
177
|
+
<a href="#addProject">addProject</a><br>
|
|
178
|
+
Create a project on the system, attached to the current user</td>
|
|
179
|
+
<td>
|
|
180
|
+
<code>projectName</code><br>
|
|
181
|
+
<i><code>projectDueDate*</code></i><br>
|
|
182
|
+
<i><code>companyId*</code></i><br>
|
|
183
|
+
<i><code>workflowId*</code></i><br>
|
|
184
|
+
<i><code>searchPublic*</code></i></td>
|
|
185
|
+
</tr>
|
|
186
|
+
<tr>
|
|
187
|
+
<td>
|
|
188
|
+
<a href="#addProjectDictionary">addProjectDictionary</a><br>
|
|
189
|
+
Add a given dictionary to a given project</td>
|
|
190
|
+
<td>
|
|
191
|
+
<code>project_id</code><br>
|
|
192
|
+
<code>dictionary_id</code></td>
|
|
193
|
+
</tr>
|
|
194
|
+
<tr>
|
|
195
|
+
<td>
|
|
196
|
+
<a href="#addProjectMT">addProjectMT</a><br>
|
|
197
|
+
Add a give translation memory vault to a given project</td>
|
|
198
|
+
<td>
|
|
199
|
+
<code>project_id</code><br>
|
|
200
|
+
<code>mt_engine_name</code></td>
|
|
201
|
+
</tr>
|
|
202
|
+
<tr>
|
|
203
|
+
<td>
|
|
204
|
+
<a href="#addProjectTMVault">addProjectTMVault</a><br>
|
|
205
|
+
Add a give translation memory vault to a given project</td>
|
|
206
|
+
<td>
|
|
207
|
+
<code>tmVaultName</code><br>
|
|
208
|
+
<i><code>isPublic*</code></i><br>
|
|
209
|
+
<code>project_id</code><br>
|
|
210
|
+
<code>index_id</code></td>
|
|
211
|
+
</tr>
|
|
212
|
+
<tr>
|
|
213
|
+
<td>
|
|
214
|
+
<a href="#addSegmentLabelTemplate">addSegmentLabelTemplate</a><br>
|
|
215
|
+
Creates a segment label template for the current user
|
|
216
|
+
<p>A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags. When a template is applied to a document segments matching these tags or attributes will be marked as non-translatable text.</p>
|
|
217
|
+
<p>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.</p>
|
|
218
|
+
</td>
|
|
219
|
+
<td>
|
|
220
|
+
<code>segmentLabelTemplateName</code><br>
|
|
221
|
+
<i><code>segmentLabels*</code></i></td>
|
|
222
|
+
</tr>
|
|
223
|
+
<tr>
|
|
224
|
+
<td>
|
|
225
|
+
<a href="#addSegmentLabelToTemplate">addSegmentLabelToTemplate</a><br>
|
|
226
|
+
Add a segment label to a segment label template
|
|
227
|
+
<p>A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags When a template is applied to a document segments matching these tags or attributes will be marked as non-translatable text.</p>
|
|
228
|
+
<p>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.</p>
|
|
229
|
+
</td>
|
|
230
|
+
<td>
|
|
231
|
+
<code>segmentLabelTemplateName</code><br>
|
|
232
|
+
<code>segmentLabels</code></td>
|
|
233
|
+
</tr>
|
|
234
|
+
<tr>
|
|
235
|
+
<td>
|
|
236
|
+
<a href="#addTeam">addTeam</a><br>
|
|
237
|
+
Add a team with the current user as the owner.</td>
|
|
238
|
+
<td>
|
|
239
|
+
<code>name</code><br>
|
|
240
|
+
<i><code>description*</code></i><br>
|
|
241
|
+
<i><code>image*</code></i></td>
|
|
242
|
+
</tr>
|
|
243
|
+
<tr>
|
|
244
|
+
<td>
|
|
245
|
+
<a href="#addTeamLead">addTeamLead</a><br>
|
|
246
|
+
Sets a user as a team lead</td>
|
|
247
|
+
<td>
|
|
248
|
+
<code>teamId</code><br>
|
|
249
|
+
<code>clientId</code></td>
|
|
250
|
+
</tr>
|
|
251
|
+
<tr>
|
|
252
|
+
<td>
|
|
253
|
+
<a href="#addTeamMember">addTeamMember</a><br>
|
|
254
|
+
Add a member to a team.</td>
|
|
255
|
+
<td>
|
|
256
|
+
<code>teamId</code><br>
|
|
257
|
+
<code>clientId</code></td>
|
|
258
|
+
</tr>
|
|
259
|
+
<tr>
|
|
260
|
+
<td>
|
|
261
|
+
<a href="#addTMVault">addTMVault</a><br>
|
|
262
|
+
Add a new translation memory vault to the system</td>
|
|
263
|
+
<td>
|
|
264
|
+
<code>tmVaultName</code><br>
|
|
265
|
+
<i><code>isPublic*</code></i></td>
|
|
266
|
+
</tr>
|
|
267
|
+
<tr>
|
|
268
|
+
<td>
|
|
269
|
+
<a href="#addTranslationTarget">addTranslationTarget</a><br>
|
|
270
|
+
Add a new translation target language to a document</td>
|
|
271
|
+
<td>
|
|
272
|
+
<code>documentId</code><br>
|
|
273
|
+
<code>applyWorkflow</code><br>
|
|
274
|
+
<code>targetLanguage</code></td>
|
|
275
|
+
</tr>
|
|
276
|
+
<tr>
|
|
277
|
+
<td>
|
|
278
|
+
<a href="#analyzeDocument">analyzeDocument</a><br>
|
|
279
|
+
Begin an analysis of a document
|
|
280
|
+
<p>Exact matches will be automatically inserted into the target.</p>
|
|
281
|
+
<p>Progress can be obtained from a call to <code>pollDocumentAnalysis</code></p>
|
|
282
|
+
</td>
|
|
283
|
+
<td>
|
|
284
|
+
<code>documentId</code></td>
|
|
285
|
+
</tr>
|
|
286
|
+
<tr>
|
|
287
|
+
<td>
|
|
288
|
+
<a href="#analyzeProject">analyzeProject</a><br>
|
|
289
|
+
Begin an analysis of all of the documents in a project
|
|
290
|
+
<p>Exact matches are automatically inserted into the target.</p>
|
|
291
|
+
<p>Progress can be obtained from a call to <code>pollProjectAnalysis</code></p>
|
|
292
|
+
</td>
|
|
293
|
+
<td>
|
|
294
|
+
<code>projectId</code><br>
|
|
295
|
+
<code>documentId</code></td>
|
|
296
|
+
</tr>
|
|
297
|
+
<tr>
|
|
298
|
+
<td>
|
|
299
|
+
<a href="#applyPhaseTemplate (deprecated)">applyPhaseTemplate (deprecated)</a><br>
|
|
300
|
+
Apply a phase template to a translation target</td>
|
|
301
|
+
<td>
|
|
302
|
+
<code>translationTargetId</code><br>
|
|
303
|
+
<code>phaseTemplateId</code></td>
|
|
304
|
+
</tr>
|
|
305
|
+
<tr>
|
|
306
|
+
<td>
|
|
307
|
+
<a href="#applySegmentLabelTemplate">applySegmentLabelTemplate</a><br>
|
|
308
|
+
Apply a segment label template to a document and recalculate that document's statistics
|
|
309
|
+
<p>A segment label template represents a group of tags or attributes on segments, generally for document formats with markup tags, which will mark segments matching these tags or attributes as non-translatable text.</p>
|
|
310
|
+
<p>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.</p>
|
|
311
|
+
</td>
|
|
312
|
+
<td>
|
|
313
|
+
<code>documentId</code><br>
|
|
314
|
+
<code>segmentLabelTemplateName</code></td>
|
|
315
|
+
</tr>
|
|
316
|
+
<tr>
|
|
317
|
+
<td>
|
|
318
|
+
<a href="#assignPhaseTranslator">assignPhaseTranslator</a><br>
|
|
319
|
+
Assign a translator to a phase</td>
|
|
320
|
+
<td>
|
|
321
|
+
<code>phaseId</code><br>
|
|
322
|
+
<code>translatorUserId</code></td>
|
|
323
|
+
</tr>
|
|
324
|
+
<tr>
|
|
325
|
+
<td>
|
|
326
|
+
<a href="#assignProjectManager">assignProjectManager</a><br>
|
|
327
|
+
Assign a manager to a project</td>
|
|
328
|
+
<td>
|
|
329
|
+
<code>projectId</code><br>
|
|
330
|
+
<i><code>managerLoginName*</code></i><br>
|
|
331
|
+
<i><code>managerUserId*</code></i></td>
|
|
332
|
+
</tr>
|
|
333
|
+
<tr>
|
|
334
|
+
<td>
|
|
335
|
+
<a href="#assignSelf">assignSelf</a><br>
|
|
336
|
+
Assign a translator to a phase</td>
|
|
337
|
+
<td>
|
|
338
|
+
<code>phaseId</code></td>
|
|
339
|
+
</tr>
|
|
340
|
+
<tr>
|
|
341
|
+
<td>
|
|
342
|
+
<a href="#backgroundJobProgress (deprecated)">backgroundJobProgress (deprecated)</a><br>
|
|
343
|
+
List the details about the source and target languages of a document, as well as all of the source sentences of the document</td>
|
|
344
|
+
<td>
|
|
345
|
+
<code>queueId</code></td>
|
|
346
|
+
</tr>
|
|
347
|
+
<tr>
|
|
348
|
+
<td>
|
|
349
|
+
<a href="#declineExternalInvite">declineExternalInvite</a><br>
|
|
350
|
+
Decline an external invitation</td>
|
|
351
|
+
<td>
|
|
352
|
+
<code>invite_id</code><br>
|
|
353
|
+
<code>phase</code></td>
|
|
354
|
+
</tr>
|
|
355
|
+
<tr>
|
|
356
|
+
<td>
|
|
357
|
+
<a href="#dismissPhaseTranslator">dismissPhaseTranslator</a><br>
|
|
358
|
+
Remove a translator from a phase</td>
|
|
359
|
+
<td>
|
|
360
|
+
<code>phaseId</code><br>
|
|
361
|
+
<code>translatorUserId</code></td>
|
|
362
|
+
</tr>
|
|
363
|
+
<tr>
|
|
364
|
+
<td>
|
|
365
|
+
<a href="#dismissProjectManager">dismissProjectManager</a><br>
|
|
366
|
+
Remove a manager from a project</td>
|
|
367
|
+
<td>
|
|
368
|
+
<code>projectId</code><br>
|
|
369
|
+
<code>managerUserId</code></td>
|
|
370
|
+
</tr>
|
|
371
|
+
<tr>
|
|
372
|
+
<td>
|
|
373
|
+
<a href="#documentSegments">documentSegments</a><br>
|
|
374
|
+
List the description of a document and the source and target languages of that document, as well as all of the source sentences of the document</td>
|
|
375
|
+
<td>
|
|
376
|
+
<code>documentId</code></td>
|
|
377
|
+
</tr>
|
|
378
|
+
<tr>
|
|
379
|
+
<td>
|
|
380
|
+
<a href="#downloadDocument">downloadDocument</a><br>
|
|
381
|
+
Download the original format of a translated document in a specific target language
|
|
382
|
+
<p>This call is generally only applicable after the translation is complete.</p>
|
|
383
|
+
</td>
|
|
384
|
+
<td>
|
|
385
|
+
<code>documentId</code><br>
|
|
386
|
+
<code>targetLanguage</code><br>
|
|
387
|
+
<i><code>useSource*</code></i><br>
|
|
388
|
+
<i><code>useAttributions*</code></i></td>
|
|
389
|
+
</tr>
|
|
390
|
+
<tr>
|
|
391
|
+
<td>
|
|
392
|
+
<a href="#downloadDocumentAsCSV">downloadDocumentAsCSV</a><br>
|
|
393
|
+
Download the translation memory associated with a specific target language of a document in CSV format
|
|
394
|
+
<p>This call is generally only applicable after the translation is complete.</p>
|
|
395
|
+
</td>
|
|
396
|
+
<td>
|
|
397
|
+
<code>documentId</code><br>
|
|
398
|
+
<code>targetLanguage</code></td>
|
|
399
|
+
</tr>
|
|
400
|
+
<tr>
|
|
401
|
+
<td>
|
|
402
|
+
<a href="#downloadDocumentAsSkeleton">downloadDocumentAsSkeleton</a><br>
|
|
403
|
+
Download the skeleton file of a document
|
|
404
|
+
<p>The skeleton file is an internal version of the document which contains markers for text segments which have been imported into the system</p>
|
|
405
|
+
</td>
|
|
406
|
+
<td>
|
|
407
|
+
<code>documentId</code></td>
|
|
408
|
+
</tr>
|
|
409
|
+
<tr>
|
|
410
|
+
<td>
|
|
411
|
+
<a href="#downloadDocumentAsTMX">downloadDocumentAsTMX</a><br>
|
|
412
|
+
Download the translation memory associated with a specific target language of a document in TMX format
|
|
413
|
+
<p>This call is generally only applicable after the translation is complete.</p>
|
|
414
|
+
</td>
|
|
415
|
+
<td>
|
|
416
|
+
<code>documentId</code><br>
|
|
417
|
+
<i><code>targetLanguage*</code></i></td>
|
|
418
|
+
</tr>
|
|
419
|
+
<tr>
|
|
420
|
+
<td>
|
|
421
|
+
<a href="#downloadDocumentAsXliff">downloadDocumentAsXliff</a><br>
|
|
422
|
+
Download the translation memory associated with a specific target language of a document in XLIFF format
|
|
423
|
+
<p>This call is generally only applicable after the translation is complete.</p>
|
|
424
|
+
</td>
|
|
425
|
+
<td>
|
|
426
|
+
<code>documentId</code><br>
|
|
427
|
+
<i><code>targetLanguage*</code></i></td>
|
|
428
|
+
</tr>
|
|
429
|
+
<tr>
|
|
430
|
+
<td>
|
|
431
|
+
<a href="#downloadDocumentContent">downloadDocumentContent</a><br>
|
|
432
|
+
Download the plaintext of a translated document in a specific target language
|
|
433
|
+
<p>This call is generally only applicable after the translation is complete.</p>
|
|
434
|
+
</td>
|
|
435
|
+
<td>
|
|
436
|
+
<code>documentId</code><br>
|
|
437
|
+
<code>targetLanguage</code></td>
|
|
438
|
+
</tr>
|
|
439
|
+
<tr>
|
|
440
|
+
<td>
|
|
441
|
+
<a href="#downloadExport">downloadExport</a><br>
|
|
442
|
+
Download exported glossary (or vault) that was created with exportResource..</td>
|
|
443
|
+
<td>
|
|
444
|
+
<code>resourceType</code><br>
|
|
445
|
+
<code>exportId</code></td>
|
|
446
|
+
</tr>
|
|
447
|
+
<tr>
|
|
448
|
+
<td>
|
|
449
|
+
<a href="#downloadGlossaryAsCSV (deprecated)">downloadGlossaryAsCSV (deprecated)</a><br>
|
|
450
|
+
Download the portion of a glossary associated with a specific source and target language in CSV.</td>
|
|
451
|
+
<td>
|
|
452
|
+
<code>glossaryId</code><br>
|
|
453
|
+
<code>sourceLanguage</code><br>
|
|
454
|
+
<i><code>targetLanguage*</code></i></td>
|
|
455
|
+
</tr>
|
|
456
|
+
<tr>
|
|
457
|
+
<td>
|
|
458
|
+
<a href="#downloadGlossaryAsTBX (deprecated)">downloadGlossaryAsTBX (deprecated)</a><br>
|
|
459
|
+
Download the portion of a glossary associated with a specific source and target language in TBX-Basic format.</td>
|
|
460
|
+
<td>
|
|
461
|
+
<code>glossaryId</code><br>
|
|
462
|
+
<code>sourceLanguage</code><br>
|
|
463
|
+
<i><code>targetLanguage*</code></i></td>
|
|
464
|
+
</tr>
|
|
465
|
+
<tr>
|
|
466
|
+
<td>
|
|
467
|
+
<a href="#downloadTMVaultAsTMX (deprecated)">downloadTMVaultAsTMX (deprecated)</a><br>
|
|
468
|
+
Download a translation memory vault as a TMX file</td>
|
|
469
|
+
<td>
|
|
470
|
+
<code>tmVaultId</code><br>
|
|
471
|
+
<code>sourceLanguage</code><br>
|
|
472
|
+
<i><code>targetLanguage*</code></i></td>
|
|
473
|
+
</tr>
|
|
474
|
+
<tr>
|
|
475
|
+
<td>
|
|
476
|
+
<a href="#downloadTMVaultAsXliff (deprecated)">downloadTMVaultAsXliff (deprecated)</a><br>
|
|
477
|
+
Download a translation memory vault as a XLIFF file</td>
|
|
478
|
+
<td>
|
|
479
|
+
<code>tmVaultId</code><br>
|
|
480
|
+
<code>sourceLanguage</code><br>
|
|
481
|
+
<i><code>targetLanguage*</code></i></td>
|
|
482
|
+
</tr>
|
|
483
|
+
<tr>
|
|
484
|
+
<td>
|
|
485
|
+
<a href="#editClientCommunityPreference">editClientCommunityPreference</a><br>
|
|
486
|
+
Edit a client preference specific to a community. Refer to the <a href="#client_community_preferences">Appendix</a> for the preferences.</td>
|
|
487
|
+
<td>
|
|
488
|
+
<code>key</code><br>
|
|
489
|
+
<code>value</code></td>
|
|
490
|
+
</tr>
|
|
491
|
+
<tr>
|
|
492
|
+
<td>
|
|
493
|
+
<a href="#editCompany">editCompany</a><br>
|
|
494
|
+
Edit the name of a company/client</td>
|
|
495
|
+
<td>
|
|
496
|
+
<code>companyId</code><br>
|
|
497
|
+
<i><code>companyName*</code></i></td>
|
|
498
|
+
</tr>
|
|
499
|
+
<tr>
|
|
500
|
+
<td>
|
|
501
|
+
<a href="#editContact">editContact</a><br>
|
|
502
|
+
Edit the details for a contact in the contact list of the current active user</td>
|
|
503
|
+
<td>
|
|
504
|
+
<code>contactId</code><br>
|
|
505
|
+
<i><code>comment*</code></i></td>
|
|
506
|
+
</tr>
|
|
507
|
+
<tr>
|
|
508
|
+
<td>
|
|
509
|
+
<a href="#editDocument">editDocument</a><br>
|
|
510
|
+
Edit the details for a document within a project</td>
|
|
511
|
+
<td>
|
|
512
|
+
<code>documentId</code><br>
|
|
513
|
+
<i><code>documentName*</code></i><br>
|
|
514
|
+
<i><code>tmVaultId*</code></i></td>
|
|
515
|
+
</tr>
|
|
516
|
+
<tr>
|
|
517
|
+
<td>
|
|
518
|
+
<a href="#editDocumentSetting">editDocumentSetting</a><br>
|
|
519
|
+
Edit one of the settings for a document. See <a href="#document_settings">Document Settings</a> for a list of types, keys, and values accepted by this call.</td>
|
|
520
|
+
<td>
|
|
521
|
+
<code>documentId</code><br>
|
|
522
|
+
<code>type</code><br>
|
|
523
|
+
<code>key</code><br>
|
|
524
|
+
<code>value</code></td>
|
|
525
|
+
</tr>
|
|
526
|
+
<tr>
|
|
527
|
+
<td>
|
|
528
|
+
<a href="#editGlossary">editGlossary</a><br>
|
|
529
|
+
Edit the name of a glossary within the system</td>
|
|
530
|
+
<td>
|
|
531
|
+
<code>glossaryId</code><br>
|
|
532
|
+
<i><code>glossaryName*</code></i></td>
|
|
533
|
+
</tr>
|
|
534
|
+
<tr>
|
|
535
|
+
<td>
|
|
536
|
+
<a href="#editLabel">editLabel</a><br>
|
|
537
|
+
Edit a label</td>
|
|
538
|
+
<td>
|
|
539
|
+
<code>id</code><br>
|
|
540
|
+
<i><code>name*</code></i><br>
|
|
541
|
+
<i><code>status*</code></i><br>
|
|
542
|
+
<i><code>order*</code></i><br>
|
|
543
|
+
<i><code>offset*</code></i><br>
|
|
544
|
+
<i><code>move_to_label*</code></i><br>
|
|
545
|
+
<i><code>show_percent_complete*</code></i></td>
|
|
546
|
+
</tr>
|
|
547
|
+
<tr>
|
|
548
|
+
<td>
|
|
549
|
+
<a href="#editPhase">editPhase</a><br>
|
|
550
|
+
Edit the details for a phase within a translation target of a document</td>
|
|
551
|
+
<td>
|
|
552
|
+
<code>phaseId</code><br>
|
|
553
|
+
<i><code>phaseName*</code></i><br>
|
|
554
|
+
<i><code>phaseDescription*</code></i><br>
|
|
555
|
+
<i><code>isCommunityAccess*</code></i><br>
|
|
556
|
+
<i><code>isSelfAssigned*</code></i></td>
|
|
557
|
+
</tr>
|
|
558
|
+
<tr>
|
|
559
|
+
<td>
|
|
560
|
+
<a href="#editPhaseTemplate (deprecated)">editPhaseTemplate (deprecated)</a><br>
|
|
561
|
+
Edit the name of a phase template for the current active user
|
|
562
|
+
<p>A phase template represents a group of phases, which will be added to the translation target when the template is applied</p>
|
|
563
|
+
</td>
|
|
564
|
+
<td>
|
|
565
|
+
<code>phaseTemplateId</code><br>
|
|
566
|
+
<i><code>phaseTemplateName*</code></i></td>
|
|
567
|
+
</tr>
|
|
568
|
+
<tr>
|
|
569
|
+
<td>
|
|
570
|
+
<a href="#editPreference">editPreference</a><br>
|
|
571
|
+
Edit a client preference</td>
|
|
572
|
+
<td>
|
|
573
|
+
<code>key</code><br>
|
|
574
|
+
<code>value</code></td>
|
|
575
|
+
</tr>
|
|
576
|
+
<tr>
|
|
577
|
+
<td>
|
|
578
|
+
<a href="#editProject">editProject</a><br>
|
|
579
|
+
Edit the details for a project from the system</td>
|
|
580
|
+
<td>
|
|
581
|
+
<code>projectId</code><br>
|
|
582
|
+
<i><code>projectName*</code></i><br>
|
|
583
|
+
<i><code>projectDueDate*</code></i><br>
|
|
584
|
+
<i><code>companyId*</code></i><br>
|
|
585
|
+
<i><code>searchPublic*</code></i></td>
|
|
586
|
+
</tr>
|
|
587
|
+
<tr>
|
|
588
|
+
<td>
|
|
589
|
+
<a href="#editProjectSetting">editProjectSetting</a><br>
|
|
590
|
+
Edit one of the settings for a project See <a href="#project_settings">Project Settings</a> for a list of types, keys, and values accepted by this call.</td>
|
|
591
|
+
<td>
|
|
592
|
+
<code>projectId</code><br>
|
|
593
|
+
<code>type</code><br>
|
|
594
|
+
<code>key</code><br>
|
|
595
|
+
<code>value</code></td>
|
|
596
|
+
</tr>
|
|
597
|
+
<tr>
|
|
598
|
+
<td>
|
|
599
|
+
<a href="#editSegmentLabelTemplate">editSegmentLabelTemplate</a><br>
|
|
600
|
+
Edit the details for a segment label template for the current active user from the system Currently, this call is a placeholder for future segment label template editing functions.</td>
|
|
601
|
+
<td>
|
|
602
|
+
<code>segmentLabelTemplateName</code></td>
|
|
603
|
+
</tr>
|
|
604
|
+
<tr>
|
|
605
|
+
<td>
|
|
606
|
+
<a href="#editTMVault">editTMVault</a><br>
|
|
607
|
+
Edit the details for a translation memory vault within the system</td>
|
|
608
|
+
<td>
|
|
609
|
+
<code>tmVaultId</code><br>
|
|
610
|
+
<i><code>tmVaultName*</code></i><br>
|
|
611
|
+
<i><code>isPublic*</code></i></td>
|
|
612
|
+
</tr>
|
|
613
|
+
<tr>
|
|
614
|
+
<td>
|
|
615
|
+
<a href="#editTranslationTarget">editTranslationTarget</a><br>
|
|
616
|
+
Edit the details for a translation target within a document This call is currently a placeholder for future functionality.</td>
|
|
617
|
+
<td>
|
|
618
|
+
<code>translationTargetId</code></td>
|
|
619
|
+
</tr>
|
|
620
|
+
<tr>
|
|
621
|
+
<td>
|
|
622
|
+
<a href="#exportResource">exportResource</a><br>
|
|
623
|
+
Start resource export (glossary or vault) - use downloadExport to download export.</td>
|
|
624
|
+
<td>
|
|
625
|
+
<code>resourceType</code><br>
|
|
626
|
+
<code>resourceId</code><br>
|
|
627
|
+
<code>format</code><br>
|
|
628
|
+
<code>targetLanguages</code><br>
|
|
629
|
+
<code>sourceLanguage</code></td>
|
|
630
|
+
</tr>
|
|
631
|
+
<tr>
|
|
632
|
+
<td>
|
|
633
|
+
<a href="#findLabel">findLabel</a><br>
|
|
634
|
+
Search labels by name.</td>
|
|
635
|
+
<td>
|
|
636
|
+
<code>name</code><br>
|
|
637
|
+
<code>limit</code></td>
|
|
638
|
+
</tr>
|
|
639
|
+
<tr>
|
|
640
|
+
<td>
|
|
641
|
+
<a href="#findTM">findTM</a><br>
|
|
642
|
+
Retrieves TM from the specified vaults for the given language pair. To get any results, either searchText or startDate and endDate must be defined. Valid date formats are 'yyyy/MM/dd', 'yyyy/MM/dd HH:mm:ss', and 'yyyy/MM/dd hh:mm:ss'. Refer to java.text.SimpleDateFormat JavaDocs for more information on date formatting.</td>
|
|
643
|
+
<td>
|
|
644
|
+
<code>tmVaultId</code><br>
|
|
645
|
+
<i><code>searchText*</code></i><br>
|
|
646
|
+
<code>sourceLang</code><br>
|
|
647
|
+
<code>targetLang</code><br>
|
|
648
|
+
<i><code>startDate*</code></i><br>
|
|
649
|
+
<i><code>endDate*</code></i></td>
|
|
650
|
+
</tr>
|
|
651
|
+
<tr>
|
|
652
|
+
<td>
|
|
653
|
+
<a href="#flushDocumentProgress">flushDocumentProgress</a><br>
|
|
654
|
+
Flushes progress on a document</td>
|
|
655
|
+
<td>
|
|
656
|
+
<code>documentId</code></td>
|
|
657
|
+
</tr>
|
|
658
|
+
<tr>
|
|
659
|
+
<td>
|
|
660
|
+
<a href="#getClientCommunityPreference">getClientCommunityPreference</a><br>
|
|
661
|
+
Get a client preference specific to a community, or if none exists, return the system-wide default. Refer to the <a href="#client_community_preferences">Appendix</a> for the preferences.</td>
|
|
662
|
+
<td>
|
|
663
|
+
<code>key</code></td>
|
|
664
|
+
</tr>
|
|
665
|
+
<tr>
|
|
666
|
+
<td>
|
|
667
|
+
<a href="#getCMSKey">getCMSKey</a><br>
|
|
668
|
+
Get the CMS key for the user's currently logged in community. You must be a community admin to get this key.</td>
|
|
669
|
+
<td>
|
|
670
|
+
</td>
|
|
671
|
+
</tr>
|
|
672
|
+
<tr>
|
|
673
|
+
<td>
|
|
674
|
+
<a href="#getCommunityDictionary">getCommunityDictionary</a><br>
|
|
675
|
+
Gets all dictionary entries for the community. See <a href="#community_dictionary">Community Dictionary</a> for a list of types.</td>
|
|
676
|
+
<td>
|
|
677
|
+
<code>type</code></td>
|
|
678
|
+
</tr>
|
|
679
|
+
<tr>
|
|
680
|
+
<td>
|
|
681
|
+
<a href="#getCommunityPreference">getCommunityPreference</a><br>
|
|
682
|
+
Get a community preference. See the <a href="#community_settings">appendix</a> for a list of types, keys, and potential values.</td>
|
|
683
|
+
<td>
|
|
684
|
+
<code>key</code><br>
|
|
685
|
+
<code>type</code></td>
|
|
686
|
+
</tr>
|
|
687
|
+
<tr>
|
|
688
|
+
<td>
|
|
689
|
+
<a href="#getCompany">getCompany</a><br>
|
|
690
|
+
Get the object representing a particular company/client</td>
|
|
691
|
+
<td>
|
|
692
|
+
<code>companyId</code></td>
|
|
693
|
+
</tr>
|
|
694
|
+
<tr>
|
|
695
|
+
<td>
|
|
696
|
+
<a href="#getContact">getContact</a><br>
|
|
697
|
+
Get the object representing a particular contact</td>
|
|
698
|
+
<td>
|
|
699
|
+
<code>contactId</code></td>
|
|
700
|
+
</tr>
|
|
701
|
+
<tr>
|
|
702
|
+
<td>
|
|
703
|
+
<a href="#getDashboardLink">getDashboardLink</a><br>
|
|
704
|
+
Add a document to a project by URL</td>
|
|
705
|
+
<td>
|
|
706
|
+
</td>
|
|
707
|
+
</tr>
|
|
708
|
+
<tr>
|
|
709
|
+
<td>
|
|
710
|
+
<a href="#getDocument">getDocument</a><br>
|
|
711
|
+
Get the object representing a particular document</td>
|
|
712
|
+
<td>
|
|
713
|
+
<code>documentId</code></td>
|
|
714
|
+
</tr>
|
|
715
|
+
<tr>
|
|
716
|
+
<td>
|
|
717
|
+
<a href="#getDocumentProgress">getDocumentProgress</a><br>
|
|
718
|
+
Retrieve document progress information</td>
|
|
719
|
+
<td>
|
|
720
|
+
<code>documentId</code></td>
|
|
721
|
+
</tr>
|
|
722
|
+
<tr>
|
|
723
|
+
<td>
|
|
724
|
+
<a href="#getDocumentSetting">getDocumentSetting</a><br>
|
|
725
|
+
Retrieve one of the settings for a document If the setting is not set for the document, the setting for the document's project will be used instead If the setting is not set for the document's project, the setting for the community of the document's project will be used instead See <a href="#document_settings">Document Settings</a> for a list of types and keys accepted by this call.</td>
|
|
726
|
+
<td>
|
|
727
|
+
<code>documentId</code><br>
|
|
728
|
+
<code>type</code><br>
|
|
729
|
+
<code>key</code></td>
|
|
730
|
+
</tr>
|
|
731
|
+
<tr>
|
|
732
|
+
<td>
|
|
733
|
+
<a href="#getExternalInvites">getExternalInvites</a><br>
|
|
734
|
+
Get External Invitations for an External User with optional invite ID to filter on.</td>
|
|
735
|
+
<td>
|
|
736
|
+
<code>invite_id</code></td>
|
|
737
|
+
</tr>
|
|
738
|
+
<tr>
|
|
739
|
+
<td>
|
|
740
|
+
<a href="#getGlossary">getGlossary</a><br>
|
|
741
|
+
Get the object representing a particular glossary</td>
|
|
742
|
+
<td>
|
|
743
|
+
<code>glossaryId</code></td>
|
|
744
|
+
</tr>
|
|
745
|
+
<tr>
|
|
746
|
+
<td>
|
|
747
|
+
<a href="#getLabel">getLabel</a><br>
|
|
748
|
+
Get a label, searching either by id or by name (both of which are unique for a community).</td>
|
|
749
|
+
<td>
|
|
750
|
+
<i><code>id*</code></i><br>
|
|
751
|
+
<i><code>name*</code></i></td>
|
|
752
|
+
</tr>
|
|
753
|
+
<tr>
|
|
754
|
+
<td>
|
|
755
|
+
<a href="#getPhase">getPhase</a><br>
|
|
756
|
+
Get the object representing a particular phase</td>
|
|
757
|
+
<td>
|
|
758
|
+
<code>phaseId</code></td>
|
|
759
|
+
</tr>
|
|
760
|
+
<tr>
|
|
761
|
+
<td>
|
|
762
|
+
<a href="#getPhaseTemplate (deprecated)">getPhaseTemplate (deprecated)</a><br>
|
|
763
|
+
Get the object representing a particular phase template
|
|
764
|
+
<p>A phase template represents a group of phases, which will be added to the translation target when the template is applied</p>
|
|
765
|
+
</td>
|
|
766
|
+
<td>
|
|
767
|
+
<code>phaseTemplateId</code></td>
|
|
768
|
+
</tr>
|
|
769
|
+
<tr>
|
|
770
|
+
<td>
|
|
771
|
+
<a href="#getPreference">getPreference</a><br>
|
|
772
|
+
Get a client preference</td>
|
|
773
|
+
<td>
|
|
774
|
+
<code>key</code></td>
|
|
775
|
+
</tr>
|
|
776
|
+
<tr>
|
|
777
|
+
<td>
|
|
778
|
+
<a href="#getPriorityJobWorkbenchLink">getPriorityJobWorkbenchLink</a><br>
|
|
779
|
+
Provides link to Lingotek workbench, which can be referenced from an external site or iframe The link provided will only be valid for 30 minutes after the request is made</td>
|
|
780
|
+
<td>
|
|
781
|
+
</td>
|
|
782
|
+
</tr>
|
|
783
|
+
<tr>
|
|
784
|
+
<td>
|
|
785
|
+
<a href="#getProject">getProject</a><br>
|
|
786
|
+
Get the object representing a particular project</td>
|
|
787
|
+
<td>
|
|
788
|
+
<code>projectId</code></td>
|
|
789
|
+
</tr>
|
|
790
|
+
<tr>
|
|
791
|
+
<td>
|
|
792
|
+
<a href="#getProjectSetting">getProjectSetting</a><br>
|
|
793
|
+
Retrieve one of the settings for a project If the setting is not set for the project, the setting for the project's community will be used instead See <a href="#project_settings">Project Settings</a> for a list of types and keys accepted by this call.</td>
|
|
794
|
+
<td>
|
|
795
|
+
<code>projectId</code><br>
|
|
796
|
+
<code>type</code><br>
|
|
797
|
+
<code>key</code></td>
|
|
798
|
+
</tr>
|
|
799
|
+
<tr>
|
|
800
|
+
<td>
|
|
801
|
+
<a href="#getSegmentLabelTemplate">getSegmentLabelTemplate</a><br>
|
|
802
|
+
Get the object representing a particular segment label template
|
|
803
|
+
<p>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.</p>
|
|
804
|
+
<p>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.</p>
|
|
805
|
+
</td>
|
|
806
|
+
<td>
|
|
807
|
+
<code>segmentLabelTemplateName</code></td>
|
|
808
|
+
</tr>
|
|
809
|
+
<tr>
|
|
810
|
+
<td>
|
|
811
|
+
<a href="#getTMVault">getTMVault</a><br>
|
|
812
|
+
Get the object representing a particular translation memory vault</td>
|
|
813
|
+
<td>
|
|
814
|
+
<code>tmVaultId</code></td>
|
|
815
|
+
</tr>
|
|
816
|
+
<tr>
|
|
817
|
+
<td>
|
|
818
|
+
<a href="#getTranslationTarget">getTranslationTarget</a><br>
|
|
819
|
+
Get the object representing a particular translation target</td>
|
|
820
|
+
<td>
|
|
821
|
+
<code>translationTargetId</code></td>
|
|
822
|
+
</tr>
|
|
823
|
+
<tr>
|
|
824
|
+
<td>
|
|
825
|
+
<a href="#getUsers">getUsers</a><br>
|
|
826
|
+
Search Users by name, email, and login</td>
|
|
827
|
+
<td>
|
|
828
|
+
<code>search</code><br>
|
|
829
|
+
<code>limit</code><br>
|
|
830
|
+
<code>community</code></td>
|
|
831
|
+
</tr>
|
|
832
|
+
<tr>
|
|
833
|
+
<td>
|
|
834
|
+
<a href="#getVaultLanguages">getVaultLanguages</a><br>
|
|
835
|
+
Provides the language pairs found in the specified vaults</td>
|
|
836
|
+
<td>
|
|
837
|
+
<code>tmVaultId</code></td>
|
|
838
|
+
</tr>
|
|
839
|
+
<tr>
|
|
840
|
+
<td>
|
|
841
|
+
<a href="#getWorkbenchLink">getWorkbenchLink</a><br>
|
|
842
|
+
Provides link to Lingotek workbench, which can be referenced from an external site or iframe The link provided will only be valid for 30 minutes after the request is made</td>
|
|
843
|
+
<td>
|
|
844
|
+
<code>documentId</code><br>
|
|
845
|
+
<code>phaseId</code><br>
|
|
846
|
+
<code>invite_id</code><br>
|
|
847
|
+
<i><code>redirectURL*</code></i><br>
|
|
848
|
+
<code>embedded</code></td>
|
|
849
|
+
</tr>
|
|
850
|
+
<tr>
|
|
851
|
+
<td>
|
|
852
|
+
<a href="#ignoreSegment">ignoreSegment</a><br>
|
|
853
|
+
Flag a segment to be marked as non-translatable text</td>
|
|
854
|
+
<td>
|
|
855
|
+
<code>segmentId</code><br>
|
|
856
|
+
<code>documentId</code></td>
|
|
857
|
+
</tr>
|
|
858
|
+
<tr>
|
|
859
|
+
<td>
|
|
860
|
+
<a href="#importCommunityDictionary">importCommunityDictionary</a><br>
|
|
861
|
+
Adds an entry of the specified type to the community dictionary. See <a href="#community_dictionary">Community Dictionary</a> for a list of types. See <a href="#csv_delimiter">CSV Delimiters</a> for a list of valid delimiters.</td>
|
|
862
|
+
<td>
|
|
863
|
+
<code>type</code><br>
|
|
864
|
+
<code>file</code><br>
|
|
865
|
+
<code>delimiter</code></td>
|
|
866
|
+
</tr>
|
|
867
|
+
<tr>
|
|
868
|
+
<td>
|
|
869
|
+
<a href="#joinTeam">joinTeam</a><br>
|
|
870
|
+
Join a team.</td>
|
|
871
|
+
<td>
|
|
872
|
+
<code>teamId</code></td>
|
|
873
|
+
</tr>
|
|
874
|
+
<tr>
|
|
875
|
+
<td>
|
|
876
|
+
<a href="#leaveTeam">leaveTeam</a><br>
|
|
877
|
+
Leave a team.</td>
|
|
878
|
+
<td>
|
|
879
|
+
<code>teamId</code></td>
|
|
880
|
+
</tr>
|
|
881
|
+
<tr>
|
|
882
|
+
<td>
|
|
883
|
+
<a href="#listAssignedProjects">listAssignedProjects</a><br>
|
|
884
|
+
List all of the projects which have been assigned to the current active user</td>
|
|
885
|
+
<td>
|
|
886
|
+
</td>
|
|
887
|
+
</tr>
|
|
888
|
+
<tr>
|
|
889
|
+
<td>
|
|
890
|
+
<a href="#listCommunities">listCommunities</a><br>
|
|
891
|
+
Get communities for the currently logged in user</td>
|
|
892
|
+
<td>
|
|
893
|
+
</td>
|
|
894
|
+
</tr>
|
|
895
|
+
<tr>
|
|
896
|
+
<td>
|
|
897
|
+
<a href="#listCompanies">listCompanies</a><br>
|
|
898
|
+
Get a list of companies this client owns</td>
|
|
899
|
+
<td>
|
|
900
|
+
</td>
|
|
901
|
+
</tr>
|
|
902
|
+
<tr>
|
|
903
|
+
<td>
|
|
904
|
+
<a href="#listContacts">listContacts</a><br>
|
|
905
|
+
List all contacts in the contact list of the current active user</td>
|
|
906
|
+
<td>
|
|
907
|
+
</td>
|
|
908
|
+
</tr>
|
|
909
|
+
<tr>
|
|
910
|
+
<td>
|
|
911
|
+
<a href="#listDefaultPhaseTemplates (deprecated)">listDefaultPhaseTemplates (deprecated)</a><br>
|
|
912
|
+
List all of the default phase templates</td>
|
|
913
|
+
<td>
|
|
914
|
+
</td>
|
|
915
|
+
</tr>
|
|
916
|
+
<tr>
|
|
917
|
+
<td>
|
|
918
|
+
<a href="#listDocuments">listDocuments</a><br>
|
|
919
|
+
Get the object representing a particular document</td>
|
|
920
|
+
<td>
|
|
921
|
+
<code>documentId</code></td>
|
|
922
|
+
</tr>
|
|
923
|
+
<tr>
|
|
924
|
+
<td>
|
|
925
|
+
<a href="#listDocumentSegmentLabels">listDocumentSegmentLabels</a><br>
|
|
926
|
+
List all of the segment labels for a document. When a document is imported, Lingotek finds all of the elements and attributes within a document. This call returns those labels.</td>
|
|
927
|
+
<td>
|
|
928
|
+
<code>documentId</code></td>
|
|
929
|
+
</tr>
|
|
930
|
+
<tr>
|
|
931
|
+
<td>
|
|
932
|
+
<a href="#listDocumentSegments">listDocumentSegments</a><br>
|
|
933
|
+
List the details about the source and target languages of a document, as well as all of the source sentences of the document</td>
|
|
934
|
+
<td>
|
|
935
|
+
<code>documentId</code></td>
|
|
936
|
+
</tr>
|
|
937
|
+
<tr>
|
|
938
|
+
<td>
|
|
939
|
+
<a href="#listDocumentTranslationSegments">listDocumentTranslationSegments</a><br>
|
|
940
|
+
List the translated sentences for a specific translation target within a document</td>
|
|
941
|
+
<td>
|
|
942
|
+
<code>documentId</code><br>
|
|
943
|
+
<code>targetLanguage</code></td>
|
|
944
|
+
</tr>
|
|
945
|
+
<tr>
|
|
946
|
+
<td>
|
|
947
|
+
<a href="#listGlossaries">listGlossaries</a><br>
|
|
948
|
+
List all glossaries which are owned by the current active user</td>
|
|
949
|
+
<td>
|
|
950
|
+
</td>
|
|
951
|
+
</tr>
|
|
952
|
+
<tr>
|
|
953
|
+
<td>
|
|
954
|
+
<a href="#listJobs">listJobs</a><br>
|
|
955
|
+
List jobs for the current user in the currently logged in community. Results are limited to 1000 jobs. No parameters are expected.</td>
|
|
956
|
+
<td>
|
|
957
|
+
</td>
|
|
958
|
+
</tr>
|
|
959
|
+
<tr>
|
|
960
|
+
<td>
|
|
961
|
+
<a href="#listLabels">listLabels</a><br>
|
|
962
|
+
List all labels available in the community.</td>
|
|
963
|
+
<td>
|
|
964
|
+
</td>
|
|
965
|
+
</tr>
|
|
966
|
+
<tr>
|
|
967
|
+
<td>
|
|
968
|
+
<a href="#listLanguages">listLanguages</a><br>
|
|
969
|
+
List all languages available in the system. This includes country codes.</td>
|
|
970
|
+
<td>
|
|
971
|
+
<i><code>language*</code></i></td>
|
|
972
|
+
</tr>
|
|
973
|
+
<tr>
|
|
974
|
+
<td>
|
|
975
|
+
<a href="#listLanguageSkills">listLanguageSkills</a><br>
|
|
976
|
+
List all language skills for the active user.</td>
|
|
977
|
+
<td>
|
|
978
|
+
</td>
|
|
979
|
+
</tr>
|
|
980
|
+
<tr>
|
|
981
|
+
<td>
|
|
982
|
+
<a href="#listLeaderboardRange">listLeaderboardRange</a><br>
|
|
983
|
+
Show the leaderboard ranking statistics for a team over a given date range, or if no team is specified, for the current active community. This api call does not work with the Lingotek community.</td>
|
|
984
|
+
<td>
|
|
985
|
+
<i><code>teamName*</code></i><br>
|
|
986
|
+
<i><code>startDate*</code></i><br>
|
|
987
|
+
<i><code>endDate*</code></i></td>
|
|
988
|
+
</tr>
|
|
989
|
+
<tr>
|
|
990
|
+
<td>
|
|
991
|
+
<a href="#listLeaderboardResults">listLeaderboardResults</a><br>
|
|
992
|
+
Show the leaderboard ranking statistics for a team, or if no team is specified, for the current active community. This api call does not work with the Lingotek community.</td>
|
|
993
|
+
<td>
|
|
994
|
+
<i><code>teamName*</code></i><br>
|
|
995
|
+
<i><code>maxResults*</code></i></td>
|
|
996
|
+
</tr>
|
|
997
|
+
<tr>
|
|
998
|
+
<td>
|
|
999
|
+
<a href="#listPhases">listPhases</a><br>
|
|
1000
|
+
List details about all of the phases of a translation within a document</td>
|
|
1001
|
+
<td>
|
|
1002
|
+
<code>translationTargetId</code></td>
|
|
1003
|
+
</tr>
|
|
1004
|
+
<tr>
|
|
1005
|
+
<td>
|
|
1006
|
+
<a href="#listPhaseTemplates (deprecated)">listPhaseTemplates (deprecated)</a><br>
|
|
1007
|
+
List all of the phase templates for the current active user</td>
|
|
1008
|
+
<td>
|
|
1009
|
+
</td>
|
|
1010
|
+
</tr>
|
|
1011
|
+
<tr>
|
|
1012
|
+
<td>
|
|
1013
|
+
<a href="#listProjects">listProjects</a><br>
|
|
1014
|
+
List all projects which are owned or managed by the current active user</td>
|
|
1015
|
+
<td>
|
|
1016
|
+
</td>
|
|
1017
|
+
</tr>
|
|
1018
|
+
<tr>
|
|
1019
|
+
<td>
|
|
1020
|
+
<a href="#listSegmentLabelTemplates">listSegmentLabelTemplates</a><br>
|
|
1021
|
+
List the segment label templates.</td>
|
|
1022
|
+
<td>
|
|
1023
|
+
</td>
|
|
1024
|
+
</tr>
|
|
1025
|
+
<tr>
|
|
1026
|
+
<td>
|
|
1027
|
+
<a href="#listTeamMembers">listTeamMembers</a><br>
|
|
1028
|
+
Lists team members. Must be the team owner to see this list.</td>
|
|
1029
|
+
<td>
|
|
1030
|
+
<code>teamId</code></td>
|
|
1031
|
+
</tr>
|
|
1032
|
+
<tr>
|
|
1033
|
+
<td>
|
|
1034
|
+
<a href="#listTeams">listTeams</a><br>
|
|
1035
|
+
Lists the teams you are currently a part of.</td>
|
|
1036
|
+
<td>
|
|
1037
|
+
</td>
|
|
1038
|
+
</tr>
|
|
1039
|
+
<tr>
|
|
1040
|
+
<td>
|
|
1041
|
+
<a href="#listTMDocuments">listTMDocuments</a><br>
|
|
1042
|
+
List all of the documents which have been indexed as translation memory in a particular translation memory vault</td>
|
|
1043
|
+
<td>
|
|
1044
|
+
<code>tmVaultId</code></td>
|
|
1045
|
+
</tr>
|
|
1046
|
+
<tr>
|
|
1047
|
+
<td>
|
|
1048
|
+
<a href="#listTMVaults">listTMVaults</a><br>
|
|
1049
|
+
List all translation memory vaults that are owned or managed by the current active user</td>
|
|
1050
|
+
<td>
|
|
1051
|
+
</td>
|
|
1052
|
+
</tr>
|
|
1053
|
+
<tr>
|
|
1054
|
+
<td>
|
|
1055
|
+
<a href="#listTranslationTargets">listTranslationTargets</a><br>
|
|
1056
|
+
List all of the translation targets for the document</td>
|
|
1057
|
+
<td>
|
|
1058
|
+
<code>documentId</code></td>
|
|
1059
|
+
</tr>
|
|
1060
|
+
<tr>
|
|
1061
|
+
<td>
|
|
1062
|
+
<a href="#listUserStats">listUserStats</a><br>
|
|
1063
|
+
List user statistics.</td>
|
|
1064
|
+
<td>
|
|
1065
|
+
</td>
|
|
1066
|
+
</tr>
|
|
1067
|
+
<tr>
|
|
1068
|
+
<td>
|
|
1069
|
+
<a href="#listWorkflows">listWorkflows</a><br>
|
|
1070
|
+
List all of the workflows of the current active user in their current community.</td>
|
|
1071
|
+
<td>
|
|
1072
|
+
</td>
|
|
1073
|
+
</tr>
|
|
1074
|
+
<tr>
|
|
1075
|
+
<td>
|
|
1076
|
+
<a href="#machineTranslateDocument">machineTranslateDocument</a><br>
|
|
1077
|
+
List the details about the source and target languages of a document, as well as all of the source sentences of the document. Refer to the <a href="#community_settings">Appendix</a> for the list of engine Ids.</td>
|
|
1078
|
+
<td>
|
|
1079
|
+
<code>documentId</code><br>
|
|
1080
|
+
<code>engineId</code><br>
|
|
1081
|
+
<code>phaseId</code></td>
|
|
1082
|
+
</tr>
|
|
1083
|
+
<tr>
|
|
1084
|
+
<td>
|
|
1085
|
+
<a href="#markPhaseComplete">markPhaseComplete</a><br>
|
|
1086
|
+
Mark a phase complete</td>
|
|
1087
|
+
<td>
|
|
1088
|
+
<code>phaseId</code></td>
|
|
1089
|
+
</tr>
|
|
1090
|
+
<tr>
|
|
1091
|
+
<td>
|
|
1092
|
+
<a href="#MTSegments">MTSegments</a><br>
|
|
1093
|
+
Insert one or more translations into a document by parsing a JSON result from a machine translation utility</td>
|
|
1094
|
+
<td>
|
|
1095
|
+
<code>documentId</code><br>
|
|
1096
|
+
<code>json</code></td>
|
|
1097
|
+
</tr>
|
|
1098
|
+
<tr>
|
|
1099
|
+
<td>
|
|
1100
|
+
<a href="#pollClientReport">pollClientReport</a><br>
|
|
1101
|
+
Checks if a client's report is still processing</td>
|
|
1102
|
+
<td>
|
|
1103
|
+
<code>report_name</code></td>
|
|
1104
|
+
</tr>
|
|
1105
|
+
<tr>
|
|
1106
|
+
<td>
|
|
1107
|
+
<a href="#pollDocumentAnalysis">pollDocumentAnalysis</a><br>
|
|
1108
|
+
Poll for the progress of an analysis process for a document</td>
|
|
1109
|
+
<td>
|
|
1110
|
+
<code>documentId</code></td>
|
|
1111
|
+
</tr>
|
|
1112
|
+
<tr>
|
|
1113
|
+
<td>
|
|
1114
|
+
<a href="#pollDocumentImport">pollDocumentImport</a><br>
|
|
1115
|
+
Get the import status of a document</td>
|
|
1116
|
+
<td>
|
|
1117
|
+
<code>documentId</code></td>
|
|
1118
|
+
</tr>
|
|
1119
|
+
<tr>
|
|
1120
|
+
<td>
|
|
1121
|
+
<a href="#pollGlossaryImport">pollGlossaryImport</a><br>
|
|
1122
|
+
Get the import status of a glossary, as a percentage</td>
|
|
1123
|
+
<td>
|
|
1124
|
+
<code>glossaryUploadId</code></td>
|
|
1125
|
+
</tr>
|
|
1126
|
+
<tr>
|
|
1127
|
+
<td>
|
|
1128
|
+
<a href="#pollProjectAnalysis">pollProjectAnalysis</a><br>
|
|
1129
|
+
Poll for the progress of an analysis process for a project</td>
|
|
1130
|
+
<td>
|
|
1131
|
+
<code>projectId</code></td>
|
|
1132
|
+
</tr>
|
|
1133
|
+
<tr>
|
|
1134
|
+
<td>
|
|
1135
|
+
<a href="#pollTMVaultImport">pollTMVaultImport</a><br>
|
|
1136
|
+
Get the import status of a translation memory vault, as a percentage</td>
|
|
1137
|
+
<td>
|
|
1138
|
+
<code>tmVaultUploadId</code></td>
|
|
1139
|
+
</tr>
|
|
1140
|
+
<tr>
|
|
1141
|
+
<td>
|
|
1142
|
+
<a href="#prefillDocument">prefillDocument</a><br>
|
|
1143
|
+
Prefill the segments of a document. Exact matches and matches with a qualifying threshold will be automatically inserted into the target. Vault precedence is determined by the order of the <code>tmVaultId</code>parameter values (highest first).</td>
|
|
1144
|
+
<td>
|
|
1145
|
+
<code>phaseId</code><br>
|
|
1146
|
+
<code>tmVaultId</code><br>
|
|
1147
|
+
<code>tmVaultThreshold</code><br>
|
|
1148
|
+
<code>lockTMVault</code><br>
|
|
1149
|
+
<code>lockTerminology</code><br>
|
|
1150
|
+
<code>overwrite</code><br>
|
|
1151
|
+
<code>completePhase</code></td>
|
|
1152
|
+
</tr>
|
|
1153
|
+
<tr>
|
|
1154
|
+
<td>
|
|
1155
|
+
<a href="#regardSegment">regardSegment</a><br>
|
|
1156
|
+
Mark as segment as translatable which was marked as untranslatable. Segments can be marked as nontranslatable either through segment chooser templates, or through the <code>ignoreSegment</code>call.</td>
|
|
1157
|
+
<td>
|
|
1158
|
+
<code>segmentId</code><br>
|
|
1159
|
+
<code>documentId</code></td>
|
|
1160
|
+
</tr>
|
|
1161
|
+
<tr>
|
|
1162
|
+
<td>
|
|
1163
|
+
<a href="#removeClientCommunityPreference">removeClientCommunityPreference</a><br>
|
|
1164
|
+
Removes a client preference specific to a community (which means it will use the system-wide default instead). Refer to the <a href="#client_community_preferences">Appendix</a> for the preferences.</td>
|
|
1165
|
+
<td>
|
|
1166
|
+
<code>key</code></td>
|
|
1167
|
+
</tr>
|
|
1168
|
+
<tr>
|
|
1169
|
+
<td>
|
|
1170
|
+
<a href="#removeCommunityDictionaryEntry">removeCommunityDictionaryEntry</a><br>
|
|
1171
|
+
Removes an entry of the specified type from the community dictionary. See <a href="#community_dictionary">Community Dictionary</a> for a list of types.</td>
|
|
1172
|
+
<td>
|
|
1173
|
+
<code>type</code><br>
|
|
1174
|
+
<code>entry</code></td>
|
|
1175
|
+
</tr>
|
|
1176
|
+
<tr>
|
|
1177
|
+
<td>
|
|
1178
|
+
<a href="#removeCompany">removeCompany</a><br>
|
|
1179
|
+
Remove a company from the system</td>
|
|
1180
|
+
<td>
|
|
1181
|
+
<code>companyId</code></td>
|
|
1182
|
+
</tr>
|
|
1183
|
+
<tr>
|
|
1184
|
+
<td>
|
|
1185
|
+
<a href="#removeContact">removeContact</a><br>
|
|
1186
|
+
Remove a contact from the contact list of the current active user</td>
|
|
1187
|
+
<td>
|
|
1188
|
+
<code>contactId</code></td>
|
|
1189
|
+
</tr>
|
|
1190
|
+
<tr>
|
|
1191
|
+
<td>
|
|
1192
|
+
<a href="#removeDocument">removeDocument</a><br>
|
|
1193
|
+
Remove a document from a project, and delete it from the system</td>
|
|
1194
|
+
<td>
|
|
1195
|
+
<code>documentId</code></td>
|
|
1196
|
+
</tr>
|
|
1197
|
+
<tr>
|
|
1198
|
+
<td>
|
|
1199
|
+
<a href="#removeGlossary">removeGlossary</a><br>
|
|
1200
|
+
Remove a glossary from the system</td>
|
|
1201
|
+
<td>
|
|
1202
|
+
<code>glossaryId</code></td>
|
|
1203
|
+
</tr>
|
|
1204
|
+
<tr>
|
|
1205
|
+
<td>
|
|
1206
|
+
<a href="#removeLabel">removeLabel</a><br>
|
|
1207
|
+
Delete a label</td>
|
|
1208
|
+
<td>
|
|
1209
|
+
<code>id</code></td>
|
|
1210
|
+
</tr>
|
|
1211
|
+
<tr>
|
|
1212
|
+
<td>
|
|
1213
|
+
<a href="#removePhase">removePhase</a><br>
|
|
1214
|
+
Remove a phase within a translation target of a document</td>
|
|
1215
|
+
<td>
|
|
1216
|
+
<code>phaseId</code></td>
|
|
1217
|
+
</tr>
|
|
1218
|
+
<tr>
|
|
1219
|
+
<td>
|
|
1220
|
+
<a href="#removePhaseFromTemplate">removePhaseFromTemplate</a><br>
|
|
1221
|
+
Remove an existing phase from a phase template
|
|
1222
|
+
<p>A phase template represents a group of phases, which will be added to the translation target when the template is applied</p>
|
|
1223
|
+
<p>The id of the parameter set for each phase in the phase template can be obtained from a call to <code>getPhaseTemplate</code>, or when adding a phase to the template with <code>addPhaseToTemplate</code></p>
|
|
1224
|
+
</td>
|
|
1225
|
+
<td>
|
|
1226
|
+
<code>phaseTemplateId</code><br>
|
|
1227
|
+
<code>phaseParameterSetId</code></td>
|
|
1228
|
+
</tr>
|
|
1229
|
+
<tr>
|
|
1230
|
+
<td>
|
|
1231
|
+
<a href="#removePhaseTemplate (deprecated)">removePhaseTemplate (deprecated)</a><br>
|
|
1232
|
+
Remove a phase template for the current active user from the system
|
|
1233
|
+
<p>A phase template represents a group of phases, which will be added to the translation target when the template is applied</p>
|
|
1234
|
+
</td>
|
|
1235
|
+
<td>
|
|
1236
|
+
<code>phaseTemplateId</code></td>
|
|
1237
|
+
</tr>
|
|
1238
|
+
<tr>
|
|
1239
|
+
<td>
|
|
1240
|
+
<a href="#removePreference">removePreference</a><br>
|
|
1241
|
+
Delete a client preference</td>
|
|
1242
|
+
<td>
|
|
1243
|
+
<code>key</code></td>
|
|
1244
|
+
</tr>
|
|
1245
|
+
<tr>
|
|
1246
|
+
<td>
|
|
1247
|
+
<a href="#removeProject">removeProject</a><br>
|
|
1248
|
+
Remove a project from the system, and delete all documents in the project</td>
|
|
1249
|
+
<td>
|
|
1250
|
+
<code>projectId</code></td>
|
|
1251
|
+
</tr>
|
|
1252
|
+
<tr>
|
|
1253
|
+
<td>
|
|
1254
|
+
<a href="#removeSegmentLabelFromTemplate">removeSegmentLabelFromTemplate</a><br>
|
|
1255
|
+
Remove one or more segment labels from a segment label template
|
|
1256
|
+
<p>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.</p>
|
|
1257
|
+
<p>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.</p>
|
|
1258
|
+
</td>
|
|
1259
|
+
<td>
|
|
1260
|
+
<code>segmentLabelTemplateName</code><br>
|
|
1261
|
+
<code>segmentLabels</code></td>
|
|
1262
|
+
</tr>
|
|
1263
|
+
<tr>
|
|
1264
|
+
<td>
|
|
1265
|
+
<a href="#removeSegmentLabelTemplate">removeSegmentLabelTemplate</a><br>
|
|
1266
|
+
Remove a segment label template for the current active user from the system
|
|
1267
|
+
<p>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.</p>
|
|
1268
|
+
<p>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.</p>
|
|
1269
|
+
</td>
|
|
1270
|
+
<td>
|
|
1271
|
+
<code>segmentLabelTemplateName</code></td>
|
|
1272
|
+
</tr>
|
|
1273
|
+
<tr>
|
|
1274
|
+
<td>
|
|
1275
|
+
<a href="#removeTeam">removeTeam</a><br>
|
|
1276
|
+
Remove a team.</td>
|
|
1277
|
+
<td>
|
|
1278
|
+
<code>teamId</code></td>
|
|
1279
|
+
</tr>
|
|
1280
|
+
<tr>
|
|
1281
|
+
<td>
|
|
1282
|
+
<a href="#removeTeamLead">removeTeamLead</a><br>
|
|
1283
|
+
Removes a user as a team lead</td>
|
|
1284
|
+
<td>
|
|
1285
|
+
<code>teamId</code><br>
|
|
1286
|
+
<code>clientId</code></td>
|
|
1287
|
+
</tr>
|
|
1288
|
+
<tr>
|
|
1289
|
+
<td>
|
|
1290
|
+
<a href="#removeTeamMember">removeTeamMember</a><br>
|
|
1291
|
+
Remove a member from a team.</td>
|
|
1292
|
+
<td>
|
|
1293
|
+
<code>teamId</code><br>
|
|
1294
|
+
<code>clientId</code></td>
|
|
1295
|
+
</tr>
|
|
1296
|
+
<tr>
|
|
1297
|
+
<td>
|
|
1298
|
+
<a href="#removeTM">removeTM</a><br>
|
|
1299
|
+
Queues up removal of translation memory from it's corresponding vault.</td>
|
|
1300
|
+
<td>
|
|
1301
|
+
<code>tmVaultId</code><br>
|
|
1302
|
+
<code>tid</code></td>
|
|
1303
|
+
</tr>
|
|
1304
|
+
<tr>
|
|
1305
|
+
<td>
|
|
1306
|
+
<a href="#removeTMVault">removeTMVault</a><br>
|
|
1307
|
+
Remove a translation memory vault from the system</td>
|
|
1308
|
+
<td>
|
|
1309
|
+
<code>tmVaultId</code></td>
|
|
1310
|
+
</tr>
|
|
1311
|
+
<tr>
|
|
1312
|
+
<td>
|
|
1313
|
+
<a href="#removeTranslationTarget">removeTranslationTarget</a><br>
|
|
1314
|
+
Remove a translation target from a document</td>
|
|
1315
|
+
<td>
|
|
1316
|
+
<code>translationTargetId</code></td>
|
|
1317
|
+
</tr>
|
|
1318
|
+
<tr>
|
|
1319
|
+
<td>
|
|
1320
|
+
<a href="#removeUploadedTMFromVault">removeUploadedTMFromVault</a><br>
|
|
1321
|
+
Remove uploaded TMX/Xliff document(s) from translation memory vault</td>
|
|
1322
|
+
<td>
|
|
1323
|
+
<code>id</code></td>
|
|
1324
|
+
</tr>
|
|
1325
|
+
<tr>
|
|
1326
|
+
<td>
|
|
1327
|
+
<a href="#saveLabelTemplate">saveLabelTemplate</a><br>
|
|
1328
|
+
Save one or more labels as a label template for the current active user</td>
|
|
1329
|
+
<td>
|
|
1330
|
+
<code>name</code><br>
|
|
1331
|
+
<i><code>labels*</code></i></td>
|
|
1332
|
+
</tr>
|
|
1333
|
+
<tr>
|
|
1334
|
+
<td>
|
|
1335
|
+
<a href="#saveSegment">saveSegment</a><br>
|
|
1336
|
+
Save the segment</td>
|
|
1337
|
+
<td>
|
|
1338
|
+
<code>sourceText</code><br>
|
|
1339
|
+
<code>targetText</code><br>
|
|
1340
|
+
<code>targetLanguage</code><br>
|
|
1341
|
+
<code>documentId</code><br>
|
|
1342
|
+
<code>overwrite</code></td>
|
|
1343
|
+
</tr>
|
|
1344
|
+
<tr>
|
|
1345
|
+
<td>
|
|
1346
|
+
<a href="#searchGlossary">searchGlossary</a><br>
|
|
1347
|
+
Search a glossary for the specified target translation of the specified source text</td>
|
|
1348
|
+
<td>
|
|
1349
|
+
<code>glossaryId</code><br>
|
|
1350
|
+
<code>text</code><br>
|
|
1351
|
+
<code>sourceLanguage</code><br>
|
|
1352
|
+
<code>targetLanguage</code><br>
|
|
1353
|
+
<i><code>count*</code></i></td>
|
|
1354
|
+
</tr>
|
|
1355
|
+
<tr>
|
|
1356
|
+
<td>
|
|
1357
|
+
<a href="#setCommunityConcurrentUsers">setCommunityConcurrentUsers</a><br>
|
|
1358
|
+
Sets the maximum number of concurrent users in the community. System administrator rights are required.</td>
|
|
1359
|
+
<td>
|
|
1360
|
+
<code>community</code><br>
|
|
1361
|
+
<code>users</code></td>
|
|
1362
|
+
</tr>
|
|
1363
|
+
<tr>
|
|
1364
|
+
<td>
|
|
1365
|
+
<a href="#setProfileAttributes">setProfileAttributes</a><br>
|
|
1366
|
+
Set profile attributes.</td>
|
|
1367
|
+
<td>
|
|
1368
|
+
<i><code>name*</code></i><br>
|
|
1369
|
+
<i><code>email*</code></i><br>
|
|
1370
|
+
<i><code>login_id*</code></i><br>
|
|
1371
|
+
<i><code>phone*</code></i><br>
|
|
1372
|
+
<i><code>company*</code></i><br>
|
|
1373
|
+
<i><code>native_language*</code></i><br>
|
|
1374
|
+
<i><code>location*</code></i><br>
|
|
1375
|
+
<i><code>notes*</code></i><br>
|
|
1376
|
+
<i><code>on_leaderboard*</code></i><br>
|
|
1377
|
+
<i><code>oldpword*</code></i><br>
|
|
1378
|
+
<i><code>newpword*</code></i><br>
|
|
1379
|
+
<i><code>source*</code></i><br>
|
|
1380
|
+
<i><code>old_source*</code></i><br>
|
|
1381
|
+
<i><code>target*</code></i><br>
|
|
1382
|
+
<i><code>old_target*</code></i><br>
|
|
1383
|
+
<i><code>experience*</code></i><br>
|
|
1384
|
+
<i><code>rate*</code></i><br>
|
|
1385
|
+
<i><code>rush_rate*</code></i><br>
|
|
1386
|
+
<i><code>currency*</code></i><br>
|
|
1387
|
+
<i><code>per*</code></i><br>
|
|
1388
|
+
<i><code>service_note*</code></i><br>
|
|
1389
|
+
<i><code>notifications_project_complete*</code></i><br>
|
|
1390
|
+
<i><code>notifications_assigned_document*</code></i><br>
|
|
1391
|
+
<i><code>notifications_available_community_document*</code></i><br>
|
|
1392
|
+
<i><code>notifications_phase_ready*</code></i></td>
|
|
1393
|
+
</tr>
|
|
1394
|
+
<tr>
|
|
1395
|
+
<td>
|
|
1396
|
+
<a href="#translatorsForLanguage">translatorsForLanguage</a><br>
|
|
1397
|
+
Retrieves translators in the community for the specified language pair.</td>
|
|
1398
|
+
<td>
|
|
1399
|
+
<code>sourceLang</code><br>
|
|
1400
|
+
<code>targetLang</code></td>
|
|
1401
|
+
</tr>
|
|
1402
|
+
<tr>
|
|
1403
|
+
<td>
|
|
1404
|
+
<a href="#updateContentDocument">updateContentDocument</a><br>
|
|
1405
|
+
Update an existing document with a new version, keeping translations and formatting that were applied to any unchanged segments between the two versions</td>
|
|
1406
|
+
<td>
|
|
1407
|
+
<code>documentId</code><br>
|
|
1408
|
+
<code>content</code><br>
|
|
1409
|
+
<i><code>srxFileContents*</code></i><br>
|
|
1410
|
+
<i><code>itsFileContents*</code></i><br>
|
|
1411
|
+
<i><code>fprmFileContents*</code></i><br>
|
|
1412
|
+
<i><code>secondaryFprmFileContents*</code></i></td>
|
|
1413
|
+
</tr>
|
|
1414
|
+
<tr>
|
|
1415
|
+
<td>
|
|
1416
|
+
<a href="#updateDocument">updateDocument</a><br>
|
|
1417
|
+
Update an existing document with a new version, keeping translations and formatting that were applied to any unchanged segments between the two versions</td>
|
|
1418
|
+
<td>
|
|
1419
|
+
<code>documentId</code><br>
|
|
1420
|
+
<code>file</code></td>
|
|
1421
|
+
</tr>
|
|
1422
|
+
<tr>
|
|
1423
|
+
<td>
|
|
1424
|
+
<a href="#updateTM">updateTM</a><br>
|
|
1425
|
+
Queue an update of the specified TM in it's corresponding vault.</td>
|
|
1426
|
+
<td>
|
|
1427
|
+
<code>tmVaultId</code><br>
|
|
1428
|
+
<code>tid</code><br>
|
|
1429
|
+
<code>translation</code></td>
|
|
1430
|
+
</tr>
|
|
1431
|
+
<tr>
|
|
1432
|
+
<td>
|
|
1433
|
+
<a href="#uploadCSVToGlossary">uploadCSVToGlossary</a><br>
|
|
1434
|
+
Upload a CSV file into a glossary</td>
|
|
1435
|
+
<td>
|
|
1436
|
+
<code>glossaryId</code><br>
|
|
1437
|
+
<i><code>delimiter*</code></i><br>
|
|
1438
|
+
<code>file</code></td>
|
|
1439
|
+
</tr>
|
|
1440
|
+
<tr>
|
|
1441
|
+
<td>
|
|
1442
|
+
<a href="#uploadTBXToGlossary">uploadTBXToGlossary</a><br>
|
|
1443
|
+
Upload a TBX-Basic terminology file into a glossary</td>
|
|
1444
|
+
<td>
|
|
1445
|
+
<code>glossaryId</code><br>
|
|
1446
|
+
<code>file</code></td>
|
|
1447
|
+
</tr>
|
|
1448
|
+
<tr>
|
|
1449
|
+
<td>
|
|
1450
|
+
<a href="#uploadTMXToTMVault">uploadTMXToTMVault</a><br>
|
|
1451
|
+
Upload a TMX file into an existing translation memory vault</td>
|
|
1452
|
+
<td>
|
|
1453
|
+
<code>tmVaultId</code><br>
|
|
1454
|
+
<code>file</code><br>
|
|
1455
|
+
<code>name</code></td>
|
|
1456
|
+
</tr>
|
|
1457
|
+
<tr>
|
|
1458
|
+
<td>
|
|
1459
|
+
<a href="#uploadXliffToTMVault">uploadXliffToTMVault</a><br>
|
|
1460
|
+
Upload a TMX file into an existing translation memory vault</td>
|
|
1461
|
+
<td>
|
|
1462
|
+
<code>tmVaultId</code><br>
|
|
1463
|
+
<code>file</code><br>
|
|
1464
|
+
<code>name</code></td>
|
|
1465
|
+
</tr>
|
|
1466
|
+
<tr>
|
|
1467
|
+
<td>
|
|
1468
|
+
<a href="#uploadXLSToGlossary">uploadXLSToGlossary</a><br>
|
|
1469
|
+
Upload a CSV file into a glossary</td>
|
|
1470
|
+
<td>
|
|
1471
|
+
<code>glossaryId</code><br>
|
|
1472
|
+
<code>file</code></td>
|
|
1473
|
+
</tr>
|
|
1474
|
+
<tr>
|
|
1475
|
+
<td>
|
|
1476
|
+
<a href="#userState">userState</a></td>
|
|
1477
|
+
<td>
|
|
1478
|
+
<code>clientId</code></td>
|
|
1479
|
+
</tr>
|
|
1480
|
+
</tbody>
|
|
1481
|
+
</table>
|