reference

Logfiles

10 endpoints

GET/api/v3/project/{projectUUID}/logfile

List Logfiles

Requires: PROJECT_get_by_id

path parameters

projectUUIDrequired string (uuid)

query parameters

orderBy string
orderType string
page integer
pageSize integer

Responses

200 OK

PagedResponseGenesisAnalysisDto

content GenesisAnalysisDto[]
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}/logfile' \
  -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
}

POST/api/v3/project/{projectUUID}/logfile

Create Logfile

Requires: PROJECT_create

Creates a logfile (analysis) for the work units in the body. With pre-analysis, the body is ignored and a pre-analysis logfile is created for the whole project instead.

path parameters

projectUUIDrequired string (uuid)

query parameters

pre-analysis boolean
Create a pre-analysis logfile for the whole project and ignore the body. Its presence selects this, whatever its value.

Request body

CreateLogfileRequest

allWorkUnitsAtLevel integer
Analyse every work unit at this workflow level.
calculateMachineTranslationReuse boolean
calculateNonTranslatableReuse boolean
calculateTranslationMemoryReuse boolean
classifyConfidenceApproved boolean
confidenceOverRepetition boolean
Defaults to the project's setting.
countWordsFrom stringSOURCE TARGET
Defaults to SOURCE.
ignoreConfirmedSegments boolean
ignoreLockedSegments boolean
ignoreNumbers boolean
maxSegmentTimestamp integer (int64)
Only segments changed up to this time (epoch milliseconds) count.
name string
Name of the logfile.
ntOverRepetition boolean
Defaults to the project's setting.
taskIds string (uuid)[]
Tasks to analyse.
taskUuids string (uuid)[]
tmOverRepetition boolean
Defaults to the project's setting.
typerequired stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitIds string (uuid)[]
Work units to analyse. Without work units, tasks or allWorkUnitsAtLevel, every work unit of the project.
workflow string

Responses

200 OK

GenesisAnalysisDto

allWorkUnitsAtLevel integer
analysisWorkflow string
attempt integer
config AnalysisConfigDto
countWordsFrom stringSOURCE TARGET
creationDate integer (int64)
failureReason string
fileContent string (byte)[]
finishedDate integer (int64)
id string (uuid)
isCostLogFile boolean
isTaskPaymentLogFile boolean
itemsByFile AnalysisItemByFileDto[]
itemsByLangPair AnalysisItemByLangPairDto[]
name string
previousName string
The name the logfile had before its last rename. Empty when it was never renamed.
progress GenesisAnalysisProgressDto
projectId string (uuid)
renamedAt integer (int64)
When the last rename happened, in epoch milliseconds.
renamedBy string
Who made the last rename.
startedDate integer (int64)
status string
targetLocales string[]
The target locales of the analysis.
targetsLocalesdeprecated string[]
Same as targetLocales. The misspelled name stays until the next API version.
type stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitsAtProjectStepLevel integer
workflow string

Request

curl -X POST 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Pre-analysis, first batch",
  "type": "PRE_ANALYSE",
  "workUnitIds": [
    "9a2c5f8e-3d1b-4e7a-a6c4-2f9b0d5e8c33",
    "1e7b4d0a-6c2f-4a83-9b5e-8d3a0c6f2b19"
  ]
}'

Response 200

{
  "allWorkUnitsAtLevel": 0,
  "analysisWorkflow": "string",
  "attempt": 0,
  "config": {
    "analyzeByLanguage": false,
    "analyzeByProvider": false,
    "calculateMachineTranslationReuse": false,
    "calculateNonTranslatableReuse": false,
    "calculateTranslationMemoryReuse": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ignoreConfirmedSegments": false,
    "ignoreLockedSegments": false,
    "ignoreNumbers": false,
    "includeNetRate": false
  },
  "countWordsFrom": "SOURCE",
  "creationDate": 0,
  "failureReason": "string",
  "fileContent": [
    "string"
  ],
  "finishedDate": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCostLogFile": false,
  "isTaskPaymentLogFile": false,
  "itemsByFile": [
    {}
  ],
  "itemsByLangPair": [
    {}
  ],
  "name": "string",
  "previousName": "string",
  "progress": {
    "currentStep": "string",
    "percentage": 0,
    "processedSegments": 0,
    "totalSegments": 0
  },
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "renamedAt": 0,
  "renamedBy": "string",
  "startedDate": 0,
  "status": "string",
  "targetLocales": [
    "string"
  ],
  "targetsLocales": [
    "string"
  ],
  "type": "PRE_ANALYSE",
  "workUnitsAtProjectStepLevel": 0,
  "workflow": "string"
}

GET/api/v3/project/{projectUUID}/logfile/{logfileUUID}

Project Logfile Details

