reference
Work Packages
11 endpoints
GET/api/v3/work-packages
List Work Packages
Requires: TASK_assign
Lists work packages by one filter: sourceProject (the project you sent from), destProject (the project created in the vendor account) or state. With sourceProject or destProject, state narrows the result; alone, state lists the work packages your account sent or received in that state. Only work packages your account takes part in are returned.
query parameters
sourceProject |
string (uuid)Project the work packages were sent from. |
destProject |
string (uuid)Project created in the vendor account. |
state |
stringPENDING REPLICATED DELIVERED FAILED CANCELLEDWork package state. |
Responses
200 OK
attemptCount |
integer |
createdAt |
integer (int64) |
createdByUserUuid |
string (uuid) |
deliveredWuCount |
integer |
delivering |
boolean |
destAccountName |
string |
destAccountUuid |
string (uuid) |
destProjectUuid |
string (uuid) |
failedWuCount |
integer |
handshakeUuid |
string (uuid) |
sourceProjectUuid |
string (uuid) |
state |
string |
stateUpdatedAt |
integer (int64) |
tempGlossaryUuid |
string (uuid) |
tempResourcesProvisioning |
boolean |
tempTmUuid |
string (uuid) |
totalWuCount |
integer |
uuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/work-packages' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
Response 200
[
{
"attemptCount": 0,
"createdAt": 0,
"createdByUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveredWuCount": 0,
"delivering": false,
"destAccountName": "string",
"destAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"destProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"failedWuCount": 0,
"handshakeUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "string",
"stateUpdatedAt": 0,
"tempGlossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tempResourcesProvisioning": false,
"tempTmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalWuCount": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
POST/api/v3/work-packages
Send Work Package
Requires: TASK_assign
Sends work units of an APPROVED project of your account to another wxrks account, the vendor, which must have accepted your work package handshake for the destination org unit destClientUuid.
- The vendor account gets a new project in that org unit with the work units, their files and translations; the response is
PENDINGuntil the content is copied (REPLICATED). workUnitUuidsandworkflowsnarrow what is sent; leave both out to send the whole project. Every step sent must exist in the vendor account's workflow catalog.- The source tasks move to
ASSIGNED.vendorUserUuid, a vendor user of your account, is assigned to them so their cost uses that user's rate; it never reaches the vendor account. sendReferenceFilescopies the project's reference files, andsendInstructionssendsinstructions.
Request body
destAccountUuid |
string (uuid) |
destClientUuid |
string (uuid) |
instructions |
string |
sendInstructions |
boolean |
sendReferenceFiles |
boolean |
sourceProjectUuid |
string (uuid) |
vendorUserUuid |
string (uuid) |
workUnitUuids |
string (uuid)[] |
workflows |
string[] |
Responses
201 Created
attemptCount |
integer |
createdAt |
integer (int64) |
createdByUserUuid |
string (uuid) |
deliveredWuCount |
integer |
delivering |
boolean |
destAccountName |
string |
destAccountUuid |
string (uuid) |
destProjectUuid |
string (uuid) |
failedWuCount |
integer |
handshakeUuid |
string (uuid) |
sourceProjectUuid |
string (uuid) |
state |
string |
stateUpdatedAt |
integer (int64) |
tempGlossaryUuid |
string (uuid) |
tempResourcesProvisioning |
boolean |
tempTmUuid |
string (uuid) |
totalWuCount |
integer |
uuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/work-packages' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"sourceProjectUuid": "6f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"destAccountUuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"destClientUuid": "7d8e9f0a-1b2c-4d3e-9f4a-5b6c7d8e9f0a",
"workflows": [
"TRANSLATION"
],
"sendReferenceFiles": true
}'
Response 201
{
"attemptCount": 0,
"createdAt": 0,
"createdByUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveredWuCount": 0,
"delivering": false,
"destAccountName": "string",
"destAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"destProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"failedWuCount": 0,
"handshakeUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "string",
"stateUpdatedAt": 0,
"tempGlossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tempResourcesProvisioning": false,
"tempTmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalWuCount": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
GET/api/v3/work-packages/{workPackageUuid}
Get Work Package
Requires: TASK_assign
A work package seen from either account: its state, the projects on both sides and how many work units were delivered or failed.
path parameters
workPackageUuidrequired |
string (uuid)The work package. |
Responses
200 OK
attemptCount |
integer |
createdAt |
integer (int64) |
createdByUserUuid |
string (uuid) |
deliveredWuCount |
integer |
delivering |
boolean |
destAccountName |
string |
destAccountUuid |
string (uuid) |
destProjectUuid |
string (uuid) |
failedWuCount |
integer |
handshakeUuid |
string (uuid) |
sourceProjectUuid |
string (uuid) |
state |
string |
stateUpdatedAt |
integer (int64) |
tempGlossaryUuid |
string (uuid) |
tempResourcesProvisioning |
boolean |
tempTmUuid |
string (uuid) |
totalWuCount |
integer |
uuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/work-packages/3b9e1f7a-2c4d-4e6f-8a1b-5d7c9e2f4a6b' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
Response 200
{
"attemptCount": 0,
"createdAt": 0,
"createdByUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveredWuCount": 0,
"delivering": false,
"destAccountName": "string",
"destAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"destProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"failedWuCount": 0,
"handshakeUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceProjectUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "string",
"stateUpdatedAt": 0,
"tempGlossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tempResourcesProvisioning": false,
"tempTmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalWuCount": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
POST/api/v3/work-packages/{workPackageUuid}/actions/cancel
Cancel Work Package
Requires: TASK_assign
Cancels a work package that is not DELIVERED or CANCELLED yet, in the background (202): the copied content and the temporary TM and glossary in the vendor account are removed. Cancelling either project does the same.
path parameters
workPackageUuidrequired |
string (uuid)The work package. |
Responses
202 Accepted
Request
curl -X POST 'https://app.wxrks.com/api/v3/work-packages/3b9e1f7a-2c4d-4e6f-8a1b-5d7c9e2f4a6b/actions/cancel' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
POST/api/v3/work-packages/{workPackageUuid}/actions/deliver
Deliver Work Package
Requires: TASK_assign
Copies the translations of the vendor project's DELIVERED work units back to the source project and delivers the matching source tasks. It runs in the background (202); follow it with Get Work Package. Delivering the vendor project does this on its own, so call it to bring back work units delivered earlier. It is refused (422) while a delivery is running, and a work package that is not REPLICATED is left as it is.
path parameters
workPackageUuidrequired |
string (uuid)The work package. |
Responses
202 Accepted
Request
curl -X POST 'https://app.wxrks.com/api/v3/work-packages/3b9e1f7a-2c4d-4e6f-8a1b-5d7c9e2f4a6b/actions/deliver' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
POST/api/v3/work-packages/{workPackageUuid}/actions/retry
Retry Work Package
Requires: TASK_assign
Runs a FAILED work package again in the background (202): the copy to the vendor account if it had not finished, otherwise the delivery. Any other state is left as it is.
path parameters
workPackageUuidrequired |
string (uuid)The work package. |
Responses
202 Accepted
Request
curl -X POST 'https://app.wxrks.com/api/v3/work-packages/3b9e1f7a-2c4d-4e6f-8a1b-5d7c9e2f4a6b/actions/retry' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
GET/api/v3/work-packages/handshake
List Work Package Handshakes
Requires: ACCOUNT_manage_work_package_connections
The handshakes your account sent or received, in any status. receiver is true when your account is the vendor side.
Responses
200 OK
allowedOrgUnits |
OrgUnitSummary[] |
createdAt |
integer (int64) |
inviteMessage |
string |
projectNamePrefix |
string |
receiver |
boolean |
receiverAccountName |
string |
receiverAccountUuid |
string (uuid) |
requesterAccountName |
string |
requesterAccountUuid |
string (uuid) |
status |
stringPENDING ACCEPTED |
updatedAt |
integer (int64) |
uuid |
string (uuid) |
Request
curl -X GET 'https://app.wxrks.com/api/v3/work-packages/handshake' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
Response 200
[
{
"allowedOrgUnits": [],
"createdAt": 0,
"inviteMessage": "string",
"projectNamePrefix": "string",
"receiver": false,
"receiverAccountName": "string",
"receiverAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requesterAccountName": "string",
"requesterAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING",
"updatedAt": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
POST/api/v3/work-packages/handshake
Invite Account to Work Package Handshake
Requires: ACCOUNT_manage_work_package_connections
Invites another wxrks account, the vendor, to receive work packages from your account. The handshake is PENDING until the vendor accepts it; there can be one handshake per pair of accounts in each direction. message (at most 1000 characters) is shown to the vendor with the invitation.
query parameters
receiverAccountUuidrequired |
string (uuid)The vendor's wxrks account. |
Request body
message |
string |
Responses
201 Created
allowedOrgUnits |
OrgUnitSummary[] |
createdAt |
integer (int64) |
inviteMessage |
string |
projectNamePrefix |
string |
receiver |
boolean |
receiverAccountName |
string |
receiverAccountUuid |
string (uuid) |
requesterAccountName |
string |
requesterAccountUuid |
string (uuid) |
status |
stringPENDING ACCEPTED |
updatedAt |
integer (int64) |
uuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/work-packages/handshake?receiverAccountUuid=1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"message": "Projects from our marketing team."
}'
Response 201
{
"allowedOrgUnits": [
{}
],
"createdAt": 0,
"inviteMessage": "string",
"projectNamePrefix": "string",
"receiver": false,
"receiverAccountName": "string",
"receiverAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requesterAccountName": "string",
"requesterAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING",
"updatedAt": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
PUT/api/v3/work-packages/handshake/{handshakeUuid}
Update Work Package Handshake
Requires: ACCOUNT_manage_work_package_connections
Changes the org units and the project name prefix of an ACCEPTED handshake your account received. Both fields are replaced, and at least one org unit must remain. Work packages already sent are not moved.
path parameters
handshakeUuidrequired |
string (uuid)The handshake. |
Request body
orgUnitUuids |
string (uuid)[] |
projectNamePrefix |
string |
Responses
200 OK
allowedOrgUnits |
OrgUnitSummary[] |
createdAt |
integer (int64) |
inviteMessage |
string |
projectNamePrefix |
string |
receiver |
boolean |
receiverAccountName |
string |
receiverAccountUuid |
string (uuid) |
requesterAccountName |
string |
requesterAccountUuid |
string (uuid) |
status |
stringPENDING ACCEPTED |
updatedAt |
integer (int64) |
uuid |
string (uuid) |
Request
curl -X PUT 'https://app.wxrks.com/api/v3/work-packages/handshake/2c4e6a8b-0d1f-4a3c-9e5b-7d9f1b3d5f7a' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"orgUnitUuids": [
"7d8e9f0a-1b2c-4d3e-9f4a-5b6c7d8e9f0a",
"0f9e8d7c-6b5a-4f3e-8d2c-1b0a9f8e7d6c"
]
}'
Response 200
{
"allowedOrgUnits": [
{}
],
"createdAt": 0,
"inviteMessage": "string",
"projectNamePrefix": "string",
"receiver": false,
"receiverAccountName": "string",
"receiverAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requesterAccountName": "string",
"requesterAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING",
"updatedAt": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
DELETE/api/v3/work-packages/handshake/{handshakeUuid}
Delete Work Package Handshake
Requires: ACCOUNT_manage_work_package_connections
Removes a handshake your account sent or received, in any status. No new work package can be sent through it; work packages already sent go on.
path parameters
handshakeUuidrequired |
string (uuid)The handshake. |
Responses
204 No Content
Request
curl -X DELETE 'https://app.wxrks.com/api/v3/work-packages/handshake/2c4e6a8b-0d1f-4a3c-9e5b-7d9f1b3d5f7a' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
POST/api/v3/work-packages/handshake/{handshakeUuid}/accept
Accept Work Package Handshake
Requires: ACCOUNT_manage_work_package_connections
Accepts a PENDING invitation your account received. orgUnitUuids, org units of your account, are where the projects of the inviting account's work packages are created; at least one is required. projectNamePrefix (at most 50 characters) is put before the names of those projects.
path parameters
handshakeUuidrequired |
string (uuid)The handshake. |
Request body
orgUnitUuids |
string (uuid)[] |
projectNamePrefix |
string |
Responses
200 OK
allowedOrgUnits |
OrgUnitSummary[] |
createdAt |
integer (int64) |
inviteMessage |
string |
projectNamePrefix |
string |
receiver |
boolean |
receiverAccountName |
string |
receiverAccountUuid |
string (uuid) |
requesterAccountName |
string |
requesterAccountUuid |
string (uuid) |
status |
stringPENDING ACCEPTED |
updatedAt |
integer (int64) |
uuid |
string (uuid) |
Request
curl -X POST 'https://app.wxrks.com/api/v3/work-packages/handshake/2c4e6a8b-0d1f-4a3c-9e5b-7d9f1b3d5f7a/accept' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"orgUnitUuids": [
"7d8e9f0a-1b2c-4d3e-9f4a-5b6c7d8e9f0a"
],
"projectNamePrefix": "ACME"
}'
Response 200
{
"allowedOrgUnits": [
{}
],
"createdAt": 0,
"inviteMessage": "string",
"projectNamePrefix": "string",
"receiver": false,
"receiverAccountName": "string",
"receiverAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requesterAccountName": "string",
"requesterAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING",
"updatedAt": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}