Skip to content

Common errors using Data Ocean

Error Details
400 Bad Request - Check your request against the API A software intermediary that allows two applications to talk to each other. It lets products and services communicate with other products and services without having to know how they’re implemented. Definition and ensure the body parameters are in the correct format.If this occurs for a file download, ensure the file size is <20GB. Files larger than 20GBs can only be downloaded in parts using a ranged GET. See CloudFront Guide for more information.
401 Unauthorized - This can be caused by sending a header without a invalid token (including no token or an expired token).
403 Forbidden - The file object is not accessible to the client application performing the request. Make sure your application (with the appropriate Trimble Identity v3 credentials) has access to the resources. Make sure you are sending the correct authentication The process of verifying a claimed Identity (e.g., of a Person, Device, or Application). Typical authentication mechanisms include conventional password schemes, biometrics devices, cryptographic methods, and one-time passwords. information.
404 A file with the specified path, ID and/or version ID was not found. Check the path or ID you are sending with the request.
422 Unprocessable Entity - This indicates that the API input does not meet requirements. Conditions include: incorrect state for the operation and file_id parameter points to a non-existent directory. See additional error 422 details below.
5xx The server failed to fulfill a request. This is a system-level issue. It may be intermittent and resolved after a retry. If the issue persists, contact cloudplatform_support@trimble.com. 500 Errors may be caused by a missing header. When you send your request, you should include an Accept header (Accept: application/typescript).

Errors returned by the service follow a standard format and are designed to be accessible for use in internationalization systems. When the service returns an error due to API input that does not meet requirements, it will use the HTTP 422 (Unprocessable Entity) status code.

The response document returned with an error takes the following form
{
  "attribute1": [{"error": "code1"}, {"error": "code2", "arg1": "arg1_value"}],
  "nested.attribute2": [{"error": "code3"}],
  "base": [{"error": "code4"}]
}

Each key corresponds to a JSONPath expression that corresponds with an attribute within the original request body. For errors within nested objects this will take the form nested.attribute. For errors within array content this takes the form array.I, where I is the 0-indexed location within the array.

Error Definition
blank This attribute is required, but has not been provided.
not_an_object A JSON object is expected here, but was not provided.
is_in_use The profile cannot be deleted because it is currently attached to one or more files and/or directories.
invalid_region The region provided does not exist. A region attribute is included to indicate the region used in the request.
prohibited The provided attribute value is not allowed. A value attribute is included to indicate the invalid value used. An allowed attribute is included with a list of possible values.

Concept Information

Best practices for Data Ocean

Data Ocean concepts and terminology