reference
Projects
74 endpoints
Project Management
GET/api/v3/project
List Projects
Requires: PROJECT_list
query parameters
uuids |
string (uuid)[] |
reference |
string |
purchaseOrder |
string |
name |
string |
status |
string[] |
createDate |
integer (int64) |
dueDate |
integer (int64) |
startCreateDate |
string |
endCreateDate |
string |
startDueDate |
string |
endDueDate |
string |
tags |
string[] |
isContinuous |
boolean |
targetUserUUID |
string (uuid) |
unassigned |
boolean |
contactPersonUuid |
string (uuid) |
projectManagerUuid |
string (uuid) |
projectManagerUuids |
string (uuid)[] |
projectGroupId |
string (uuid) |
sourceLocales |
string[] |
targetLocales |
string[] |
organizationUuid |
string (uuid) |
orgUnitUuid |
string (uuid) |
orgUnitUuids |
string (uuid)[] |
sourceQuery |
string |
targetQuery |
string |
fileName |
string |
invoiceUuid |
string (uuid) |
prompt |
string |
orgUnitName |
string |
orgName |
string |
projectManagerName |
string |
contactName |
string |
sort |
string |
page |
integerPage to return, starting at 0. |
size |
integerItems per page. |
Responses
200 OK
content |
ProjectDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer |
numberOfElements |
integer |
pageable |
PageableObject |
size |
integer |
sort |
SortObject |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}POST/api/v3/project
Create Project
Requires: PROJECT_create
Creates a project from the body. With id-only, the body is ignored and an empty project is created instead (the base project of Project Routing), optionally for clientUuid, sourceLocale and contentMode.
query parameters
id-only |
booleanCreate an empty project and ignore the body. |
inferDefaultSettings |
boolean |
Request body
assigneeUUID |
string (uuid) |
contactUUID |
string (uuid) |
contentMode |
stringFILES KEY_VALUE |
creatorUUID |
string (uuid) |
currency |
string |
isContinuous |
boolean |
notes |
string |
orgUnitUUID |
string (uuid) |
reference |
string |
sourceLocale |
string |
tags |
string[] |
timezone |
string |
Responses
201 Created
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"assigneeUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contactUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contentMode": "FILES",
"creatorUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"isContinuous": false,
"notes": "string",
"orgUnitUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"sourceLocale": "string",
"tags": [
"string"
],
"timezone": "string"
}'Response 201
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}GET/api/v3/project/{projectUUID}
Get Project
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
responseType |
string |
Responses
200 OK
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}POST/api/v3/project/{projectUUID}/info
Update Project Info
Requires: PROJECT_update
path parameters
projectUUIDrequired |
string (uuid) |
Request body
accountUuid |
string (uuid) |
assigneeUUID |
string (uuid) |
automationEnabled |
boolean |
autopilotEnabled |
boolean |
categoryId |
integer (int64) |
ciTag |
string |
clientUUID |
string (uuid) |
confidenceMatchOverRepetitionEnabled |
boolean |
contactUUID |
string (uuid) |
contentMode |
stringFILES KEY_VALUE |
costCalculationMode |
stringAUTOMATIC MANUAL |
currency |
string |
dueDate |
integer (int64) |
inferDefaultSettings |
boolean |
instructions |
string |
invoiceInfo |
string |
isContinuous |
boolean |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
priceListUUID |
string (uuid) |
reference |
string |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
tags |
string[] |
taskPaymentType |
stringWORD HOUR |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
Responses
200 OK
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/info' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"assigneeUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"automationEnabled": false,
"autopilotEnabled": false,
"categoryId": 0,
"ciTag": "string",
"clientUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"confidenceMatchOverRepetitionEnabled": false,
"contactUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contentMode": "FILES",
"costCalculationMode": "AUTOMATIC",
"currency": "string",
"dueDate": 0,
"inferDefaultSettings": false,
"instructions": "string",
"invoiceInfo": "string",
"isContinuous": false,
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"priceListUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"tags": [
"string"
],
"taskPaymentType": "WORD",
"timezone": "string",
"tmMatchOverRepetitionEnabled": false
}'Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}GET/api/v3/project/{projectUUID}/ingestion/status
Get Project Ingestion Status
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Responses
200 OK
stringCOMPLETED COMPLETED_WARN IN_PROGRESS
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/ingestion/status' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
"COMPLETED"GET/api/v3/project/{projectUuid}/payment-type
Get Project Payment Type
Requires: EDITOR_open_editor
path parameters
projectUuidrequired |
string (uuid) |
Responses
200 OK
string
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUuid}/payment-type' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
"string"GET/api/v3/project/{projectUuid}/process-summary
Get Project Process Summary
Requires: PROJECT_get_by_id
path parameters
projectUuidrequired |
string (uuid) |
Responses
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUuid}/process-summary' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"count": 0,
"status": "string"
}
]POST/api/v3/project/{projectUUID}/status
Change Project Status
Requires: PROJECT_change_status
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
can-calculate-costs |
boolean |
Request body
calculateCosts |
boolean |
createSeparateOutputFolder |
boolean |
detailedReasons |
string[] |
enableAutoDueDate |
boolean |
force |
boolean |
newStatus |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
previousStatus |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
projectUuid |
string (uuid) |
reason |
string |
skipBuildTranslatedFile |
boolean |
skipDatabaseUpdate |
boolean |
skipGitHub |
boolean |
timestamp |
integer (int64) |
user |
UserDto |
userUuid |
string (uuid) |
uuid |
string (uuid) |
writeToDisk |
boolean |
writeToS3 |
boolean |
Responses
200 OK
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/status' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"calculateCosts": false,
"createSeparateOutputFolder": false,
"detailedReasons": [
"string"
],
"enableAutoDueDate": false,
"force": false,
"newStatus": "DELETED",
"previousStatus": "DELETED",
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "string",
"skipBuildTranslatedFile": false,
"skipDatabaseUpdate": false,
"skipGitHub": false,
"timestamp": 0,
"user": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"userUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"writeToDisk": false,
"writeToS3": false
}'Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}Resources and File Params
GET/api/v1/atlas/parser/file-params
Get File Params
Requires: PROJECT_RESOURCE_create
Responses
200 OK
extensionsMap |
map<string, string[]> |
files |
map<string, FileType> |
terms |
TermsParams |
Request
curl -X GET 'https://app.wxrks.com/api/v1/atlas/parser/file-params' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"extensionsMap": {},
"files": {},
"terms": {
"extractTerms": false,
"parameters": {}
}
}POST/api/v3/project/{projectUUID}/resource
Create Project Resource
Requires: PROJECT_RESOURCE_create
path parameters
projectUUIDrequired |
string (uuid) |
Request body
name |
string |
notes |
string |
path |
string |
previewUrl |
string |
tags |
string |
targetLocales |
string[] |
Responses
201 Created
creation |
integer (int64) |
defaultFilterSettings |
boolean |
hash |
string |
isProcessedSuccessfully |
boolean |
name |
string |
notes |
string |
params |
FileParams |
parentName |
string |
parentUuid |
string (uuid) |
path |
string |
preSignedUrl |
string |
processingErrorMessage |
string |
projectUuid |
string (uuid) |
segmentationParams |
map<string, object> |
sourceLocale |
string |
targetLocales |
string[] |
type |
stringFOLDER FILE |
url |
string |
uuid |
string (uuid) |
workflows |
string[] |
zipProcessingTaskId |
string |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"notes": "string",
"path": "string",
"previewUrl": "string",
"tags": "string",
"targetLocales": [
"string"
]
}'Response 201
{
"creation": 0,
"defaultFilterSettings": false,
"hash": "string",
"isProcessedSuccessfully": false,
"name": "string",
"notes": "string",
"params": {
"applyAll": false,
"applySourceSegmentation": false,
"defaultFilter": "string",
"defaultFilterScope": "ORG_UNIT",
"defaultFilterSettings": false,
"extensionFile": "string",
"extractTerms": false,
"parameters": {},
"parserFilter": "string",
"projectResourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationFileUrl": "string",
"segmentationParams": {},
"tagRegex": "string",
"termsParams": {}
},
"parentName": "string",
"parentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"path": "string",
"preSignedUrl": "string",
"processingErrorMessage": "string",
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationParams": {},
"sourceLocale": "string",
"targetLocales": [
"string"
],
"type": "FOLDER",
"url": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workflows": [
"string"
],
"zipProcessingTaskId": "string"
}DELETE/api/v3/project/{projectUUID}/resource/{projectResourceUUID}
Delete Project Resource
Requires: PROJECT_RESOURCE_delete
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
query parameters
processingTaskId |
string |
Responses
200 OK
Request
curl -X DELETE 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/{projectResourceUUID}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"PUT/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/content
Upload Project Resource Content
Requires: PROJECT_RESOURCE_create
A .zip is stored as one file, not extracted: call Extract ZIP Resource afterwards to add the files inside it.
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
Request body
objectmultipart/form-data
Responses
200 OK
Request
curl -X PUT 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/content' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-F 'file=@./file'POST/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/file-params
Change Project Resource Params
Requires: PROJECT_RESOURCE_create
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
Request body
applyAll |
boolean |
applySourceSegmentation |
boolean |
defaultFilter |
string |
defaultFilterScope |
stringORG_UNIT ACCOUNT |
defaultFilterSettings |
boolean |
extensionFile |
string |
extractTerms |
boolean |
parameters |
map<string, object> |
parserFilter |
string |
projectResourceId |
string (uuid) |
segmentationFileUrl |
string |
segmentationParams |
map<string, object> |
tagRegex |
string |
termsParams |
map<string, object> |
Responses
200 OK
creation |
integer (int64) |
defaultFilterSettings |
boolean |
hash |
string |
isProcessedSuccessfully |
boolean |
name |
string |
notes |
string |
params |
FileParams |
parentName |
string |
parentUuid |
string (uuid) |
path |
string |
preSignedUrl |
string |
processingErrorMessage |
string |
projectUuid |
string (uuid) |
segmentationParams |
map<string, object> |
sourceLocale |
string |
targetLocales |
string[] |
type |
stringFOLDER FILE |
url |
string |
uuid |
string (uuid) |
workflows |
string[] |
zipProcessingTaskId |
string |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/file-params' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"applyAll": false,
"applySourceSegmentation": false,
"defaultFilter": "string",
"defaultFilterScope": "ORG_UNIT",
"defaultFilterSettings": false,
"extensionFile": "string",
"extractTerms": false,
"parameters": {},
"parserFilter": "string",
"projectResourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationFileUrl": "string",
"segmentationParams": {},
"tagRegex": "string",
"termsParams": {}
}'Response 200
{
"creation": 0,
"defaultFilterSettings": false,
"hash": "string",
"isProcessedSuccessfully": false,
"name": "string",
"notes": "string",
"params": {
"applyAll": false,
"applySourceSegmentation": false,
"defaultFilter": "string",
"defaultFilterScope": "ORG_UNIT",
"defaultFilterSettings": false,
"extensionFile": "string",
"extractTerms": false,
"parameters": {},
"parserFilter": "string",
"projectResourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationFileUrl": "string",
"segmentationParams": {},
"tagRegex": "string",
"termsParams": {}
},
"parentName": "string",
"parentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"path": "string",
"preSignedUrl": "string",
"processingErrorMessage": "string",
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationParams": {},
"sourceLocale": "string",
"targetLocales": [
"string"
],
"type": "FOLDER",
"url": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workflows": [
"string"
],
"zipProcessingTaskId": "string"
}POST/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip
Extract ZIP Resource
Requires: PROJECT_RESOURCE_create
Unpacks a .zip resource whose contents were uploaded with Upload Project Resource Content, which stores a ZIP as one file and does not extract it. Each file inside becomes a resource of the project, with its folders kept in path; create the work units for those resources, not for the .zip.
The extraction runs in the background: the call returns a task id to follow with Get ZIP Extraction Status.
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
Responses
200 The task id of the extraction.
stringtext/plain
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
"0f6d2a8e-5b1c-4e7a-9d3f-2c8b6a1e4f90"GET/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip/status/{taskId}
Get ZIP Extraction Status
Requires: PROJECT_RESOURCE_create
The progress of an extraction started with Extract ZIP Resource. status is IN_PROGRESS until it ends COMPLETED, ERROR or CANCELLED. Once COMPLETED, processedProjectResources lists the resources created from the ZIP; an entry with isProcessedSuccessfully: false was not added to the project.
The status is kept for 10 minutes after its last change. An unknown or expired task id answers 200 with status: ERROR and a message.
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
taskIdrequired |
string |
Responses
200 The status of the extraction.
bytesProcessed |
integer (int64) |
failedEntries |
integer |
message |
string |
processedEntries |
integer |
processedProjectResources |
ProjectResourceDto[] |
status |
string |
taskId |
string |
totalEntries |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip/status/{taskId}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"bytesProcessed": 0,
"failedEntries": 0,
"message": "string",
"processedEntries": 0,
"processedProjectResources": [
{}
],
"status": "string",
"taskId": "string",
"totalEntries": 0
}DELETE/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip/status/{taskId}
Cancel ZIP Extraction
Requires: PROJECT_RESOURCE_create
Stops an extraction that is IN_PROGRESS: no further file of the ZIP is added. Files already extracted stay in the project. A task that has already ended is left as it is.
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
taskIdrequired |
string |
Responses
200 OK
Request
curl -X DELETE 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip/status/{taskId}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"GET/api/v3/project/{projectUUID}/resource/simple
Get Project Resources
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Responses
200 OK
creation |
integer (int64) |
defaultFilterSettings |
boolean |
hash |
string |
isProcessedSuccessfully |
boolean |
name |
string |
notes |
string |
params |
FileParams |
parentName |
string |
parentUuid |
string (uuid) |
path |
string |
preSignedUrl |
string |
processingErrorMessage |
string |
projectUuid |
string (uuid) |
segmentationParams |
map<string, object> |
sourceLocale |
string |
targetLocales |
string[] |
type |
stringFOLDER FILE |
url |
string |
uuid |
string (uuid) |
workflows |
string[] |
zipProcessingTaskId |
string |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/resource/simple' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"creation": 0,
"defaultFilterSettings": false,
"hash": "string",
"isProcessedSuccessfully": false,
"name": "string",
"notes": "string",
"params": {},
"parentName": "string",
"parentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"path": "string",
"preSignedUrl": "string",
"processingErrorMessage": "string",
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationParams": {},
"sourceLocale": "string",
"targetLocales": [],
"type": "FOLDER",
"url": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workflows": [],
"zipProcessingTaskId": "string"
}
]Work Units
GET/api/v3/project/{projectUUID}/work-unit
List Project Work Units
Requires: PROJECT_get_by_id
Lists the project's work units, 50 per page unless size says otherwise.
Each work unit in the list carries only uuid, filename, projectResource, sourceLanguage, targetLanguage, workflow, workflowUuid, workStatus, orgUnitId, isSplit and readOnly. Fields without a value are left out. Get Project Work Unit returns one work unit with its progress, task, word counts and cost.
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
uuids |
string (uuid)[] |
targetLanguages |
string[] |
taskStatus |
string[] |
filenames |
string[] |
workflows |
string[] |
filepaths |
string[] |
projectResourceUuids |
string (uuid)[] |
genesisCreationStatus |
stringCREATING FAILED CREATED |
status |
stringNEW CREATED IN_PROGRESS COMPLETED APPROVED REJECTED DELIVERED CANCELLED FAILED |
fileName |
string |
sourceLanguage |
string |
targetLanguage |
string |
createdAtFrom |
integer (int64) |
createdAtTo |
integer (int64) |
dueDateFrom |
integer (int64) |
dueDateTo |
integer (int64) |
deliveryDateFrom |
integer (int64) |
deliveryDateTo |
integer (int64) |
assigneeQuery |
string |
sourceQuery |
string |
targetQuery |
string |
entryStatuses |
string[] |
workPackageStatuses |
string[] |
sort |
string |
page |
integerPage to return, starting at 0. |
size |
integerItems per page. |
Responses
200 OK
content |
WorkUnitDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer |
numberOfElements |
integer |
pageable |
PageableObject |
size |
integer |
sort |
SortObject |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}POST/api/v3/project/{projectUUID}/work-unit
Create Work Units
Requires: PROJECT_update
Without bulk=true this path searches the project's work units instead; use List Project Work Units for that.
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
bulkrequired |
booleantrueMust be true. |
Request body
accountUuid |
string (uuid) |
documentUuid |
string (uuid) |
entityWorkflows |
Workflow[] |
messageUuid |
string (uuid) |
projectResourceUuid |
string (uuid) |
targetLocales |
string[] |
workUnitAutomation |
boolean |
workflowSequences |
map<string, integer> |
workflows |
string[] |
Responses
200 OK
assignee |
UserRef |
baseUnitCost |
number (double) |
characters |
integer |
confirmedNonTranslatable |
integer |
confirmedSegments |
integer |
connectorStatus |
string |
connectorStatusReason |
string |
contentIsEmpty |
boolean |
cost |
number |
createdOnGenesis |
boolean |
creationTimestamp |
integer (int64) |
deliveryDate |
integer (int64) |
downloadTranslatedFileEnabled |
boolean |
dueDate |
integer (int64) |
filename |
string |
genesisCreationDescription |
string |
genesisCreationStatus |
stringCREATING FAILED CREATEDWhether the work unit's content is ready in the editor. |
hasDeliverable |
boolean |
hasMismatchTag |
boolean |
hasXsltPreview |
boolean |
hours |
integer |
isSplit |
boolean |
lastUpdate |
integer (int64) |
minutes |
integer |
name |
string |
netWords |
integer (int64) |
orgUnitId |
string (uuid) |
pages |
integer |
partiallyDelivered |
boolean |
projectResource |
ProjectResourceDto |
projectUUID |
string (uuid) |
readOnly |
boolean |
relatedObjectId |
string |
savings |
number (double) |
segments |
integer |
sequence |
integer |
slices |
WorkUnitSlice[] |
sourceLanguage |
string |
targetLanguage |
string |
taskStatus |
stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED |
totalNonTranslatable |
integer |
totalSegments |
integer |
uuid |
string (uuid) |
words |
integer (int64) |
workId |
string (uuid) |
workPackageStatus |
stringDELIVERED FAILEDFor a work unit delivered through a work package: shown only once it is delivered or failed. |
workPackageStatusReason |
string |
workStatus |
stringNEW CREATED IN_PROGRESS COMPLETED APPROVED REJECTED DELIVERED CANCELLED FAILED |
workflow |
string |
workflowSequence |
integer |
workflowUuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit?bulk=true' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '[
{
"documentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityWorkflows": [],
"messageUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"projectResourceUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"targetLocales": [],
"workUnitAutomation": false,
"workflowSequences": {},
"workflows": []
}
]'Response 200
[
{
"assignee": {},
"baseUnitCost": 0,
"characters": 0,
"confirmedNonTranslatable": 0,
"confirmedSegments": 0,
"connectorStatus": "string",
"connectorStatusReason": "string",
"contentIsEmpty": false,
"cost": 0,
"createdOnGenesis": false,
"creationTimestamp": 0,
"deliveryDate": 0,
"downloadTranslatedFileEnabled": false,
"dueDate": 0,
"filename": "string",
"genesisCreationDescription": "string",
"genesisCreationStatus": "CREATING",
"hasDeliverable": false,
"hasMismatchTag": false,
"hasXsltPreview": false,
"hours": 0,
"isSplit": false,
"lastUpdate": 0,
"minutes": 0,
"name": "string",
"netWords": 0,
"orgUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pages": 0,
"partiallyDelivered": false,
"projectResource": {},
"projectUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"readOnly": false,
"relatedObjectId": "string",
"savings": 0,
"segments": 0,
"sequence": 0,
"slices": [],
"sourceLanguage": "string",
"targetLanguage": "string",
"taskStatus": "CANCELLED",
"totalNonTranslatable": 0,
"totalSegments": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"words": 0,
"workId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workPackageStatus": "DELIVERED",
"workPackageStatusReason": "string",
"workStatus": "NEW",
"workflow": "string",
"workflowSequence": 0,
"workflowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]GET/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}
Get Project Work Unit
Requires: PROJECT_get_by_id
Returns one work unit of the project, with its progress (confirmedSegments out of totalSegments), workStatus, its task's taskStatus, assignee, dueDate and deliveryDate, its word counts and its cost. Fields without a value are left out.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
Responses
200 OK
assignee |
UserRef |
baseUnitCost |
number (double) |
characters |
integer |
confirmedNonTranslatable |
integer |
confirmedSegments |
integer |
connectorStatus |
string |
connectorStatusReason |
string |
contentIsEmpty |
boolean |
cost |
number |
createdOnGenesis |
boolean |
creationTimestamp |
integer (int64) |
deliveryDate |
integer (int64) |
downloadTranslatedFileEnabled |
boolean |
dueDate |
integer (int64) |
filename |
string |
genesisCreationDescription |
string |
genesisCreationStatus |
stringCREATING FAILED CREATEDWhether the work unit's content is ready in the editor. |
hasDeliverable |
boolean |
hasMismatchTag |
boolean |
hasXsltPreview |
boolean |
hours |
integer |
isSplit |
boolean |
lastUpdate |
integer (int64) |
minutes |
integer |
name |
string |
netWords |
integer (int64) |
orgUnitId |
string (uuid) |
pages |
integer |
partiallyDelivered |
boolean |
projectResource |
ProjectResourceDto |
projectUUID |
string (uuid) |
readOnly |
boolean |
relatedObjectId |
string |
savings |
number (double) |
segments |
integer |
sequence |
integer |
slices |
WorkUnitSlice[] |
sourceLanguage |
string |
targetLanguage |
string |
taskStatus |
stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED |
totalNonTranslatable |
integer |
totalSegments |
integer |
uuid |
string (uuid) |
words |
integer (int64) |
workId |
string (uuid) |
workPackageStatus |
stringDELIVERED FAILEDFor a work unit delivered through a work package: shown only once it is delivered or failed. |
workPackageStatusReason |
string |
workStatus |
stringNEW CREATED IN_PROGRESS COMPLETED APPROVED REJECTED DELIVERED CANCELLED FAILED |
workflow |
string |
workflowSequence |
integer |
workflowUuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"assignee": {
"avatar": "string",
"currency": "string",
"email": "string",
"id": 0,
"name": "string",
"status": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"baseUnitCost": 0,
"characters": 0,
"confirmedNonTranslatable": 0,
"confirmedSegments": 0,
"connectorStatus": "string",
"connectorStatusReason": "string",
"contentIsEmpty": false,
"cost": 0,
"createdOnGenesis": false,
"creationTimestamp": 0,
"deliveryDate": 0,
"downloadTranslatedFileEnabled": false,
"dueDate": 0,
"filename": "string",
"genesisCreationDescription": "string",
"genesisCreationStatus": "CREATING",
"hasDeliverable": false,
"hasMismatchTag": false,
"hasXsltPreview": false,
"hours": 0,
"isSplit": false,
"lastUpdate": 0,
"minutes": 0,
"name": "string",
"netWords": 0,
"orgUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pages": 0,
"partiallyDelivered": false,
"projectResource": {
"creation": 0,
"defaultFilterSettings": false,
"hash": "string",
"isProcessedSuccessfully": false,
"name": "string",
"notes": "string",
"params": {},
"parentName": "string",
"parentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"path": "string",
"preSignedUrl": "string",
"processingErrorMessage": "string",
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationParams": {},
"sourceLocale": "string",
"targetLocales": [],
"type": "FOLDER",
"url": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workflows": [],
"zipProcessingTaskId": "string"
},
"projectUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"readOnly": false,
"relatedObjectId": "string",
"savings": 0,
"segments": 0,
"sequence": 0,
"slices": [
{}
],
"sourceLanguage": "string",
"targetLanguage": "string",
"taskStatus": "CANCELLED",
"totalNonTranslatable": 0,
"totalSegments": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"words": 0,
"workId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workPackageStatus": "DELIVERED",
"workPackageStatusReason": "string",
"workStatus": "NEW",
"workflow": "string",
"workflowSequence": 0,
"workflowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}POST/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/tm-updates
Export Work Unit TM Updates
Requires: PROJECT_export_import_file
Starts one TMX export for each translation memory of the project that some workflow step writes to, and for any other one this work unit wrote to, and returns them. Each TMX holds the entries whose current translation was saved by this work unit: an entry a later work unit overwrote belongs to that work unit's export instead, so exports never need to run in order. A TMX is empty when the work unit wrote nothing to that translation memory; the job then reports 0 translation units. An empty list means the project has no translation memory to export.
Translations reach the translation memory asynchronously, whether confirmed in the editor, imported or confirmed in bulk. Each export is SCHEDULED first: a few seconds after this request it marks what is still on its way to the translation memory, waits until all of it has been written, then runs. If that takes more than two minutes, the job ends FAILED with failureReason TM_WRITES_PENDING: call this endpoint again a little later.
Poll each job with Get Work Unit TM Update. A job can be read only by the user who started it. To sync on every delivery, call this endpoint when a WORK_UNIT_STATUS_CHANGE webhook reports new_status DELIVERED, with its project_uuid and id.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
Responses
200 OK
jobId |
integer (int64)The export job. Poll it with Get Work Unit TM Update. |
status |
stringThe job's status when it was created: SCHEDULED while it waits for pending translation memory writes. |
tmName |
stringThe translation memory's name. |
tmUuid |
string (uuid)The translation memory. |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/tm-updates' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"jobId": 48213,
"status": "SCHEDULED",
"tmName": "Product UI",
"tmUuid": "3f1c2a8e-5b7d-4e2a-9c61-0d4b8e7f2a10"
}
]GET/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/tm-updates/{jobId}
Get Work Unit TM Update
Requires: PROJECT_export_import_file
Reports a job started by Export Work Unit TM Updates for this work unit. status is SCHEDULED, STARTING or STARTED while it runs, then COMPLETED or FAILED. Once COMPLETED, translationUnits says how many entries the TMX holds and downloadUrl is a signed link to it, valid for one hour after the job completed; to get a new one, export again. A job can be polled for 24 hours.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
jobIdrequired |
integer (int64) |
Responses
200 OK
downloadUrl |
stringOnly when status is COMPLETED: a signed link to the TMX file, valid for one hour after the job completed. |
failureReason |
stringOnly when status is FAILED: why the export failed. |
jobId |
integer (int64) |
status |
stringSTARTING, STARTED or SCHEDULED while the job runs, then COMPLETED or FAILED. |
tmUuid |
string (uuid)The translation memory. |
translationUnits |
integer (int64)Only when status is COMPLETED: how many translation units the TMX holds. 0 means the work unit wrote nothing to this TM. |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/tm-updates/{jobId}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"downloadUrl": "https://bucket.s3.amazonaws.com/tm-export/48213.tmx?X-Amz-Expires=3600",
"failureReason": "string",
"jobId": 48213,
"status": "COMPLETED",
"tmUuid": "3f1c2a8e-5b7d-4e2a-9c61-0d4b8e7f2a10",
"translationUnits": 312
}GET/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/translation
Download Original File
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
query parameters
isXliff |
boolean |
Responses
200 OK
deliverableFileUrl |
string |
fileName |
string |
operationId |
string |
originalFileUrl |
string |
progressElapsedMs |
integer (int64) |
progressLastHeartbeatAt |
integer (int64) |
progressMessage |
string |
progressStage |
string |
progressStartedAt |
integer (int64) |
sharedLink |
string |
sharedLinkExpiresInDays |
integer (int64) |
translatedFileCreationDate |
integer (int64) |
translatedFileUrl |
string |
translationStatus |
string |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/translation' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"deliverableFileUrl": "string",
"fileName": "string",
"operationId": "string",
"originalFileUrl": "string",
"progressElapsedMs": 0,
"progressLastHeartbeatAt": 0,
"progressMessage": "string",
"progressStage": "string",
"progressStartedAt": 0,
"sharedLink": "string",
"sharedLinkExpiresInDays": 0,
"translatedFileCreationDate": 0,
"translatedFileUrl": "string",
"translationStatus": "string"
}DELETE/api/v3/project/{projectUuid}/work-unit/bulk
Bulk Delete Work Units
Requires: PROJECT_delete_work_unit
Removes work units from a project. The project must be DRAFT or CONTINUOUS, and your permission group also needs cost calculation on the project's org unit.
path parameters
projectUuidrequired |
string (uuid) |
query parameters
resetCostdeprecated |
booleanHas no effect. Deprecated: it will be removed in the next API version. |
workUnitsrequired |
string (uuid)[]The work units to remove. |
Responses
200 OK
Request
curl -X DELETE 'https://app.wxrks.com/api/v3/project/{projectUuid}/work-unit/bulk?workUnits=<workUnits>' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Linguistic Assets
POST/api/v3/project/{projectUUID}/glossaries
Bind Glossaries to Project
Requires: PROJECT_add_glossary_settings
Each glossary must be assigned to the project's org unit; otherwise the call answers 422.
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
glossariesrequired |
string (uuid)[]Glossaries to bind. Each must be assigned to the project's org unit. |
Responses
200 OK
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/4d7b2e9c-1a6f-4c38-9e5d-0b8a3f6c2d71/glossaries?glossaries=2f8d1a6c-9e4b-4b27-8c3a-6d0e5f1b9a48' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"GET/api/v3/project/{projectUUID}/translation-memory
Get Project Translation Memories
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Responses
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-memory' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"atlasTmId": 0,
"fixTags": false,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"maxHits": 0,
"name": "string",
"penalty": 0,
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"read": false,
"settings": {},
"threshold": 0,
"tm": {},
"tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"write": false
}
]POST/api/v3/project/{projectUUID}/translation-memory
Bind TM to Project
Requires: PROJECT_update
path parameters
projectUUIDrequired |
string (uuid) |
Request body
atlasTmId |
integer (int64) |
fixTags |
boolean |
id |
string (uuid) |
maxHits |
integer |
name |
string |
penalty |
number (double) |
projectUuid |
string (uuid) |
read |
boolean |
settings |
Settings |
threshold |
number (double) |
tm |
TMDto |
tmUuid |
string (uuid) |
write |
boolean |
Responses
200 OK
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-memory' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '[
{
"atlasTmId": 0,
"fixTags": false,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"maxHits": 0,
"name": "string",
"penalty": 0,
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"read": false,
"settings": {},
"threshold": 0,
"tm": {},
"tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"write": false
}
]'Reference Files
POST/api/v3/project/{projectUUID}/reference-file
Upload Reference File
Requires: PROJECT_upload_reference_file
path parameters
projectUUIDrequired |
string (uuid) |
Request body
objectmultipart/form-data
Responses
200 OK
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/reference-file' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-F 'file=@./file'GET/api/v3/project/{projectUuid}/reference-files/download
Download All Reference Files
Requires: PROJECT_download_reference_file
path parameters
projectUuidrequired |
string (uuid) |
Responses
200 OK
string (byte)[]
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUuid}/reference-files/download' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
"string"
]Notes
GET/api/v3/project/{projectUUID}/message
List Simple Notes
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
page |
integer |
pageSize |
integer |
Responses
200 OK
content |
ProjectMessageDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer |
numberOfElements |
integer |
pageable |
PageableObject |
size |
integer |
sort |
SortObject |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/message' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}POST/api/v3/project/{projectUUID}/message
Create Simple Note
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Request body
parent |
string (uuid) |
privateMessage |
boolean |
text |
string |
Responses
201 Created
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/message' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"privateMessage": false,
"text": "string"
}'Segments and Quality
GET/api/v3/project/{projectUuid}/quality-summary
Get Project Quality Summary
Requires: PROJECT_get_by_id
path parameters
projectUuidrequired |
string (uuid) |
query parameters
workUnitUuid |
string (uuid) |
stepLevel |
integer |
Responses
200 OK
confidenceScore |
number |
issuesByType |
IssueTotal[] |
scoredSegments |
integer (int64) |
smellsByCategory |
SmellCategory[] |
totalSegments |
integer (int64) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUuid}/quality-summary' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"confidenceScore": 0,
"issuesByType": [
{}
],
"scoredSegments": 0,
"smellsByCategory": [
{}
],
"totalSegments": 0
}GET/api/v3/project/{projectUuid}/segments
List Project Segments
Requires: PROJECT_get_by_id
path parameters
projectUuidrequired |
string (uuid) |
query parameters
workUnitUuid |
string (uuid) |
stepLevel |
integer |
includeFindings |
boolean |
page |
integer |
pageSize |
integer |
Responses
200 OK
PagedResponseProjectSegmentDto
content |
ProjectSegmentDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
offset |
integer (int64) |
pageNumber |
integer |
pageSize |
integer |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUuid}/segments' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}GET/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/comments
List Work Unit Comments
Requires: EDITOR_open_editor
The comments on the work unit's segments, oldest first, as the editor's comments panel shows them. Comments belong to a segment's position in the file (fileIndex), so every workflow step of the file shares them; segmentId is this work unit's segment at that position. A reply has the parentId of the comment it answers. Other users' private comments are not included.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
query parameters
page |
integer |
size |
integer |
Responses
200 OK
content |
SegmentCommentDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer |
numberOfElements |
integer |
pageable |
PageableObject |
size |
integer |
sort |
SortObject |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/comments' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}POST/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/segments/{segmentId}/comments
Create Segment Comment
Requires: EDITOR_open_editor
Adds a comment to a segment of the work unit, as the editor's comments panel does; with parentId, it answers a comment of the same segment. Users mentioned in the text as [@First Last:<user uuid>] are notified. Returns the comment.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
segmentIdrequired |
string (uuid) |
Request body
parentId |
string (uuid)Id of the comment this one answers, in the same segment's thread. |
textrequired |
stringText of the comment. Mention a user with [@First Last:<user uuid>] to notify them. |
Responses
201 Created
author |
SegmentCommentAuthor |
createdAt |
integer (int64)When the comment was written (Unix time in milliseconds). |
fileIndex |
integerPosition of the segment in the file. The same in every workflow step of the file. |
id |
string (uuid) |
parentId |
string (uuid)The comment this one answers, or null for the first comment of a thread. |
resolvedAt |
integer (int64)When the comment's thread was resolved (Unix time in milliseconds), or null while it is open. |
resolvedBy |
SegmentCommentAuthor |
segmentId |
string (uuid)The segment of this work unit the comment is on (the bwx:ts-id of the bilingual file). |
text |
string |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/segments/{segmentId}/comments' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"text": "string"
}'Response 201
{
"author": {
"name": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"createdAt": 0,
"fileIndex": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"resolvedAt": 0,
"resolvedBy": {
"name": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"segmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"text": "string"
}POST/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/segments/lock
Lock or Unlock Segments
Requires: EDITOR_lock_segments
Locks (locked: true) or unlocks (locked: false) segments of the work unit, as the editor's lock button does: locking a segment also confirms it, unlocking it also unconfirms it. Up to 1,000 segments per call; every one must belong to the work unit.
The call changes every segment in it or none. A segment that cannot take the change (it has no target, is over its hard character limit, or is already confirmed or locked in the next workflow step) fails the call with 422, which names the reasons. A segment already in the requested state is left as it is. The segments' repetitions are not changed.
Needs the Lock Segments permission on the work unit, and a work unit that can be written (for example, not cancelled, and with its previous workflow step closed). Imports skip locked segments.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
Request body
lockedrequired |
booleantrue locks the segments, false unlocks them. |
segmentIdsrequired |
string (uuid)[]Ids of segments of the work unit (the bwx:ts-id of the bilingual file), at most 1,000. |
Responses
204 No Content
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/segments/lock' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"locked": false,
"segmentIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}'Project Costs
POST/api/v3/project/{projectUUID}/async/calculate/costs
Create Cost
Requires: PROJECT_COST_calculate
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
requestId |
string |
Responses
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/async/calculate/costs' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"data": {},
"error": {},
"id": "string",
"status": "NEW"
}DELETE/api/v3/project/{projectUUID}/cost/{costUUID}
Delete Costs
Requires: PROJECT_COST_calculate
path parameters
projectUUIDrequired |
string (uuid) |
costUUIDrequired |
string (uuid) |
Responses
200 OK
Request
curl -X DELETE 'https://app.wxrks.com/api/v3/project/{projectUUID}/cost/{costUUID}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"GET/api/v3/project/{projectUUID}/cost/manual-cost
List Manual Costs
Requires: PROJECT_COST_calculate
path parameters
projectUUIDrequired |
string (uuid) |
Responses
200 OK
costPerUnit |
number |
costType |
stringTRANSLATIONS FILE_ENGINEERING QA NONE |
costsLogfileId |
string (uuid) |
creationTimestamp |
integer (int64) |
description |
string |
displayOrder |
integer |
filename |
string |
id |
integer (int64) |
matchEnd |
integer |
matchStart |
integer |
noPriceList |
boolean |
rateType |
stringPERCENTAGE NOMINAL |
reason |
string |
sourceLanguage |
string |
targetLanguage |
string |
total |
number (double) |
unitType |
stringWORD PAGE MINUTE HOUR DAY FEE DISCOUNT |
units |
number |
uuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/cost/manual-cost' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"costPerUnit": 0,
"costType": "TRANSLATIONS",
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"creationTimestamp": 0,
"description": "string",
"displayOrder": 0,
"filename": "string",
"id": 0,
"matchEnd": 0,
"matchStart": 0,
"noPriceList": false,
"rateType": "PERCENTAGE",
"reason": "string",
"sourceLanguage": "string",
"targetLanguage": "string",
"total": 0,
"unitType": "WORD",
"units": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]POST/api/v3/project/{projectUUID}/cost/manual-cost
Add Costs Manually
Requires: PROJECT_COST_calculate
path parameters
projectUUIDrequired |
string (uuid) |
Request body
costPerUnit |
number |
costType |
stringTRANSLATIONS FILE_ENGINEERING QA NONE |
costsLogfileId |
string (uuid) |
creationTimestamp |
integer (int64) |
description |
string |
displayOrder |
integer |
filename |
string |
id |
integer (int64) |
matchEnd |
integer |
matchStart |
integer |
noPriceList |
boolean |
rateType |
stringPERCENTAGE NOMINAL |
reason |
string |
sourceLanguage |
string |
targetLanguage |
string |
total |
number (double) |
unitType |
stringWORD PAGE MINUTE HOUR DAY FEE DISCOUNT |
units |
number |
uuid |
string (uuid) |
Responses
202 Accepted
costPerUnit |
number |
costType |
stringTRANSLATIONS FILE_ENGINEERING QA NONE |
costsLogfileId |
string (uuid) |
creationTimestamp |
integer (int64) |
description |
string |
displayOrder |
integer |
filename |
string |
id |
integer (int64) |
matchEnd |
integer |
matchStart |
integer |
noPriceList |
boolean |
rateType |
stringPERCENTAGE NOMINAL |
reason |
string |
sourceLanguage |
string |
targetLanguage |
string |
total |
number (double) |
unitType |
stringWORD PAGE MINUTE HOUR DAY FEE DISCOUNT |
units |
number |
uuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/cost/manual-cost' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"costPerUnit": 0,
"costType": "TRANSLATIONS",
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"creationTimestamp": 0,
"description": "string",
"displayOrder": 0,
"filename": "string",
"id": 0,
"matchEnd": 0,
"matchStart": 0,
"noPriceList": false,
"rateType": "PERCENTAGE",
"reason": "string",
"sourceLanguage": "string",
"targetLanguage": "string",
"total": 0,
"unitType": "WORD",
"units": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'Response 202
{
"costPerUnit": 0,
"costType": "TRANSLATIONS",
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"creationTimestamp": 0,
"description": "string",
"displayOrder": 0,
"filename": "string",
"id": 0,
"matchEnd": 0,
"matchStart": 0,
"noPriceList": false,
"rateType": "PERCENTAGE",
"reason": "string",
"sourceLanguage": "string",
"targetLanguage": "string",
"total": 0,
"unitType": "WORD",
"units": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}GET/api/v3/project/{projectUUID}/cost/priceTypes
Costs Price Types
Requires: PROJECT_COST_calculate
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
byLanguagerequired |
boolean |
Responses
200 OK
description |
string |
id |
integer (int64) |
matches |
PriceTypeMatchRange[] |
priceUnit |
stringWORD PAGE MINUTE HOUR DAY FEE |
rateType |
stringPERCENT FIXED_RATE |
type |
stringTRANSLATIONS FILE_ENGINEERING QA NONE |
uuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/cost/priceTypes?byLanguage=<byLanguage>' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"description": "string",
"id": 0,
"matches": [],
"priceUnit": "WORD",
"rateType": "PERCENT",
"type": "TRANSLATIONS",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]GET/api/v3/project/{projectUUID}/costs-summary
Costs Summary
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Responses
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/costs-summary' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"langPairCosts": [
{}
],
"totalCost": 0
}GET/api/v3/project/{projectUUID}/costs/lang-pair
Costs to Language Pair
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
sourceLangrequired |
string |
targetLangrequired |
string |
Responses
200 OK
costPerItem |
number (double) |
displayOrder |
integer |
isManualCost |
boolean |
matchType |
string |
totalCost |
number (double) |
uuid |
string (uuid) |
words |
number (double) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/costs/lang-pair?sourceLang=<sourceLang>&targetLang=<targetLang>' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
{
"costPerItem": 0,
"displayOrder": 0,
"isManualCost": false,
"matchType": "string",
"totalCost": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"words": 0
}
]GET/api/v3/project/{projectUUID}/profitability
Profitability
Requires: PROJECT_COST_profitability_margin
path parameters
projectUUIDrequired |
string (uuid) |
Responses
200 OK
pmRatesDetails |
TimesheetPayableDetail[] |
profitability |
number |
profitabilityWithPmRates |
number |
totalCost |
number |
totalCostTasks |
number |
totalCostWithPmRates |
number |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/profitability' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"pmRatesDetails": [
{}
],
"profitability": 0,
"profitabilityWithPmRates": 0,
"totalCost": 0,
"totalCostTasks": 0,
"totalCostWithPmRates": 0
}POST/api/v3/project/{projectUUID}/recalculate/costs
Costs Recalculate
Requires: PROJECT_COST_calculate
Only for projects in Draft status; any other status answers 422.
path parameters
projectUUIDrequired |
string (uuid)A project in Draft status. |
query parameters
requestId |
stringLeave it out to start a recalculation; send the id it answered to read its status. |
Responses
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/4d7b2e9c-1a6f-4c38-9e5d-0b8a3f6c2d71/recalculate/costs' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"data": {},
"error": {},
"id": "string",
"status": "NEW"
}GET/api/v3/project/{projectUUID}/total-costs
Total Costs
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Responses
200 OK
confidenceSavings |
number |
costInfoDtoList |
CostInfoDto[] |
grossCost |
number |
minimumFeeApplied |
boolean |
netCost |
number |
totalCalculatedCost |
number (double) |
totalSavings |
number |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/total-costs' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"confidenceSavings": 0,
"costInfoDtoList": [
{}
],
"grossCost": 0,
"minimumFeeApplied": false,
"netCost": 0,
"totalCalculatedCost": 0,
"totalSavings": 0
}Downloads
GET/api/v3/project/{projectUUID}/download
Download Project Translations
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
resources |
string (uuid)[] |
locales |
string[] |
filenames |
string[] |
projectStatus |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
updateDataTransformation |
boolean |
retrieveLatestDeliveredWorkflow |
boolean |
dataTransformationParamsMap |
string |
Responses
200 OK
string (byte)[]
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/download' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
"string"
]POST/api/v3/project/{projectUUID}/download
Download Project Translations Async
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
Request body
dataTransformationParamsMap |
string |
filenames |
string[] |
locales |
string[] |
projectStatus |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
resources |
string (uuid)[] |
retrieveLatestDeliveredWorkflow |
boolean |
updateDataTransformation |
boolean |
Responses
200 OK
downloadUrl |
string |
error |
string |
requestUuid |
string (uuid) |
status |
string |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/download' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"dataTransformationParamsMap": "string",
"filenames": [
"string"
],
"locales": [
"string"
],
"projectStatus": "DELETED",
"resources": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"retrieveLatestDeliveredWorkflow": false,
"updateDataTransformation": false
}'Response 200
{
"downloadUrl": "string",
"error": "string",
"requestUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string"
}GET/api/v3/project/{projectUUID}/download/{requestUUID}/status
Download Project Translations Async Status
Requires: PROJECT_get_by_id
path parameters
projectUUIDrequired |
string (uuid) |
requestUUIDrequired |
string (uuid) |
Responses
200 OK
downloadUrl |
string |
error |
string |
requestUuid |
string (uuid) |
status |
string |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/download/{requestUUID}/status' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"downloadUrl": "string",
"error": "string",
"requestUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string"
}GET/api/v3/project/{projectUUID}/translated-file/download
Download Project Translations (Non-Zip)
Requires: PROJECT_get_by_id
Send either workUnitUUID, or resourceUUID together with targetLanguage, never both. Any other combination answers 422.
path parameters
projectUUIDrequired |
string (uuid) |
query parameters
workUnitUUID |
string (uuid)Work unit whose translated file to download. Don't combine with resourceUUID or targetLanguage. |
resourceUUID |
string (uuid)Source file (resource) whose translation to download; requires targetLanguage. |
targetLanguage |
stringTarget language of the translation; requires resourceUUID. |
retrieveLatestDeliveredWorkflow |
boolean |
Responses
200 OK
fileName |
string |
translatedFileUrl |
string |
workUnitUuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/4d7b2e9c-1a6f-4c38-9e5d-0b8a3f6c2d71/translated-file/download' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"fileName": "string",
"translatedFileUrl": "string",
"workUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}Translation Kit Jobs / Source Files
GET/api/v3/project/{projectUUID}/translation-kit-job/{translationKitJobUUID}
Check Translation Kit Job Status
Requires one of: PROJECT_download_files PROJECT_export_import_file
Reports a job started by an export, translated files, source files or bulk import request. status is STARTING while the job runs, then COMPLETED or FAILED. When a job that builds a file has completed, download it from downloadFileUrl, or from sharedLink when the job was started with sharedLinkExpiresInDays.
path parameters
projectUUIDrequired |
string (uuid) |
translationKitJobUUIDrequired |
string (uuid) |
Responses
200 OK
completedFiles |
integer |
creationDate |
integer (int64) |
downloadFileUrl |
stringTemporary URL of the file the job built, once it has completed. Left out when the job has a sharedLink. |
downloadFileUrlExpiresAt |
integer (int64) |
endTime |
integer (int64) |
id |
string (uuid) |
isTransient |
boolean |
projectId |
string (uuid) |
sharedLink |
stringLink that downloads the file without authentication (see Resolve Shared Link), when the job was started with sharedLinkExpiresInDays. |
sharedLinkExpiresInDays |
integer (int64) |
startTime |
integer (int64) |
status |
stringSTARTING COMPLETED FAILEDSTARTING while the job runs, then COMPLETED or FAILED. |
totalFiles |
integer |
type |
stringEXPORT_XLIFF IMPORT_XLIFF EXPORT_XLSX IMPORT_XLSX LOC_KIT TRANSLATED_FILES SOURCE_FILESWhat the job does. Jobs report LOC_KIT (export kit), TRANSLATED_FILES, SOURCE_FILES, IMPORT_XLIFF or IMPORT_XLSX (bulk import); EXPORT_XLIFF and EXPORT_XLSX are not used. |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/{translationKitJobUUID}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"completedFiles": 0,
"creationDate": 0,
"downloadFileUrl": "string",
"downloadFileUrlExpiresAt": 0,
"endTime": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isTransient": false,
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLink": "string",
"sharedLinkExpiresInDays": 0,
"startTime": 0,
"status": "STARTING",
"totalFiles": 0,
"type": "EXPORT_XLIFF"
}POST/api/v3/project/{projectUUID}/translation-kit-job/source-files
Bulk Source Files
Requires: PROJECT_download_files
Starts a job that builds a ZIP with the original source files of the work units in workUnitUuids, or of the whole project when the list is empty (a vendor always gets the files of their own assigned work units). Returns a job: poll Check Translation Kit Job Status until status is COMPLETED, then download the ZIP.
path parameters
projectUUIDrequired |
string (uuid) |
Request body
addSourceAndTargetSuffix |
boolean |
downloadDeliverables |
boolean |
fontMappings |
BwxFontMappings[] |
hideOriginColumn |
booleanExport kits with locKitTypeJob: XLSX only: hide the Origin column of the XLSX. The column stays in the sheet, so the file can still be imported. |
includeComments |
booleanExport kits with locKitTypeJob XLSX or ALL only: add the Segment Comments column, with every public comment of each segment. Defaults to false. |
intermediateFile |
boolean |
locKitTypeJob |
stringALL XLIFF TMX TBX XLSXExport kits only: what the kit holds. ALL (the default) builds XLIFF, XLSX, TMX and TBX files; XLIFF builds only the bilingual XLIFF files. |
projectId |
string (uuid)Ignored: the project comes from the path. |
sharedLinkExpiresInDays |
integer (int64)1 7 30Also create a link that downloads the result without authentication, valid for this many days. The job then returns sharedLink instead of downloadFileUrl. |
updateDataTransformation |
boolean |
workUnitUuids |
string (uuid)[]The work units to include, all at the same workflow step. Export kits and translated files need it unless workflowLevel is set; source files take the whole project when it is empty. A vendor always gets their own assigned work units. |
workflowLevel |
integerEvery work unit at this workflow step. Export kits and translated files need it or workUnitUuids. Ignored for vendors and for source files. |
workflowUuid |
string (uuid)Every work unit of this workflow. Takes precedence over workflowLevel and workUnitUuids, but export kits and translated files still need one of those. Ignored for vendors. |
Responses
200 OK
completedFiles |
integer |
creationDate |
integer (int64) |
downloadFileUrl |
stringTemporary URL of the file the job built, once it has completed. Left out when the job has a sharedLink. |
downloadFileUrlExpiresAt |
integer (int64) |
endTime |
integer (int64) |
id |
string (uuid) |
isTransient |
boolean |
projectId |
string (uuid) |
sharedLink |
stringLink that downloads the file without authentication (see Resolve Shared Link), when the job was started with sharedLinkExpiresInDays. |
sharedLinkExpiresInDays |
integer (int64) |
startTime |
integer (int64) |
status |
stringSTARTING COMPLETED FAILEDSTARTING while the job runs, then COMPLETED or FAILED. |
totalFiles |
integer |
type |
stringEXPORT_XLIFF IMPORT_XLIFF EXPORT_XLSX IMPORT_XLSX LOC_KIT TRANSLATED_FILES SOURCE_FILESWhat the job does. Jobs report LOC_KIT (export kit), TRANSLATED_FILES, SOURCE_FILES, IMPORT_XLIFF or IMPORT_XLSX (bulk import); EXPORT_XLIFF and EXPORT_XLSX are not used. |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/source-files' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"addSourceAndTargetSuffix": false,
"downloadDeliverables": false,
"fontMappings": [],
"hideOriginColumn": false,
"includeComments": false,
"intermediateFile": false,
"locKitTypeJob": "ALL",
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLinkExpiresInDays": 1,
"updateDataTransformation": false,
"workUnitUuids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"workflowLevel": 0,
"workflowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'Response 200
{
"completedFiles": 0,
"creationDate": 0,
"downloadFileUrl": "string",
"downloadFileUrlExpiresAt": 0,
"endTime": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isTransient": false,
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLink": "string",
"sharedLinkExpiresInDays": 0,
"startTime": 0,
"status": "STARTING",
"totalFiles": 0,
"type": "EXPORT_XLIFF"
}Translation Kit Jobs / Import Kits
GETCheck Translation Kit Job Status is described in Translation Kit Jobs / Source Files.
POST/api/v3/project/{projectUUID}/translation-kit-job/resource
Create Import Kit Resource
Requires: PROJECT_export_import_file
First step of an import: registers the file you are about to upload. name must end in a supported file extension; only name, path and notes are read. Use the returned uuid in Get Import Kit Upload URL and in the import request.
path parameters
projectUUIDrequired |
string (uuid) |
Request body
name |
string |
notes |
string |
path |
string |
previewUrl |
string |
tags |
string |
targetLocales |
string[] |
Responses
200 OK
creation |
integer (int64) |
defaultFilterSettings |
boolean |
hash |
string |
isProcessedSuccessfully |
boolean |
name |
string |
notes |
string |
params |
FileParams |
parentName |
string |
parentUuid |
string (uuid) |
path |
string |
preSignedUrl |
string |
processingErrorMessage |
string |
projectUuid |
string (uuid) |
segmentationParams |
map<string, object> |
sourceLocale |
string |
targetLocales |
string[] |
type |
stringFOLDER FILE |
url |
string |
uuid |
string (uuid) |
workflows |
string[] |
zipProcessingTaskId |
string |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/resource' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"notes": "string",
"path": "string",
"previewUrl": "string",
"tags": "string",
"targetLocales": [
"string"
]
}'Response 200
{
"creation": 0,
"defaultFilterSettings": false,
"hash": "string",
"isProcessedSuccessfully": false,
"name": "string",
"notes": "string",
"params": {
"applyAll": false,
"applySourceSegmentation": false,
"defaultFilter": "string",
"defaultFilterScope": "ORG_UNIT",
"defaultFilterSettings": false,
"extensionFile": "string",
"extractTerms": false,
"parameters": {},
"parserFilter": "string",
"projectResourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationFileUrl": "string",
"segmentationParams": {},
"tagRegex": "string",
"termsParams": {}
},
"parentName": "string",
"parentUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"path": "string",
"preSignedUrl": "string",
"processingErrorMessage": "string",
"projectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"segmentationParams": {},
"sourceLocale": "string",
"targetLocales": [
"string"
],
"type": "FOLDER",
"url": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workflows": [
"string"
],
"zipProcessingTaskId": "string"
}POST/api/v3/project/{projectUUID}/translation-kit-job/resource/{projectResourceUUID}
Get Import Kit Upload URL
Requires: PROJECT_export_import_file
Returns a pre-signed URL to upload the resource's file to. Send the raw file with an HTTP PUT to url within 60 minutes (until urlExpiresAt), with the headers in headers, which are part of the signature:
x-amz-server-side-encryption: aws:kmsx-amz-server-side-encryption-aws-kms-key-id: thekmsKeyof this response
curl -X PUT "$URL" \
-H "x-amz-server-side-encryption: aws:kms" \
-H "x-amz-server-side-encryption-aws-kms-key-id: $KMS_KEY" \
--data-binary @file.xlfThen start the import (Import Kit to Work Unit or Bulk Import Kit). expiryDate is not when the URL expires. To skip this step, upload and import in one call with Import File to Work Unit.
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
Responses
200 OK
expiryDate |
stringA date five days ahead ( yyyy-MM-dd), kept for compatibility. Not when the URL expires: see urlExpiresAt. |
headers |
map<string, string>Headers to send with the upload. They are part of the URL's signature. |
kmsKey |
stringEncryption key id: send it in the x-amz-server-side-encryption-aws-kms-key-id header of the upload, with x-amz-server-side-encryption: aws:kms. |
url |
stringPre-signed URL to PUT the file to. Valid for 60 minutes, until urlExpiresAt. |
urlExpiresAt |
stringWhen the URL stops accepting uploads (ISO-8601 instant, UTC). |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/resource/{projectResourceUUID}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"expiryDate": "string",
"headers": {},
"kmsKey": "string",
"url": "string",
"urlExpiresAt": "string"
}POST/api/v3/project/{projectUUID}/translation-kit-job/resource/{projectResourceUUID}/bulk-import
Bulk Import Kit
Requires: PROJECT_export_import_file
Imports a ZIP of bilingual files (for example an edited export kit) into the project's work units in one job. Upload the ZIP first (Create Import Kit Resource, then Get Import Kit Upload URL). workUnitUuids limits the import to those work units.
Returns a job to poll with Check Translation Kit Job Status. The job reports the run as a whole; Check Work Unit Import Status shows each work unit's own result. The flags and their effects are the same as in Import Kit to Work Unit. With applyStatusFromFile, locks change in the work units on which you have Lock Segments: those listed in workUnitUuids, or any of the project without a list.
path parameters
projectUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
Request body
applyStatusFromFile |
booleanXLIFF only: apply each unit's bwx:locked, bwx:confirmed and notes to its segment (lock and unlock, confirm and unconfirm, notes added as comments). A unit without bwx:confirmed follows the confirmation flags. Locks change only with the Lock Segments permission on the work unit. |
confirmAllNotEmpty |
booleanConfirm every segment with a non-empty target, changed or not. |
confirmOnlyChangeSegments |
booleanWrite only the segments whose text changed, and confirm them. |
importTyperequired |
stringXLIFF XLSXFormat of the imported file. |
updateTm |
booleanAdd the confirmed segments this import writes to the project's translation memories. |
workUnitUuids |
string (uuid)[]Import only the files of these work units. Leave empty to import every file in the kit. A vendor always imports into their own assigned work units, whatever this list says. |
Responses
200 OK
completedFiles |
integer |
creationDate |
integer (int64) |
downloadFileUrl |
stringTemporary URL of the file the job built, once it has completed. Left out when the job has a sharedLink. |
downloadFileUrlExpiresAt |
integer (int64) |
endTime |
integer (int64) |
id |
string (uuid) |
isTransient |
boolean |
projectId |
string (uuid) |
sharedLink |
stringLink that downloads the file without authentication (see Resolve Shared Link), when the job was started with sharedLinkExpiresInDays. |
sharedLinkExpiresInDays |
integer (int64) |
startTime |
integer (int64) |
status |
stringSTARTING COMPLETED FAILEDSTARTING while the job runs, then COMPLETED or FAILED. |
totalFiles |
integer |
type |
stringEXPORT_XLIFF IMPORT_XLIFF EXPORT_XLSX IMPORT_XLSX LOC_KIT TRANSLATED_FILES SOURCE_FILESWhat the job does. Jobs report LOC_KIT (export kit), TRANSLATED_FILES, SOURCE_FILES, IMPORT_XLIFF or IMPORT_XLSX (bulk import); EXPORT_XLIFF and EXPORT_XLSX are not used. |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/resource/{projectResourceUUID}/bulk-import' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"importType": "XLIFF"
}'Response 200
{
"completedFiles": 0,
"creationDate": 0,
"downloadFileUrl": "string",
"downloadFileUrlExpiresAt": 0,
"endTime": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isTransient": false,
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLink": "string",
"sharedLinkExpiresInDays": 0,
"startTime": 0,
"status": "STARTING",
"totalFiles": 0,
"type": "EXPORT_XLIFF"
}POST/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import
Import File to Work Unit
Requires: PROJECT_export_import_file
Uploads a bilingual XLIFF or XLSX (importType) and imports it into one work unit, in one call. Send a multipart/form-data request with the file in file; the other parameters can be form fields or query parameters. An XLSX import needs an .xlsx file.
Runs asynchronously and returns the import: poll it with Get Work Unit Import. One import runs at a time in a work unit: while one runs, another is rejected with 409.
Both flags default to false:
confirmOnlyChangeSegments | confirmAllNotEmpty | Segments written | Confirmation |
|---|---|---|---|
false | false | every segment with a non-empty target | segments whose text changed become unconfirmed |
true | false | only segments whose text changed | changed segments are confirmed and get a segment review |
false | true | every segment with a non-empty target | all of them are confirmed |
true | true | only segments whose text changed | as with confirmOnlyChangeSegments alone; a segment written only because its alternative translations or back translation changed is confirmed too |
Whatever the flags:
- Locked segments, segments already decided in the next workflow step and file segments without a
bwx:ts-idare skipped, without an error. An empty target leaves the translation as it is, unless the file also carries a back translation for that segment: then the translation is cleared. - Changed segments lose their translation memory match details.
- Confirmed segments are carried to the next workflow step.
- The confirmed segments this import wrote are added to the project's translation memories, the same way confirmations in the editor are (when the project has translation memories and your permission group can update them). Send
updateTm: falseto skip this. - The work unit's progress (confirmed segments out of total segments) is recalculated.
With applyStatusFromFile: true (XLIFF only), the file also sets each segment's status from its unit's bwx:locked and bwx:confirmed (yes or no, written on every unit of an exported kit) and adds its notes as comments:
- A unit with
bwx:confirmedconfirms or unconfirms its segment, changed or not, instead of the flags above. A unit without it follows the flags. - A unit with
bwx:lockedlocks or unlocks its segment, when you have the Lock Segments permission on the work unit; without it, locks stay as they are and locked segments are skipped. Locking confirms the segment, as in the editor. To also change the text of a segment you unlock, remove the unit'stranslate="no". - Each
<note>is added as a comment of the segment, written by you; a note of someone else (from) keeps the author at the start of the text. A note whose text the segment's comments already have is skipped, so importing the same file twice adds nothing.
The import's error says why it ended in ERROR, and its counts say how many segments it wrote or changed the status of, confirmed, and skipped because they were locked or had no bwx:ts-id.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
query parameters
importTyperequired |
stringXLIFF XLSX |
confirmOnlyChangeSegments |
boolean |
confirmAllNotEmpty |
boolean |
applyStatusFromFile |
boolean |
updateTm |
boolean |
Request body
objectmultipart/form-data
Responses
200 OK
creationDate |
integer (int64)When the import was requested (Unix time in milliseconds). |
endingDate |
integer (int64)When the import ended (Unix time in milliseconds). Null while it runs. |
error |
stringWORK_UNIT_READ_ONLY WRONG_WORK_UNIT FILE_UNREADABLE NO_SEGMENTS TARGET_LANGUAGE_MISMATCH NO_SEGMENT_IDS NOTHING_UPDATED FAILEDWhy the import ended in ERROR: WORK_UNIT_READ_ONLY (the work unit is cancelled, expired, or its previous step is still open), WRONG_WORK_UNIT (the file was exported from another work unit), FILE_UNREADABLE, NO_SEGMENTS (the file has no segments), TARGET_LANGUAGE_MISMATCH (the file's target language is not the work unit's), NO_SEGMENT_IDS (no segment has a bwx:ts-id), NOTHING_UPDATED (no longer reported: a file that writes no segment, for example an unchanged one, now ends IMPORTED with segmentsUpdated 0), or FAILED (an unexpected error). Null otherwise. |
id |
string (uuid)Id of the import: poll it with Get Work Unit Import. |
importType |
stringXLIFF XLSXFormat of the imported file. |
segmentsConfirmed |
integerOf the segments written, how many are confirmed. Null while the import runs. |
segmentsInFile |
integerSegments in the file, locked ones included. Null while the import runs. |
segmentsLocked |
integerFile segments skipped because they are locked: marked locked in the file ( translate="no", bwx:locked="yes") or locked in the work unit since the file was exported. Null while the import runs. |
segmentsUpdated |
integerSegments written to the work unit. Null while the import runs. |
segmentsWithoutId |
integerFile segments without a bwx:ts-id, which were skipped. Null while the import runs. |
status |
stringSTARTED IMPORTED ERRORSTARTED while the import runs, then IMPORTED or ERROR. |
workUnitId |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import?importType=XLIFF' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-F 'file=@./file'Response 200
{
"creationDate": 0,
"endingDate": 0,
"error": "WORK_UNIT_READ_ONLY",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"importType": "XLIFF",
"segmentsConfirmed": 0,
"segmentsInFile": 0,
"segmentsLocked": 0,
"segmentsUpdated": 0,
"segmentsWithoutId": 0,
"status": "STARTED",
"workUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}GET/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import/{importId}
Get Work Unit Import
Requires: PROJECT_export_import_file
Reports one import into the work unit, by the id its import request returned: status is STARTED while it runs, then IMPORTED or ERROR with the reason in error. Once it ended, the counts say how many segments it wrote, confirmed and skipped.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
importIdrequired |
string (uuid) |
Responses
200 OK
creationDate |
integer (int64)When the import was requested (Unix time in milliseconds). |
endingDate |
integer (int64)When the import ended (Unix time in milliseconds). Null while it runs. |
error |
stringWORK_UNIT_READ_ONLY WRONG_WORK_UNIT FILE_UNREADABLE NO_SEGMENTS TARGET_LANGUAGE_MISMATCH NO_SEGMENT_IDS NOTHING_UPDATED FAILEDWhy the import ended in ERROR: WORK_UNIT_READ_ONLY (the work unit is cancelled, expired, or its previous step is still open), WRONG_WORK_UNIT (the file was exported from another work unit), FILE_UNREADABLE, NO_SEGMENTS (the file has no segments), TARGET_LANGUAGE_MISMATCH (the file's target language is not the work unit's), NO_SEGMENT_IDS (no segment has a bwx:ts-id), NOTHING_UPDATED (no longer reported: a file that writes no segment, for example an unchanged one, now ends IMPORTED with segmentsUpdated 0), or FAILED (an unexpected error). Null otherwise. |
id |
string (uuid)Id of the import: poll it with Get Work Unit Import. |
importType |
stringXLIFF XLSXFormat of the imported file. |
segmentsConfirmed |
integerOf the segments written, how many are confirmed. Null while the import runs. |
segmentsInFile |
integerSegments in the file, locked ones included. Null while the import runs. |
segmentsLocked |
integerFile segments skipped because they are locked: marked locked in the file ( translate="no", bwx:locked="yes") or locked in the work unit since the file was exported. Null while the import runs. |
segmentsUpdated |
integerSegments written to the work unit. Null while the import runs. |
segmentsWithoutId |
integerFile segments without a bwx:ts-id, which were skipped. Null while the import runs. |
status |
stringSTARTED IMPORTED ERRORSTARTED while the import runs, then IMPORTED or ERROR. |
workUnitId |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import/{importId}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"creationDate": 0,
"endingDate": 0,
"error": "WORK_UNIT_READ_ONLY",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"importType": "XLIFF",
"segmentsConfirmed": 0,
"segmentsInFile": 0,
"segmentsLocked": 0,
"segmentsUpdated": 0,
"segmentsWithoutId": 0,
"status": "STARTED",
"workUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}POST/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import/status
Check Work Unit Import Status
Requires: PROJECT_export_import_file
Reports the latest import of the given format (importType) into the work unit: importingStatus is STARTED while it runs, then IMPORTED or ERROR. There is no import id: a second import into the same work unit replaces what this reports.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
Request body
importTyperequired |
stringXLIFF XLSXFormat of the import to report on. |
Responses
200 OK
importingCreationDate |
integer (int64)Not filled: always null. |
importingEndingDate |
integer (int64)When importingStatus last changed (Unix time in milliseconds), including when the import started. |
importingStatus |
stringNOT_STARTED STARTED IMPORTED ERRORState of the latest import of this format into the work unit. |
workUnitUuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import/status' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"importType": "XLIFF"
}'Response 200
{
"importingCreationDate": null,
"importingEndingDate": 0,
"importingStatus": "NOT_STARTED",
"workUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}POST/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/resource/{projectResourceUUID}/import
Import Kit to Work Unit
Requires: PROJECT_export_import_file
Imports a bilingual XLIFF or XLSX (importType) into one work unit, from a file uploaded with Create Import Kit Resource and Get Import Kit Upload URL. To upload and import in one call, use Import File to Work Unit.
Runs asynchronously and returns the import: poll it with Get Work Unit Import. One import runs at a time in a work unit: while one runs, another is rejected with 409.
Both flags default to false:
confirmOnlyChangeSegments | confirmAllNotEmpty | Segments written | Confirmation |
|---|---|---|---|
false | false | every segment with a non-empty target | segments whose text changed become unconfirmed |
true | false | only segments whose text changed | changed segments are confirmed and get a segment review |
false | true | every segment with a non-empty target | all of them are confirmed |
true | true | only segments whose text changed | as with confirmOnlyChangeSegments alone; a segment written only because its alternative translations or back translation changed is confirmed too |
Whatever the flags:
- Locked segments, segments already decided in the next workflow step and file segments without a
bwx:ts-idare skipped, without an error. An empty target leaves the translation as it is, unless the file also carries a back translation for that segment: then the translation is cleared. - Changed segments lose their translation memory match details.
- Confirmed segments are carried to the next workflow step.
- The confirmed segments this import wrote are added to the project's translation memories, the same way confirmations in the editor are (when the project has translation memories and your permission group can update them). Send
updateTm: falseto skip this. - The work unit's progress (confirmed segments out of total segments) is recalculated.
With applyStatusFromFile: true (XLIFF only), the file also sets each segment's status from its unit's bwx:locked and bwx:confirmed (yes or no, written on every unit of an exported kit) and adds its notes as comments:
- A unit with
bwx:confirmedconfirms or unconfirms its segment, changed or not, instead of the flags above. A unit without it follows the flags. - A unit with
bwx:lockedlocks or unlocks its segment, when you have the Lock Segments permission on the work unit; without it, locks stay as they are and locked segments are skipped. Locking confirms the segment, as in the editor. To also change the text of a segment you unlock, remove the unit'stranslate="no". - Each
<note>is added as a comment of the segment, written by you; a note of someone else (from) keeps the author at the start of the text. A note whose text the segment's comments already have is skipped, so importing the same file twice adds nothing.
The import's error says why it ended in ERROR, and its counts say how many segments it wrote or changed the status of, confirmed, and skipped because they were locked or had no bwx:ts-id.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
projectResourceUUIDrequired |
string (uuid) |
Request body
applyStatusFromFile |
booleanXLIFF only: apply each unit's bwx:locked, bwx:confirmed and notes to its segment (lock and unlock, confirm and unconfirm, notes added as comments). A unit without bwx:confirmed follows the confirmation flags. Locks change only with the Lock Segments permission on the work unit. |
confirmAllNotEmpty |
booleanConfirm every segment with a non-empty target, changed or not. |
confirmOnlyChangeSegments |
booleanWrite only the segments whose text changed, and confirm them. |
importTyperequired |
stringXLIFF XLSXFormat of the imported file. |
updateTm |
booleanAdd the confirmed segments this import writes to the project's translation memories. |
Responses
200 OK
creationDate |
integer (int64)When the import was requested (Unix time in milliseconds). |
endingDate |
integer (int64)When the import ended (Unix time in milliseconds). Null while it runs. |
error |
stringWORK_UNIT_READ_ONLY WRONG_WORK_UNIT FILE_UNREADABLE NO_SEGMENTS TARGET_LANGUAGE_MISMATCH NO_SEGMENT_IDS NOTHING_UPDATED FAILEDWhy the import ended in ERROR: WORK_UNIT_READ_ONLY (the work unit is cancelled, expired, or its previous step is still open), WRONG_WORK_UNIT (the file was exported from another work unit), FILE_UNREADABLE, NO_SEGMENTS (the file has no segments), TARGET_LANGUAGE_MISMATCH (the file's target language is not the work unit's), NO_SEGMENT_IDS (no segment has a bwx:ts-id), NOTHING_UPDATED (no longer reported: a file that writes no segment, for example an unchanged one, now ends IMPORTED with segmentsUpdated 0), or FAILED (an unexpected error). Null otherwise. |
id |
string (uuid)Id of the import: poll it with Get Work Unit Import. |
importType |
stringXLIFF XLSXFormat of the imported file. |
segmentsConfirmed |
integerOf the segments written, how many are confirmed. Null while the import runs. |
segmentsInFile |
integerSegments in the file, locked ones included. Null while the import runs. |
segmentsLocked |
integerFile segments skipped because they are locked: marked locked in the file ( translate="no", bwx:locked="yes") or locked in the work unit since the file was exported. Null while the import runs. |
segmentsUpdated |
integerSegments written to the work unit. Null while the import runs. |
segmentsWithoutId |
integerFile segments without a bwx:ts-id, which were skipped. Null while the import runs. |
status |
stringSTARTED IMPORTED ERRORSTARTED while the import runs, then IMPORTED or ERROR. |
workUnitId |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/resource/{projectResourceUUID}/import' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"importType": "XLIFF"
}'Response 200
{
"creationDate": 0,
"endingDate": 0,
"error": "WORK_UNIT_READ_ONLY",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"importType": "XLIFF",
"segmentsConfirmed": 0,
"segmentsInFile": 0,
"segmentsLocked": 0,
"segmentsUpdated": 0,
"segmentsWithoutId": 0,
"status": "STARTED",
"workUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}Translation Kit Jobs / Export Kits
GETCheck Translation Kit Job Status is described in Translation Kit Jobs / Source Files.
POST/api/v3/project/{projectUUID}/translation-kit-job/loc-kit
Request Export Project
Requires: PROJECT_export_import_file
Starts an export kit: a ZIP with the bilingual files of the chosen work units. Choose them with workflowLevel (every work unit at that workflow step) or workUnitUuids (all at the same step); a vendor always gets their own assigned work units. The project comes from the path.
By default (locKitTypeJob: ALL) the kit holds XLIFF, XLSX, TMX and TBX files. For the bilingual XLIFF files only, send locKitTypeJob: XLIFF.
Returns a job: poll Check Translation Kit Job Status until status is COMPLETED, then download the ZIP.
path parameters
projectUUIDrequired |
string (uuid) |
Request body
addSourceAndTargetSuffix |
boolean |
downloadDeliverables |
boolean |
fontMappings |
BwxFontMappings[] |
hideOriginColumn |
booleanExport kits with locKitTypeJob: XLSX only: hide the Origin column of the XLSX. The column stays in the sheet, so the file can still be imported. |
includeComments |
booleanExport kits with locKitTypeJob XLSX or ALL only: add the Segment Comments column, with every public comment of each segment. Defaults to false. |
intermediateFile |
boolean |
locKitTypeJob |
stringALL XLIFF TMX TBX XLSXExport kits only: what the kit holds. ALL (the default) builds XLIFF, XLSX, TMX and TBX files; XLIFF builds only the bilingual XLIFF files. |
projectId |
string (uuid)Ignored: the project comes from the path. |
sharedLinkExpiresInDays |
integer (int64)1 7 30Also create a link that downloads the result without authentication, valid for this many days. The job then returns sharedLink instead of downloadFileUrl. |
updateDataTransformation |
boolean |
workUnitUuids |
string (uuid)[]The work units to include, all at the same workflow step. Export kits and translated files need it unless workflowLevel is set; source files take the whole project when it is empty. A vendor always gets their own assigned work units. |
workflowLevel |
integerEvery work unit at this workflow step. Export kits and translated files need it or workUnitUuids. Ignored for vendors and for source files. |
workflowUuid |
string (uuid)Every work unit of this workflow. Takes precedence over workflowLevel and workUnitUuids, but export kits and translated files still need one of those. Ignored for vendors. |
Responses
200 OK
completedFiles |
integer |
creationDate |
integer (int64) |
downloadFileUrl |
stringTemporary URL of the file the job built, once it has completed. Left out when the job has a sharedLink. |
downloadFileUrlExpiresAt |
integer (int64) |
endTime |
integer (int64) |
id |
string (uuid) |
isTransient |
boolean |
projectId |
string (uuid) |
sharedLink |
stringLink that downloads the file without authentication (see Resolve Shared Link), when the job was started with sharedLinkExpiresInDays. |
sharedLinkExpiresInDays |
integer (int64) |
startTime |
integer (int64) |
status |
stringSTARTING COMPLETED FAILEDSTARTING while the job runs, then COMPLETED or FAILED. |
totalFiles |
integer |
type |
stringEXPORT_XLIFF IMPORT_XLIFF EXPORT_XLSX IMPORT_XLSX LOC_KIT TRANSLATED_FILES SOURCE_FILESWhat the job does. Jobs report LOC_KIT (export kit), TRANSLATED_FILES, SOURCE_FILES, IMPORT_XLIFF or IMPORT_XLSX (bulk import); EXPORT_XLIFF and EXPORT_XLSX are not used. |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/loc-kit' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"addSourceAndTargetSuffix": false,
"downloadDeliverables": false,
"fontMappings": [],
"hideOriginColumn": false,
"includeComments": false,
"intermediateFile": false,
"locKitTypeJob": "ALL",
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLinkExpiresInDays": 1,
"updateDataTransformation": false,
"workUnitUuids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"workflowLevel": 0,
"workflowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'Response 200
{
"completedFiles": 0,
"creationDate": 0,
"downloadFileUrl": "string",
"downloadFileUrlExpiresAt": 0,
"endTime": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isTransient": false,
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLink": "string",
"sharedLinkExpiresInDays": 0,
"startTime": 0,
"status": "STARTING",
"totalFiles": 0,
"type": "EXPORT_XLIFF"
}GET/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/bilingual
Download Work Unit Bilingual File
Requires: PROJECT_export_import_file
Returns one work unit's bilingual XLIFF in the response, without a job: the same file an export kit holds for that work unit, ready to be edited and imported back.
Work units with more than 20,000 segments are refused with 413: export them with Request Export Project (locKitTypeJob: XLIFF) and download the kit when the job completes.
path parameters
projectUUIDrequired |
string (uuid) |
workUnitUUIDrequired |
string (uuid) |
query parameters
format |
stringXLIFFFormat of the file. Only XLIFF is supported. |
Responses
200 The XLIFF file, as an attachment.
string (binary)application/x-xliff+xml
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/bilingual' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
"<file>"Translation Kit Jobs / Translated Files
GETCheck Translation Kit Job Status is described in Translation Kit Jobs / Source Files.
GET/api/v3/project/{projectUUID}/translation-kit-job/{translationKitJobUUID}/download-links
List Translation Kit Job Download Links
Requires: PROJECT_download_files
path parameters
projectUUIDrequired |
string (uuid) |
translationKitJobUUIDrequired |
string (uuid) |
query parameters
page |
integerZero-based page index (0..N) |
size |
integerThe size of the page to be returned |
sort |
string[]Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Responses
200 OK
PageTranslationKitJobDownloadLinkDto
content |
TranslationKitJobDownloadLinkDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer |
numberOfElements |
integer |
pageable |
PageableObject |
size |
integer |
sort |
SortObject |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/{translationKitJobUUID}/download-links' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}POST/api/v3/project/{projectUUID}/translation-kit-job/translated-files
Request Project Translated Files
Requires: PROJECT_download_files
path parameters
projectUUIDrequired |
string (uuid) |
Request body
addSourceAndTargetSuffix |
boolean |
downloadDeliverables |
boolean |
fontMappings |
BwxFontMappings[] |
hideOriginColumn |
booleanExport kits with locKitTypeJob: XLSX only: hide the Origin column of the XLSX. The column stays in the sheet, so the file can still be imported. |
includeComments |
booleanExport kits with locKitTypeJob XLSX or ALL only: add the Segment Comments column, with every public comment of each segment. Defaults to false. |
intermediateFile |
boolean |
locKitTypeJob |
stringALL XLIFF TMX TBX XLSXExport kits only: what the kit holds. ALL (the default) builds XLIFF, XLSX, TMX and TBX files; XLIFF builds only the bilingual XLIFF files. |
projectId |
string (uuid)Ignored: the project comes from the path. |
sharedLinkExpiresInDays |
integer (int64)1 7 30Also create a link that downloads the result without authentication, valid for this many days. The job then returns sharedLink instead of downloadFileUrl. |
updateDataTransformation |
boolean |
workUnitUuids |
string (uuid)[]The work units to include, all at the same workflow step. Export kits and translated files need it unless workflowLevel is set; source files take the whole project when it is empty. A vendor always gets their own assigned work units. |
workflowLevel |
integerEvery work unit at this workflow step. Export kits and translated files need it or workUnitUuids. Ignored for vendors and for source files. |
workflowUuid |
string (uuid)Every work unit of this workflow. Takes precedence over workflowLevel and workUnitUuids, but export kits and translated files still need one of those. Ignored for vendors. |
Responses
200 OK
completedFiles |
integer |
creationDate |
integer (int64) |
downloadFileUrl |
stringTemporary URL of the file the job built, once it has completed. Left out when the job has a sharedLink. |
downloadFileUrlExpiresAt |
integer (int64) |
endTime |
integer (int64) |
id |
string (uuid) |
isTransient |
boolean |
projectId |
string (uuid) |
sharedLink |
stringLink that downloads the file without authentication (see Resolve Shared Link), when the job was started with sharedLinkExpiresInDays. |
sharedLinkExpiresInDays |
integer (int64) |
startTime |
integer (int64) |
status |
stringSTARTING COMPLETED FAILEDSTARTING while the job runs, then COMPLETED or FAILED. |
totalFiles |
integer |
type |
stringEXPORT_XLIFF IMPORT_XLIFF EXPORT_XLSX IMPORT_XLSX LOC_KIT TRANSLATED_FILES SOURCE_FILESWhat the job does. Jobs report LOC_KIT (export kit), TRANSLATED_FILES, SOURCE_FILES, IMPORT_XLIFF or IMPORT_XLSX (bulk import); EXPORT_XLIFF and EXPORT_XLSX are not used. |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/translation-kit-job/translated-files' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"addSourceAndTargetSuffix": false,
"downloadDeliverables": false,
"fontMappings": [],
"hideOriginColumn": false,
"includeComments": false,
"intermediateFile": false,
"locKitTypeJob": "ALL",
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLinkExpiresInDays": 1,
"updateDataTransformation": false,
"workUnitUuids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"workflowLevel": 0,
"workflowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'Response 200
{
"completedFiles": 0,
"creationDate": 0,
"downloadFileUrl": "string",
"downloadFileUrlExpiresAt": 0,
"endTime": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isTransient": false,
"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedLink": "string",
"sharedLinkExpiresInDays": 0,
"startTime": 0,
"status": "STARTING",
"totalFiles": 0,
"type": "EXPORT_XLIFF"
}Continuous Project
POST/api/v3/project/ci
Create Continuous Project
Requires: PROJECT_create
Request body
ciTag |
string |
contactUUID |
string (uuid) |
contentMode |
stringFILES KEY_VALUE |
instructions |
string |
notes |
string |
orgUnitUUID |
string (uuid) |
reference |
string |
source |
string |
tags |
string[] |
totalExpectedWorkUnits |
integer |
Responses
200 OK
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/ci' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"ciTag": "string",
"contactUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contentMode": "FILES",
"instructions": "string",
"notes": "string",
"orgUnitUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"source": "string",
"tags": [
"string"
],
"totalExpectedWorkUnits": 0
}'Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}GET/api/v3/project/ci/{orgUnitUUID}/{productTag}
Get Continuous Project
Requires: PROJECT_get_by_id
path parameters
orgUnitUUIDrequired |
string (uuid) |
productTagrequired |
string |
query parameters
projectStatus |
string |
Responses
200 OK
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/ci/{orgUnitUUID}/{productTag}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}POST/api/v3/project/ci/{orgUnitUUID}/{productTag}
Upload Continuous Project File
Requires: PROJECT_create
path parameters
orgUnitUUIDrequired |
string (uuid) |
productTagrequired |
string |
Request body
ContinuousFileUploadDtomultipart/form-data
file |
string (binary) |
locales |
string[] |
path |
string |
reference |
string |
source |
string |
tags |
string[] |
workflows |
string[] |
Responses
200 OK
accountUuid |
string (uuid) |
alternativeTranslationsEnabled |
boolean |
approvalDate |
integer (int64) |
assignee |
UserDto |
automationEnabled |
boolean |
automationStatus |
stringRUNNING SKIPPED FINISHED FAILED |
automationStatusMessage |
string |
autopilotEnabled |
boolean |
ciTag |
string |
client |
OrganizationalUnitDto |
confidenceMatchOverRepetitionEnabled |
boolean |
confirmedSegments |
integer |
contact |
UserDto |
contentMode |
stringFILES KEY_VALUE |
continuousMode |
stringSEALED LEGACY |
costCalculationMode |
stringAUTOMATIC MANUAL |
costs |
CostDto[] |
costsCalculatedAt |
integer (int64) |
costsLogfileId |
string (uuid) |
costsLogfileName |
string |
costsRequestedAt |
integer (int64) |
costsStatus |
stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED |
createDate |
integer (int64) |
creator |
UserDto |
currency |
string |
customFields |
map<string, object>[] |
deliveryDate |
integer (int64) |
dropFiles |
string[] |
dueDate |
integer (int64) |
enableTaskFeedback |
boolean |
expirationDate |
integer (int64) |
genesisId |
string |
hasDataTransformation |
boolean |
hasNewUploadFile |
boolean |
id |
integer (int64) |
instructions |
string |
invoiceDate |
integer (int64) |
invoiceInfo |
string |
isContinuous |
boolean |
lastLogfileIdPostUpdate |
string (uuid) |
logfileForTasksPayment |
string (uuid) |
mediaFiles |
ProjectMediaFileDto[] |
name |
string |
notes |
string |
ntMatchOverRepetitionEnabled |
boolean |
organizationUuid |
string |
organizationalUnit |
OrganizationalUnitDto |
origin |
stringWORK_PACKAGE |
pdfPreviewFiles |
ProjectPdfPreviewFileDto[] |
priceList |
PriceListDto |
progress |
number (double) |
projectGroupId |
string (uuid) |
reference |
string |
referenceFiles |
string[] |
reminderThresholdPercentage |
integer |
requestedDeliveryDate |
integer (int64) |
requirePurchaseOrderEnabled |
boolean |
resources |
ProjectResourceDto[] |
reviewFiles |
ProjectReviewFileDto[] |
sourceLocale |
string |
spellCheckerIgnoreWordsEnabled |
boolean |
status |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
tags |
string[] |
targetLocales |
string[] |
taskPaymentType |
stringWORD HOUR |
taskReminderAutomaticEnabled |
boolean |
timezone |
string |
tmMatchOverRepetitionEnabled |
boolean |
totalCost |
number |
totalCostDto |
ITotalCost |
totalSegments |
integer |
totalWorkUnits |
integer (int64) |
uuid |
string (uuid) |
workUnits |
WorkUnitDto[] |
workflows |
WorkflowDto[] |
Request
curl -X POST 'https://app.wxrks.com/api/v3/project/ci/{orgUnitUUID}/{productTag}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-F 'file=@./file' \
-F 'locales=string' \
-F 'path=string' \
-F 'reference=string' \
-F 'source=string' \
-F 'tags=string' \
-F 'workflows=string'Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"alternativeTranslationsEnabled": false,
"approvalDate": 0,
"assignee": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"automationEnabled": false,
"automationStatus": "RUNNING",
"automationStatusMessage": "string",
"autopilotEnabled": false,
"ciTag": "string",
"client": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"confidenceMatchOverRepetitionEnabled": false,
"confirmedSegments": 0,
"contact": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"contentMode": "FILES",
"continuousMode": "SEALED",
"costCalculationMode": "AUTOMATIC",
"costs": [
{}
],
"costsCalculatedAt": 0,
"costsLogfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costsLogfileName": "string",
"costsRequestedAt": 0,
"costsStatus": "CREATING",
"createDate": 0,
"creator": {
"accessKey": "string",
"accessKeyTimestamp": 0,
"accountOwner": false,
"accountType": "CLI",
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"address": "string",
"address2": "string",
"admin": false,
"assignedJobs": 0,
"avatar": "string",
"captcha": "string",
"cellPhone": "string",
"city": "string",
"companyName": "string",
"completedJobs": 0,
"country": "string",
"currency": "string",
"customFields": [],
"dailyRate": 0,
"defaultWorkflowRates": [],
"deleteAllLanguagePair": false,
"email": "string",
"emailMagicCode": "string",
"entryPoint": "WORKS_HOME",
"externalId": "string",
"forwardUrl": "string",
"hourlyRate": 0,
"id": 0,
"invoicingDayOfMonth": "DAY_15",
"invoicingPeriodicity": 0,
"lastAccessAt": 0,
"messageError": "string",
"messageWarning": "string",
"mfa": 0,
"mfaEnabled": false,
"minimumFee": 0,
"name": "string",
"nameEmail": "string",
"newPassword": "string",
"notes": "string",
"notifyUser": false,
"orgUnits": [],
"organizations": [],
"pagesRate": 0,
"parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethod": "PAYONEER",
"payoneerId": "string",
"paypalAccount": "string",
"permissionGroups": [],
"phone": "string",
"postalCode": "string",
"productName": "string",
"punctuality": 0,
"quickBooksVendorId": "string",
"roles": [],
"skypeId": "string",
"slackHandle": "string",
"state": "string",
"status": "Active",
"subUser": false,
"subscriptions": [],
"supportedLanguagePairs": [],
"tags": [],
"targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tasksCompletedCount": 0,
"taxId": "string",
"taxpayerId": "string",
"timezone": "string",
"totalJobs": 0,
"useProjectCurrency": false,
"userQualityMetrics": {},
"userRates": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordRate": 0
},
"currency": "string",
"customFields": [
{}
],
"deliveryDate": 0,
"dropFiles": [
"string"
],
"dueDate": 0,
"enableTaskFeedback": false,
"expirationDate": 0,
"genesisId": "string",
"hasDataTransformation": false,
"hasNewUploadFile": false,
"id": 0,
"instructions": "string",
"invoiceDate": 0,
"invoiceInfo": "string",
"isContinuous": false,
"lastLogfileIdPostUpdate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logfileForTasksPayment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mediaFiles": [
{}
],
"name": "string",
"notes": "string",
"ntMatchOverRepetitionEnabled": false,
"organizationUuid": "string",
"organizationalUnit": {
"costsLogfileType": "PRE_ANALYSE",
"country": "string",
"id": 0,
"localeRegion": {},
"name": "string",
"organization": {},
"projectCountWordsFrom": "SOURCE",
"sourceLanguage": "string",
"targetLanguages": [],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"origin": "WORK_PACKAGE",
"pdfPreviewFiles": [
{}
],
"priceList": {
"accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"chargeBy": "WORD",
"currency": "string",
"defaultMinimumFeeByLanguagePair": 0,
"defaultPriceList": false,
"defaultPricePerHour": 0,
"defaultPricePerItem": 0,
"hiddenFuzzies": false,
"id": 0,
"infoFields": {},
"isAccountDefault": false,
"memo": "string",
"minFeeType": "PROJECT",
"minimumFeeByProject": 0,
"name": "string",
"priceFactors": [],
"prices": [],
"pricesAndPriceFactors": {},
"status": false,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wordsPerHour": 0
},
"progress": 0,
"projectGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"referenceFiles": [
"string"
],
"reminderThresholdPercentage": 0,
"requestedDeliveryDate": 0,
"requirePurchaseOrderEnabled": false,
"resources": [
{}
],
"reviewFiles": [
{}
],
"sourceLocale": "string",
"spellCheckerIgnoreWordsEnabled": false,
"status": "DELETED",
"tags": [
"string"
],
"targetLocales": [
"string"
],
"taskPaymentType": "WORD",
"taskReminderAutomaticEnabled": false,
"timezone": "string",
"tmMatchOverRepetitionEnabled": false,
"totalCost": 0,
"totalCostDto": {
"grossCost": 0,
"netCost": 0,
"projectId": 0,
"totalSavings": 0
},
"totalSegments": 0,
"totalWorkUnits": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workUnits": [
{}
],
"workflows": [
{}
]
}GET/api/v3/project/ci/{orgUnitUUID}/{productTag}/download
Download Continuous Project Translations
Requires: PROJECT_get_by_id
path parameters
orgUnitUUIDrequired |
string (uuid) |
productTagrequired |
string |
query parameters
resources |
string (uuid)[] |
locales |
string[] |
filenames |
string[] |
projectStatus |
stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS |
updateDataTransformation |
boolean |
retrieveLatestDeliveredWorkflow |
boolean |
dataTransformationParamsMap |
string |
Responses
200 OK
string (byte)[]
Request
curl -X GET 'https://app.wxrks.com/api/v3/project/ci/{orgUnitUUID}/{productTag}/download' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
[
"string"
]Project Routing / Configuration
GET/api/v3/multi-project
List Project Routing Configs
Requires: PROJECT_create
query parameters
name |
string |
sourceLanguage |
string |
orgUnit |
string (uuid) |
targetLanguages |
string[] |
sort |
string |
page |
integerPage to return, starting at 0. |
size |
integerItems per page. |
Responses
200 OK
content |
MultiProjectConfigDto[] |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer |
numberOfElements |
integer |
pageable |
PageableObject |
size |
integer |
sort |
SortObject |
totalElements |
integer (int64) |
totalPages |
integer |
Request
curl -X GET 'https://app.wxrks.com/api/v3/multi-project' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}GET/api/v3/multi-project/{configUuid}
Search Project Routing Config
Requires: PROJECT_create
path parameters
configUuidrequired |
string (uuid) |
Responses
200 OK
configOrgUnits |
ConfigOrgUnitsDto[] |
name |
string |
orgUnits |
string[] |
restrictLangPerOrgUnit |
boolean |
sourceLanguage |
string |
targetLanguages |
string[] |
uuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/multi-project/{configUuid}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"configOrgUnits": [
{}
],
"name": "string",
"orgUnits": [
"string"
],
"restrictLangPerOrgUnit": false,
"sourceLanguage": "string",
"targetLanguages": [
"string"
],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}POST/api/v3/multi-project/config/upsert
Project Routing Config
Requires: PROJECT_create
Request body
configOrgUnits |
ConfigOrgUnitsDto[] |
name |
string |
orgUnits |
string[] |
restrictLangPerOrgUnit |
boolean |
sourceLanguage |
string |
targetLanguages |
string[] |
uuid |
string (uuid) |
Responses
200 OK
string (uuid)
Request
curl -X POST 'https://app.wxrks.com/api/v3/multi-project/config/upsert' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"configOrgUnits": [],
"name": "string",
"orgUnits": [
"string"
],
"restrictLangPerOrgUnit": false,
"sourceLanguage": "string",
"targetLanguages": [
"string"
],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'Response 200
"3fa85f64-5717-4562-b3fc-2c963f66afa6"Project Routing / Base Project Setup
GETGet File Params is described in Resources and File Params.
POSTCreate Project Resource is described in Resources and File Params.
PUTUpload Project Resource Content is described in Resources and File Params.
Project Routing / Execution
GET/api/v3/multi-project/{baseProjectUuid}/status
Project Routing Status
Requires: PROJECT_create
path parameters
baseProjectUuidrequired |
string (uuid) |
Responses
200 OK
current |
integer |
fixedSegments |
integer |
key |
string |
remainingSegments |
integer |
skippedSegments |
integer |
status |
string |
total |
integer |
unfixedSegments |
integer[] |
url |
string |
Request
curl -X GET 'https://app.wxrks.com/api/v3/multi-project/{baseProjectUuid}/status' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"Response 200
{
"current": 0,
"fixedSegments": 0,
"key": "string",
"remainingSegments": 0,
"skippedSegments": 0,
"status": "string",
"total": 0,
"unfixedSegments": [
0
],
"url": "string"
}POST/api/v3/multi-project/{configUuid}/preview
Project Routing Preview
Requires: PROJECT_create
path parameters
configUuidrequired |
string (uuid) |
query parameters
baseProjectUuid |
string (uuid) |
Request body
string[]
Responses
200 OK
configOrgUnits |
ConfigOrgUnitsDto[] |
name |
string |
orgUnits |
string[] |
restrictLangPerOrgUnit |
boolean |
sourceLanguage |
string |
targetLanguages |
string[] |
uuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/multi-project/{configUuid}/preview' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '[
"string"
]'Response 200
{
"configOrgUnits": [
{}
],
"name": "string",
"orgUnits": [
"string"
],
"restrictLangPerOrgUnit": false,
"sourceLanguage": "string",
"targetLanguages": [
"string"
],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}POST/api/v3/multi-project/{configUuid}/project-create
Create Project Routing
Requires: PROJECT_create
path parameters
configUuidrequired |
string (uuid) |
Request body
baseProjectUuid |
string (uuid) |
projects |
ConfigOrgUnitsDto[] |
reference |
string |
sourceLanguage |
string |
Responses
200 OK
Request
curl -X POST 'https://app.wxrks.com/api/v3/multi-project/{configUuid}/project-create' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"baseProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"projects": [],
"reference": "string",
"sourceLanguage": "string"
}'