Create New Project
action: api/v2/project/create
token string
name string
sourceLang locale
targetLang list(locale)
client string O
domain string O
due datetime O
machineTranslateSettings domain(MachineTranslateSettings) O
workflowStep list(domain(WorkflowStep)) O
response: JSON
{
"id": 238 // id of the new project
}
Delete Project
action: api/v2/project/delete
token string
project domain(Project)
response: empty
Get Project Info
action: api/v2/project/get
token string
project domain(Project)
response: JSON
{
"id": 238,
"status": "Completed",
"sourceLang": "en",
"targetLangs": [ "de", "fr" ]
}
Set Status
action: api/v2/project/setStatus
token string
project domain(Project)
status enum(ProjectStatus)
response: empty
Set Translation Memories
action: api/v2/project/setTransMemories
token string
project domain(Project)
readTransMemory list(domain(TransMemory))
writeTransMemory domain(TransMemory) // write translation memory must be included in the read translation memories, too
penalty list(double) O // a list of penalties for each read translation memory
targetLang locale O // set translation memories only for the specific project target language
workflowStep domain(WorkflowStep) O // set translation memories only for the specific workflow step
response: empty
Get Translation Memories
action: api/v2/project/getTransMemories
token string
project domain(Project)
response: JSON
[
{
"writeMode":true,
"transMemory":{
"id":1,
"targetLangs":[
"de"
],
"sourceLang":"en",
"name":"transMem"
},
"targetLang":"de",
"penalty":0,
"readMode":true,
"workflowStep":null
}
]
Set Term Bases
action: api/v2/project/setTermBases
token string
project domain(Project)
readTermBase list(domain(TermBase))
writeTermBase domain(TermBase) // write term base must be included in the read term bases, too
targetLang locale O // set term bases only for the specific project target language
response: empty
Get Term Bases
action: api/v2/project/getTermBases
token string
project domain(Project)
response: JSON
[
{
"writeMode":true,
"termBase":{
"id":1,
"langs":[
"de", "en"
],
"name":"termBase"
},
"targetLang":"de",
"readMode":true,
"workflowStep":null
}
]
List Projects
action: api/v2/project/list
token string
page integer O(0)
response: JSON
[
{
"id":1,
"name":"en -> cs",
"status":"NEW",
"sourceLang":"en",
"targetLangs":[
"cs"
],
"dateDue":null,
"dateCreated":"2013-05-10T15:31:31Z",
"note":""
}
]
Edit Access & Security Settings
action: api/v2/project/editAccessSettings
token string
project domain(Project)
translationMemoryDownloadEnabled boolean O
webEditorEnabled boolean O
webEditorEnabledForLinguists boolean O
showUserDataToLinguists boolean O
emailNotifications boolean O
response: empty
