Errors · wxrks API

A call that fails answers with an HTTP error status and a wxrks error code that says what kind of failure it was.

For example, asking a project for a status change it cannot make:

{
  "status": 422,
  "code": "BWX-002",
  "message": "BW Error: Unsupported transition: Delivered -> Approved"
}

Error code	Type	Description	Message
`BWX-001`	System error	An internal system error occurred.	A system error occurred.
`BWX-002`	Invalid request or business error	`400`: a parameter or body field is missing, has the wrong type or an unaccepted value, or the body can't be read. `422`: the request is well formed but a business rule refuses it.	Names the parameter or field, and for an enum the accepted values.
`BWX-003`	Parser error	A parsing error occurred.	A parser error occurred.
`BWX-004`	File format error	The file format is not valid.	The file format is not valid.
`BWX-005`	Unsupported operation	This operation cannot be executed.	This operation cannot be executed.
`BWX-403`	Forbidden	The user may not access the resource.	Access denied, with the permission code that was checked, for example `Access denied (GLOSSARY_update).`
`BWX-404`	Not found	The resource or path does not exist.	This page cannot be found.
`BWX-500`	Internal server error	The server could not complete the request. Try again later.	Server is running short. Please try again later.

What to do

BWX-002 with 400: fix the request as the message says; retrying it unchanged fails the same way.
BWX-002 with 422: the call is valid but not allowed in the resource's current state (see the operation's description).
BWX-403: the API user lacks a permission for this call, or the resource belongs to an organization or org unit the user can't reach. Add the user to a permission group that grants it (see Permissions).
BWX-404: check the ids in the path.
BWX-500: retry later, waiting longer between attempts.
BWX-004: the file's type or content does not match what the endpoint expects.