Documentation updates
1 endpoint changed.
-
POST
/api/v3/payable/import/:accountUuid/jsonImport Payables from JSON- Description text updated
Every update to our API, and whether it needs a change on your side.
The rest are there for you to pick up whenever they're useful. It's worth a look before you ship, and if you spot an update that isn't listed, do let us know.
1 endpoint changed.
POST/api/v3/payable/import/:accountUuid/json
Import Payables from JSON
2 endpoints changed.
POST/api/v3/connector/github/config/:configUUID/repo
Upsert Repository Configurations
POST/api/v3/project/ci/:orgUnitUUID/:productTag
Upload Continuous Project File
3 endpoints changed.
POST/api/v3/connector/github/config/:configUUID/repo
Upsert Repository Configurations
POST/api/v3/project/ci/:orgUnitUUID/:productTag
Upload Continuous Project File
POST/api/v3/webhook
Create Webhook
22 endpoints changed.
GET/api/v3/project/:projectUuid/quality-summary
Get Project Quality Summary
GET/api/v3/project/:projectUuid/segments
List Project Segments
POST/
NEW_EMPTY_PROJECT
POST/
NEW_ORG
POST/
NEW_ORG_UNIT
POST/
NEW_PROJECT
POST/
NEW_USER
POST/
ORG_UNIT_UPDATE
POST/
ORG_UPDATE
POST/
PROJECT_INGESTION_COMPLETED
POST/
PROJECT_STATUS_CHANGE
POST/
PROJECT_TRANSLATION_FINISHED
POST/
PROJECT_UPDATE
POST/
TASK_ASSIGNED
POST/
TASK_STATUS_CHANGE
POST/
TASK_UPDATE
POST/
USER_UPDATE
POST/
WEBHOOK_VALIDATION
POST/
WORK_UNIT_STATUS_CHANGE
POST/
WORK_UNIT_TRANSLATION_FILE_READY
POST/api/v3/project/ci/:orgUnitUUID/:productTag
Upload Continuous Project File
POST/api/v3/webhook
Create Webhook
2 endpoints changed.
POST/api/v3/project/ci/:orgUnitUUID/:productTag
Upload Continuous Project File
POST/api/v3/webhook
Create Webhook
5 endpoints changed.
DELETE/api/v3/connector/github/config/:configUUID/repo/:name/owner/:owner/config-path/:configPath/base-branch/:baseBranch
Delete Repository Configuration
GET/api/v3/connector/eloqua/config/:configUUID
Get Configuration
GET/api/v3/connector/github/config/:configUUID
Get Configuration
GET/api/v3/connector/github/config/:configUUID/repo
Get Repository Configurations
GET/api/v3/connector/wordpress/config/:configUUID
Get Configuration
17 endpoints changed.
DELETE/api/v3/connector/github/config/:configUUID/repo/:name/owner/:owner/config-path/:configPath/base-branch/:baseBranch
Delete Repository Configuration
GET/api/v3/connector/eloqua/config/:configUUID
Get Configuration
GET/api/v3/connector/github/config/:configUUID
Get Configuration
GET/api/v3/connector/github/config/:configUUID/repo
Get Repository Configurations
GET/api/v3/connector/wordpress/config/:configUUID
Get Configuration
GET/api/v3/glossary/:glossaryUuid/jobs
List Imports
GET/api/v3/glossary/term/search/params
Search Terms by Parameters
GET/api/v3/glossary/term/search/segment
Search Terms Based on a Segment
GET/api/v3/project/:projectUuid/work-unit/:workUnitUuid/translation
Download Original File
POST/api/v3/connector/eloqua/config
Create Configuration
POST/api/v3/connector/github/config
Create Configuration
POST/api/v3/connector/wordpress/config
Create Configuration
POST/api/v3/glossary/term/check-duplicated
Check for Duplicated Terms
PUT/api/v3/connector/eloqua/config
Update Configuration
PUT/api/v3/connector/github/config
Update Configuration
PUT/api/v3/connector/wordpress/config
Update Configuration
PUT/api/v3/glossary/term/:termUuid
Update a Term
11 endpoints changed.
GET/api/v1/atlas-tm/job/:jobId
Get TM Job
GET/api/v3/glossary/:glossaryUuid/last-import-job
Last Import
GET/api/v3/glossary/term/search/params
Search Terms by Parameters
GET/api/v3/glossary/term/search/segment
Search Terms Based on a Segment
GET/api/v3/portal/translations/:requestUuid
Get Translation Result
GET/api/v3/project/:projectUuid/work-unit/:workUnitUuid/translation
Download Original File
POST/api/v1/atlas-tm/:tmUuid/bulk-importer
Import TM File
POST/api/v1/atlas-tm/:tmUuid/export
Export TM
POST/api/v3/portal/translate
Translate (Context Sensitive)
POST/api/v3/portal/translations
Translate (Context Sensitive) - Async
POST/api/v3/project
Create Project
30 endpoints changed.
DELETE/api/v3/connector/github/config/:configUUID/repo/:name/owner/:owner/config-path/:configPath/base-branch/:baseBranch
Delete Repository Configuration
DELETE/api/v3/glossary/term/:termUuid
Delete a Term
GET/api/v1/atlas-tm
List Translation Memory (TM)
GET/api/v1/translation-memory/:tmUuid/translation-unit/search
Search Translation Units
GET/api/v3/connector/eloqua/config/:configUUID
Get Configuration
GET/api/v3/connector/github/config/:configUUID
Get Configuration
GET/api/v3/connector/github/config/:configUUID/repo
Get Repository Configurations
GET/api/v3/connector/wordpress/config/:configUUID
Get Configuration
GET/api/v3/glossary
List Glossary
GET/api/v3/glossary/:glossaryUuid
Get Glossary
GET/api/v3/glossary/:glossaryUuid/concept-entries
List Glossary Terms
GET/api/v3/glossary/:glossaryUuid/jobs
List Imports
GET/api/v3/glossary/:glossaryUuid/last-import-job
Last Import
GET/api/v3/glossary/term/:termUuid
Get Term
GET/api/v3/glossary/term/search/params
Search Terms by Parameters
GET/api/v3/glossary/term/search/segment
Search Terms Based on a Segment
GET/api/v3/portal/translations/:requestUuid
Get Translation Result
GET/api/v3/project/:projectUUID/payment-type
Get Project Payment Type
GET/api/v3/workflow
List Workflows
POST/api/v3/connector/eloqua/config
Create Configuration
POST/api/v3/connector/github/config
Create Configuration
POST/api/v3/connector/wordpress/config
Create Configuration
POST/api/v3/glossary/term
Create a New Term
POST/api/v3/glossary/term/check-duplicated
Check for Duplicated Terms
POST/api/v3/portal/translate
Translate (Context Sensitive)
POST/api/v3/portal/translations
Translate (Context Sensitive) - Async
PUT/api/v3/connector/eloqua/config
Update Configuration
PUT/api/v3/connector/github/config
Update Configuration
PUT/api/v3/connector/wordpress/config
Update Configuration
PUT/api/v3/glossary/term/:termUuid
Update a Term
9 endpoints changed.
GET/api/v3/payable/import/status/:requestUuid
Get Payables Import Status
POST/api/v3/payable/import/:accountUuid
Import Payables from Spreadsheet
POST/api/v3/payable/import/:accountUuid/json
Import Payables from JSON
POST/api/v3/project/:projectUUID/translation-kit-job/resource
Create Import Kit Resource
POST/api/v3/project/:projectUUID/translation-kit-job/resource/:projectResourceUUID
Get Import Kit Upload URL
POST/api/v3/project/:projectUUID/translation-kit-job/resource/:projectResourceUUID/bulk-import
Bulk Import Kit
POST/api/v3/project/:projectUUID/translation-kit-job/work-unit/:workUnitUUID/import/status
Check Work Unit Import Status
POST/api/v3/project/:projectUUID/translation-kit-job/work-unit/:workUnitUUID/resource/:projectResourceUUID/import
Import Kit to Work Unit
POST/api/v3/webhook
Create Webhook
2 endpoints changed.
GET/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID
Check Translation Kit Job Status
POST/api/v3/webhook
Create Webhook
1 endpoint changed.
POST/api/v3/glossary
Create Glossary
3 endpoints changed.
POST/api/v3/client/translation-memory/:tmUUID
Associate Translation Memory with Org Units
POST/api/v3/glossary/:glossaryUUID/org-unit-settings
Associate Glossary with Org Units
POST/api/v3/translation-memory
Create Translation Memory
1 endpoint changed.
POST/api/v3/glossary
Create Glossary
3 endpoints changed.
GET/api/v3/project/:projectUUID/translation-kit-job/:requestUUID
Download Export Project
GET/api/v3/project/:projectUUID/translation-kit-job/:requestUUID
Download Project Translated Files
POST/api/v3/project/:projectUuid/translation-kit-job/translated-files
Request Download Project Translated Files
5 endpoints changed.
GET/api/v3/portal/translations/:requestUuid
Get Translation Result
GET/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID/download-links
List Translation Kit Job Download Links
GET/api/v3/shared-link/:token
Resolve Shared Link
POST/api/v3/portal/translations
Translate (Context Sensitive) - Async
POST/api/v3/project/:projectUUID/translation-kit-job/translated-files
Request Project Translated Files
60 endpoints changed.
DELETE/api/v1/translation-memory/:tmUuid/:tuId/segment
Delete Translation in TU
DELETE/api/v1/translation-memory/:tmUuid/translation-unit/:tuId
Delete Translation Unit (TU)
DELETE/api/v3/glossary/:glossaryUuid
Delete Glossary
DELETE/api/v3/project/:ProjectUUID/work-unit/bulk
Bulk Delete Work Units
DELETE/api/v3/project/:projectUUID/cost/:costUUID
Delete Costs
DELETE/api/v3/project/:projectUUID/resource/:projectResourceUUID
Delete Project Resource
GET/api/v1/atlas-tm
List Translation Memory (TM)
GET/api/v1/atlas/parser/file-params
Get File Params
GET/api/v1/atlas/parser/file-params
Get File Params
GET/api/v1/translation-memory/:tmUuid/segment/fuzzy-search
Fuzzy Search Segments
GET/api/v1/translation-memory/:tmUuid/translation-unit/fuzzy-search
Fuzzy Search Translation Units
GET/api/v1/translation-memory/:tmUuid/translation-unit/search
Search Translation Units
GET/api/v3/custom-field/list
List Custom Fields
GET/api/v3/glossary
List Glossary
GET/api/v3/glossary/:glossaryUuid
Get Glossary
GET/api/v3/glossary/:glossaryUuid/concept-entries
Get a Concept Entries
GET/api/v3/glossary/:glossaryUuid/concept-entries
List Glossary Terms
GET/api/v3/glossary/:glossaryUuid/jobs
List Imports
GET/api/v3/glossary/:glossaryUuid/last-import-job
Last Import
GET/api/v3/glossary/concept-entries/:conceptId
Get a Concept Entry
GET/api/v3/glossary/export/:glossaryUuid/:fileType
Init Export Glossary
GET/api/v3/glossary/export/:glossaryUuid/:fileType/:requestUuid/status
Export Glossary status
GET/api/v3/glossary/term/recognition
Search Terms (Term Recognition)
GET/api/v3/language
Languages
GET/api/v3/multi-project
List Project Routing Configs
GET/api/v3/multi-project/:baseProjectUuid/status
Project Routing Status
GET/api/v3/multi-project/:configUuid
Search Project Routing Config
GET/api/v3/project
List Projects
GET/api/v3/project/:projectUUID
Get Project
GET/api/v3/project/:projectUUID/cost/manual-cost
List Manual Costs
GET/api/v3/project/:projectUUID/cost/priceTypes
Costs Price Types
GET/api/v3/project/:projectUUID/costs-summary
Costs Summary
GET/api/v3/project/:projectUUID/costs/lang-pair
Costs to Language Pair
GET/api/v3/project/:projectUUID/download
Download Project Translations
GET/api/v3/project/:projectUUID/download/:requestUUID/status
Download Project Translations Async Status
GET/api/v3/project/:projectUUID/ingestion/status
Get Project Ingestion Status
GET/api/v3/project/:projectUUID/message
List Simple Notes
GET/api/v3/project/:projectUUID/payment-type
Get Project Payment Type
GET/api/v3/project/:projectUUID/process-summary
Get Project Process Summary
GET/api/v3/project/:projectUUID/profitability
Profitability
GET/api/v3/project/:projectUUID/reference-files/download
Download All Reference Files
GET/api/v3/project/:projectUUID/resource/simple
Get Project Resources
GET/api/v3/project/:projectUUID/total-costs
Total Costs
GET/api/v3/project/:projectUUID/translated-file/download
Download Project Translated (Non Zip)
GET/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID
Check Bulk Source Files Status
GET/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID
Check Translation Kit Job Status
GET/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID
Check Translation Kit Job Status
GET/api/v3/project/:projectUUID/translation-kit-job/:translationKitJobUUID
Check Translation Kit Job Status
GET/api/v3/project/:projectUUID/translation-memory
Get Project Translation Memories
GET/api/v3/project/:projectUUID/work-unit
List Project Work Units
GET/api/v3/project/:projectUuid/work-unit/:workUnitUuid/translation
Download Original File
GET/api/v3/project/ci/:orgUnitUUID/:productTag
Get Continuous Project
GET/api/v3/project/ci/:orgUnitUUID/:productTag/download
Download Continuous Project Translations
POST/api/v1/translation-memory/:tmUuid/translation-unit
Upsert Translation in TU
POST/api/v3/auth
Auth API Token
POST/api/v3/glossary
Create Glossary
POST/api/v3/glossary/:glossaryUuid/clear
Clear Glossary
POST/api/v3/glossary/:glossaryUuid/import
Import TBX
POST/api/v3/multi-project/:configUuid/preview
Project Routing Preview
POST/api/v3/multi-project/:configUuid/project-create
Create Project Routing
And 26 more endpoints in this group.
2 endpoints changed.
GET/api/v3/project/:projectUUID/message
List Simple Notes
POST/api/v3/project/:projectUUID/message
Create Simple Note
1 endpoint changed.
POST/api/v3/project/:projectUUID/download
Download Project Translations Async
1 endpoint changed.
GET/api/v3/project/:projectUUID/translated-file/download
Download Project Translated (Non Zip)
2 endpoints changed.
GET/api/v3/task
List Tasks
POST/api/v3/project/:projectUUID/download
Download Project Translations Async
10 endpoints changed.
GET/api/v3/net-rate-settings/list
List All Net Rate Settings
GET/api/v3/project/:projectUUID/cost/manual-cost
List Manual Costs
GET/api/v3/project/:projectUUID/logfile/:logfileUUID
Project Logfile Details
GET/api/v3/project/:projectUUID/logfile/:logfileUUID/breakdown-by-locale
Project Logfile Breakdown By Locale
GET/api/v3/project/:projectUUID/reference-files/download
Download All Reference Files
GET/api/v3/project/:projectUUID/translation-memory
Get Project Translation Memories
GET/api/v3/task
List Tasks
POST/api/v2/organization
Create Organization
POST/api/v3/client
Create Org Unit
POST/api/v3/project/:projectUUID/reference-file
Upload Reference File
4 endpoints changed.
GET/api/v3/project/:projectUUID
Get Project
GET/api/v3/task/:projectUUID/statuses
List Project Task Statuses
POST/api/v3/project/:projectUUID/status
Change Project Status
POST/api/v3/task/:taskUuid/payment-update
Task Payment
1 endpoint changed.
POST/api/v3/project/:projectUUID/download
Download Project Translations Async
18 endpoints changed.
DELETE/api/v3/project/:ProjectUUID/work-unit/bulk
Bulk Delete Work Units
DELETE/api/v3/project/:projectUUID/resource/:projectResourceUUID
Delete Project Resource
DELETE/api/v3/user/:userUUID/rate/:userRateUUID
Delete User Rate
DELETE/api/v3/user/:userUUID/rate/:userRateUUID/detail/:rateDetailUUID
Delete User Rate Detail
GET/api/v3/net-rate-settings/:netRateUuid
Get Net Rate Settings
GET/api/v3/net-rate-settings/list-account
List Account Net Rate Settings
GET/api/v3/net-rate-settings/list-org-unit-account/:orgUnitUUID
List Org Unit Net Rate Settings
GET/api/v3/price-list
List Price Lists
GET/api/v3/project/:projectUUID/ingestion/status
Get Project Ingestion Status
GET/api/v3/project/:projectUUID/payment-type
Get Project Payment Type
GET/api/v3/project/:projectUUID/process-summary
Get Project Process Summary
GET/api/v3/user/:userUUID/rate
List User Rates
GET/api/v3/workflow
List Workflows
POST/api/v3/project/:projectUUID/download
Download Project Translations Async
POST/api/v3/user/:userUUID/rate
Create User Rate
POST/api/v3/webhook
Create Webhook
PUT/api/v3/user/:userUUID/rate/:userRateUUID
Update User Rate
PUT/api/v3/user/:userUUID/rate/:userRateUUID/default
Set Default User Rate
1 endpoint changed.
POST/api/v3/project/:projectUUID/download
Download Project Translations Async
We started tracking the wxrks API surface today, covering 148 documented endpoints across 19 sections along with their parameters, request bodies and response shapes. This entry is the baseline rather than a change. From here on, anything that moves in the API gets an entry on this page.
Wording and structure only. The API itself is unchanged.
No changes in this category.
A call that worked before won't any more, and we're confident of it. The endpoint's gone, authentication changed, the URL's path variables changed, or the request body switched format. These are the ones that need a change on your side.
Something moved that may or may not reach you: a parameter, a header, a field in a request or response example. We can see it changed, but not whether your calls rely on it. A quick look at your integration will tell you.
Purely additive: a new endpoint, a new optional parameter, an extra field in a response. Nothing to change, so pick it up whenever it's useful to you.
How the documentation reads or is organised: wording, a section, a name, which examples are shown. The API behaves exactly as it did, so there's nothing to do here.
Every day we compare the documentation at dev.wxrks.com with the last version we recorded, and list what changed. Each entry is dated the day we found it, and each route links to its section of the documentation.
Most entries are written by that comparison. They say what changed, not whether it affects you. That depends on how you call the API. When we've reviewed a change ourselves, the entry has a What to do note.
We track the documentation, not the API itself. If something changes before the documentation does, it won't show here, so please tell us when you spot one.