Response Object
DeployR returns a well formated JSON error when something goes wrong. All errors have four properties:
| Property | Description |
|---|---|
| success | false - logical indicating a failure occured for this API call |
| call | The DeployR API call that failed |
| errorCode | The HTTP status code for the error [or] DeployR status code |
| error | A more descriptive message regarding the exception |
Example 400 error:
{
deployr: {
response: {
success: false,
call: "/r/project/execute/script",
errorCode: 400,
error: "Bad Request: invalid data on call"
}
}
}A full list of supported Error Codes can be found here.
Error Codes
The DeployR API returns the appropriate error codes for every request.
| Code | Text |
|---|---|
| 400 | Bad Request: invalid data on call |
| 401 | Unauthorized Access: caller has insufficient privileges |
| 403 | Forbidden Access: caller is unauthorized |
| 404 | The requested resource was not found |
| 405 | HTTP Method Disallowed: disallowed HTTP method on call |
| 409 | Conflict: project is currently busy on call, concurrent call rejected |
| 500 | Internal Server Error |
| 503 | Service Temporarily Unavailable: HTTP session temporarily invalidated |
| 900 | General Server Error: runtime error |
| 910 | Grid Resource Error: max. concurrent live projects exceeded for authenticated user |
| 911 | Grid Resource Error: max. concurrent live projects exceeded for anonymous user |
| 912 | Grid Resource Error: maximum number of concurrent live jobs exceeded for authenticated user |
| 913 | Grid Resource Error: grid resources temporarily exhausted |
| 914 | Grid Resource Error: grid runtime boundary limit exceeded |
| 915 | Grid Resource Error: grid node unresponsive |
| 916 | Grid Resource Error: grid node R session unresponsive |
| 917 | Grid Resource Error: grid node version incompatible with server |
| 940 | Authentication Error: username/password credentials provided are invalid |
| 941 | Authentication Error: user has insufficient privileges to login on the API |
| 942 | Authentication Error: another user has already authentciated on the current HTTP session |
| 943 | Authentication Error: user account has been disabled by the system administrator |
| 944 | Authentication Error: user account has been temporarily locked by the system administrator |
| 945 | Authentication Error: user account password has expired, requires reset |