Requires: PROJECT_get_by_id

path parameters

projectUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)

Responses

200 OK

GenesisAnalysisDto

allWorkUnitsAtLevel integer
analysisWorkflow string
attempt integer
config AnalysisConfigDto
countWordsFrom stringSOURCE TARGET
creationDate integer (int64)
failureReason string
fileContent string (byte)[]
finishedDate integer (int64)
id string (uuid)
isCostLogFile boolean
isTaskPaymentLogFile boolean
itemsByFile AnalysisItemByFileDto[]
itemsByLangPair AnalysisItemByLangPairDto[]
name string
previousName string
The name the logfile had before its last rename. Empty when it was never renamed.
progress GenesisAnalysisProgressDto
projectId string (uuid)
renamedAt integer (int64)
When the last rename happened, in epoch milliseconds.
renamedBy string
Who made the last rename.
startedDate integer (int64)
status string
targetLocales string[]
The target locales of the analysis.
targetsLocalesdeprecated string[]
Same as targetLocales. The misspelled name stays until the next API version.
type stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitsAtProjectStepLevel integer
workflow string

Request

curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile/{logfileUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "allWorkUnitsAtLevel": 0,
  "analysisWorkflow": "string",
  "attempt": 0,
  "config": {
    "analyzeByLanguage": false,
    "analyzeByProvider": false,
    "calculateMachineTranslationReuse": false,
    "calculateNonTranslatableReuse": false,
    "calculateTranslationMemoryReuse": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ignoreConfirmedSegments": false,
    "ignoreLockedSegments": false,
    "ignoreNumbers": false,
    "includeNetRate": false
  },
  "countWordsFrom": "SOURCE",
  "creationDate": 0,
  "failureReason": "string",
  "fileContent": [
    "string"
  ],
  "finishedDate": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCostLogFile": false,
  "isTaskPaymentLogFile": false,
  "itemsByFile": [
    {}
  ],
  "itemsByLangPair": [
    {}
  ],
  "name": "string",
  "previousName": "string",
  "progress": {
    "currentStep": "string",
    "percentage": 0,
    "processedSegments": 0,
    "totalSegments": 0
  },
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "renamedAt": 0,
  "renamedBy": "string",
  "startedDate": 0,
  "status": "string",
  "targetLocales": [
    "string"
  ],
  "targetsLocales": [
    "string"
  ],
  "type": "PRE_ANALYSE",
  "workUnitsAtProjectStepLevel": 0,
  "workflow": "string"
}

PATCH/api/v3/project/{projectUUID}/logfile/{logfileUUID}

Rename Logfile

Requires: PROJECT_update

Renames the logfile. It keeps the previous name, who renamed it and when.

path parameters

projectUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)

Request body

RenameLogfileDto

name string
The new name of the logfile. Surrounding spaces are removed; a blank name is refused.

Responses

200 OK

GenesisAnalysisDto

allWorkUnitsAtLevel integer
analysisWorkflow string
attempt integer
config AnalysisConfigDto
countWordsFrom stringSOURCE TARGET
creationDate integer (int64)
failureReason string
fileContent string (byte)[]
finishedDate integer (int64)
id string (uuid)
isCostLogFile boolean
isTaskPaymentLogFile boolean
itemsByFile AnalysisItemByFileDto[]
itemsByLangPair AnalysisItemByLangPairDto[]
name string
previousName string
The name the logfile had before its last rename. Empty when it was never renamed.
progress GenesisAnalysisProgressDto
projectId string (uuid)
renamedAt integer (int64)
When the last rename happened, in epoch milliseconds.
renamedBy string
Who made the last rename.
startedDate integer (int64)
status string
targetLocales string[]
The target locales of the analysis.
targetsLocalesdeprecated string[]
Same as targetLocales. The misspelled name stays until the next API version.
type stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitsAtProjectStepLevel integer
workflow string

Request

curl -X PATCH 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile/{logfileUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Response 200

{
  "allWorkUnitsAtLevel": 0,
  "analysisWorkflow": "string",
  "attempt": 0,
  "config": {
    "analyzeByLanguage": false,
    "analyzeByProvider": false,
    "calculateMachineTranslationReuse": false,
    "calculateNonTranslatableReuse": false,
    "calculateTranslationMemoryReuse": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ignoreConfirmedSegments": false,
    "ignoreLockedSegments": false,
    "ignoreNumbers": false,
    "includeNetRate": false
  },
  "countWordsFrom": "SOURCE",
  "creationDate": 0,
  "failureReason": "string",
  "fileContent": [
    "string"
  ],
  "finishedDate": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCostLogFile": false,
  "isTaskPaymentLogFile": false,
  "itemsByFile": [
    {}
  ],
  "itemsByLangPair": [
    {}
  ],
  "name": "string",
  "previousName": "string",
  "progress": {
    "currentStep": "string",
    "percentage": 0,
    "processedSegments": 0,
    "totalSegments": 0
  },
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "renamedAt": 0,
  "renamedBy": "string",
  "startedDate": 0,
  "status": "string",
  "targetLocales": [
    "string"
  ],
  "targetsLocales": [
    "string"
  ],
  "type": "PRE_ANALYSE",
  "workUnitsAtProjectStepLevel": 0,
  "workflow": "string"
}

GET/api/v3/project/{projectUUID}/logfile/{logfileUUID}/breakdown-by-locale

Project Logfile Breakdown By Locale

Requires: PROJECT_get_by_id

path parameters

projectUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)

query parameters

targetLocale string
targetWorkflow string

Responses

200 OK

GenesisAnalysisDto

allWorkUnitsAtLevel integer
analysisWorkflow string
attempt integer
config AnalysisConfigDto
countWordsFrom stringSOURCE TARGET
creationDate integer (int64)
failureReason string
fileContent string (byte)[]
finishedDate integer (int64)
id string (uuid)
isCostLogFile boolean
isTaskPaymentLogFile boolean
itemsByFile AnalysisItemByFileDto[]
itemsByLangPair AnalysisItemByLangPairDto[]
name string
previousName string
The name the logfile had before its last rename. Empty when it was never renamed.
progress GenesisAnalysisProgressDto
projectId string (uuid)
renamedAt integer (int64)
When the last rename happened, in epoch milliseconds.
renamedBy string
Who made the last rename.
startedDate integer (int64)
status string
targetLocales string[]
The target locales of the analysis.
targetsLocalesdeprecated string[]
Same as targetLocales. The misspelled name stays until the next API version.
type stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitsAtProjectStepLevel integer
workflow string

Request

curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile/{logfileUUID}/breakdown-by-locale' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "allWorkUnitsAtLevel": 0,
  "analysisWorkflow": "string",
  "attempt": 0,
  "config": {
    "analyzeByLanguage": false,
    "analyzeByProvider": false,
    "calculateMachineTranslationReuse": false,
    "calculateNonTranslatableReuse": false,
    "calculateTranslationMemoryReuse": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ignoreConfirmedSegments": false,
    "ignoreLockedSegments": false,
    "ignoreNumbers": false,
    "includeNetRate": false
  },
  "countWordsFrom": "SOURCE",
  "creationDate": 0,
  "failureReason": "string",
  "fileContent": [
    "string"
  ],
  "finishedDate": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCostLogFile": false,
  "isTaskPaymentLogFile": false,
  "itemsByFile": [
    {}
  ],
  "itemsByLangPair": [
    {}
  ],
  "name": "string",
  "previousName": "string",
  "progress": {
    "currentStep": "string",
    "percentage": 0,
    "processedSegments": 0,
    "totalSegments": 0
  },
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "renamedAt": 0,
  "renamedBy": "string",
  "startedDate": 0,
  "status": "string",
  "targetLocales": [
    "string"
  ],
  "targetsLocales": [
    "string"
  ],
  "type": "PRE_ANALYSE",
  "workUnitsAtProjectStepLevel": 0,
  "workflow": "string"
}

GET/api/v3/project/{projectUUID}/logfile/{logfileUUID}/download-async

Export Logfile

Requires: PROJECT_get_by_id

path parameters

projectUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)

query parameters

format string
rebuild boolean
splitByTargetLocale boolean
fileNamePattern string

Responses

200 OK

LogfileDownloadFile

downloadUrl string
progress number (double)
requestUuid string (uuid)
skippedTargetLocales SkippedTargetLocale[]
status string

Request

curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile/{logfileUUID}/download-async' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "downloadUrl": "string",
  "progress": 0,
  "requestUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "skippedTargetLocales": [
    {}
  ],
  "status": "string"
}

GET/api/v3/project/{projectUUID}/logfile/{logfileUUID}/download/{requestUUID}/status

Status Export Logfile

Requires: PROJECT_get_by_id

path parameters

projectUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)
requestUUIDrequired string (uuid)

Responses

200 OK

LogfileDownloadFile

downloadUrl string
progress number (double)
requestUuid string (uuid)
skippedTargetLocales SkippedTargetLocale[]
status string

Request

curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile/{logfileUUID}/download/{requestUUID}/status' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "downloadUrl": "string",
  "progress": 0,
  "requestUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "skippedTargetLocales": [
    {}
  ],
  "status": "string"
}

GET/api/v3/project/{projectUUID}/logfile/{logfileUUID}/summary

Logfile Summary

Requires: PROJECT_get_by_id

path parameters

projectUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)

Responses

200 OK

GenesisAnalysisSummaryDto[]

language string
totalChars integer (int64)
totalSegments integer (int64)
totalWords integer (int64)

Request

curl -X GET 'https://app.wxrks.com/api/v3/project/{projectUUID}/logfile/{logfileUUID}/summary' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "language": "string",
    "totalChars": 0,
    "totalSegments": 0,
    "totalWords": 0
  }
]

GET/api/v3/task/{taskUUID}/logfile

Task Logfile

Requires: TASK_get_by_id

path parameters

taskUUIDrequired string (uuid)

Responses

200 OK

map<string, GenesisAnalysisDto>

allWorkUnitsAtLevel integer
analysisWorkflow string
attempt integer
config AnalysisConfigDto
countWordsFrom stringSOURCE TARGET
creationDate integer (int64)
failureReason string
fileContent string (byte)[]
finishedDate integer (int64)
id string (uuid)
isCostLogFile boolean
isTaskPaymentLogFile boolean
itemsByFile AnalysisItemByFileDto[]
itemsByLangPair AnalysisItemByLangPairDto[]
name string
previousName string
The name the logfile had before its last rename. Empty when it was never renamed.
progress GenesisAnalysisProgressDto
projectId string (uuid)
renamedAt integer (int64)
When the last rename happened, in epoch milliseconds.
renamedBy string
Who made the last rename.
startedDate integer (int64)
status string
targetLocales string[]
The target locales of the analysis.
targetsLocalesdeprecated string[]
Same as targetLocales. The misspelled name stays until the next API version.
type stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitsAtProjectStepLevel integer
workflow string

Request

curl -X GET 'https://app.wxrks.com/api/v3/task/{taskUUID}/logfile' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

GET/api/v3/task/{taskUUID}/logfile/{logfileUUID}/breakdown-by-workflow

Task Logfile Breakdown

Requires: TASK_get_by_id

path parameters

taskUUIDrequired string (uuid)
logfileUUIDrequired string (uuid)

query parameters

logFileTyperequired stringPRE_ANALYSE POST_ANALYSE

Responses

200 OK

GenesisAnalysisDto

allWorkUnitsAtLevel integer
analysisWorkflow string
attempt integer
config AnalysisConfigDto
countWordsFrom stringSOURCE TARGET
creationDate integer (int64)
failureReason string
fileContent string (byte)[]
finishedDate integer (int64)
id string (uuid)
isCostLogFile boolean
isTaskPaymentLogFile boolean
itemsByFile AnalysisItemByFileDto[]
itemsByLangPair AnalysisItemByLangPairDto[]
name string
previousName string
The name the logfile had before its last rename. Empty when it was never renamed.
progress GenesisAnalysisProgressDto
projectId string (uuid)
renamedAt integer (int64)
When the last rename happened, in epoch milliseconds.
renamedBy string
Who made the last rename.
startedDate integer (int64)
status string
targetLocales string[]
The target locales of the analysis.
targetsLocalesdeprecated string[]
Same as targetLocales. The misspelled name stays until the next API version.
type stringPRE_ANALYSE POST_ANALYSE COMPARE
workUnitsAtProjectStepLevel integer
workflow string

Request

curl -X GET 'https://app.wxrks.com/api/v3/task/{taskUUID}/logfile/{logfileUUID}/breakdown-by-workflow?logFileType=PRE_ANALYSE' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "allWorkUnitsAtLevel": 0,
  "analysisWorkflow": "string",
  "attempt": 0,
  "config": {
    "analyzeByLanguage": false,
    "analyzeByProvider": false,
    "calculateMachineTranslationReuse": false,
    "calculateNonTranslatableReuse": false,
    "calculateTranslationMemoryReuse": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ignoreConfirmedSegments": false,
    "ignoreLockedSegments": false,
    "ignoreNumbers": false,
    "includeNetRate": false
  },
  "countWordsFrom": "SOURCE",
  "creationDate": 0,
  "failureReason": "string",
  "fileContent": [
    "string"
  ],
  "finishedDate": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isCostLogFile": false,
  "isTaskPaymentLogFile": false,
  "itemsByFile": [
    {}
  ],
  "itemsByLangPair": [
    {}
  ],
  "name": "string",
  "previousName": "string",
  "progress": {
    "currentStep": "string",
    "percentage": 0,
    "processedSegments": 0,
    "totalSegments": 0
  },
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "renamedAt": 0,
  "renamedBy": "string",
  "startedDate": 0,
  "status": "string",
  "targetLocales": [
    "string"
  ],
  "targetsLocales": [
    "string"
  ],
  "type": "PRE_ANALYSE",
  "workUnitsAtProjectStepLevel": 0,
  "workflow": "string"
}