Errors

The shared error envelope and the registry of stable error codes. See the Errors section of the introduction for the contract.

Schemas#

Error#

Error

The envelope returned by every failed request. See the Errors section of the introduction for the contract: code is stable and machine-readable, message is diagnostic text that may change at any time.

Fields

errorobjectRequired
Show child attributes
- codeenum ErrorCodeRequired
  Registry of stable error codes. New codes may be added in later releases (this is not a breaking change), so treat unrecognized codes as a generic failure.
  Currently one of the following; more may be added:
  JSON_PARSE_ERROR
  The request body could not be parsed as JSON, or is not a JSON object where one is required.
  JSON_SCHEMA_MATCH_ERROR
  The request body parsed as JSON but does not match the endpoint's request schema. The message includes a JSON pointer to the failing field.
  MISSING_PARAMETER
  A required body field is absent. The message names the field.
  INPUT_ERROR
  A field's value is unusable, such as a malformed id or a reference to a scene or resource that does not exist.
  MISSING_QUERY_PARAMETER
  A required query parameter is absent. The message names the parameter.
  INVALID_QUERY_PARAMETER
  A query parameter has an unparseable or out-of-range value. The message names the parameter and echoes the received value.
  OPERATION_FAILED
  The requested operation started but did not complete successfully. The message carries the underlying reason.
  OPERATION_IN_PROGRESS
  The resource is busy with another operation. Retry after it completes. Returned with HTTP 409.
  NOT_FOUND
  The requested resource does not exist. Returned with HTTP 404.
  ESTIMATION_NOT_SUPPORTED
  The scene's machine type or configuration does not support fast print time estimation. Returned with HTTP 422.
  BUILD_VOLUME_LIMIT_EXCEEDED
  The request needs more scenes than the server can hold at once, so it created none. Opening a .form file with more build volumes than the limit returns it. Returned with HTTP 409.
  INTERNAL_ERROR
  A server-side invariant was violated, not attributable to the request. Returned with HTTP 500.
  UNKNOWN_FAILURE
  An unexpected exception occurred inside PreFormServer. Returned with HTTP 500. The message may be empty.
- messagestringRequired
  Human-readable description of what went wrong. Not part of the stable contract. Never match on this string.

ErrorCode#

enum ErrorCode

Registry of stable error codes. New codes may be added in later releases (this is not a breaking change), so treat unrecognized codes as a generic failure.

Currently one of the following; more may be added:

JSON_PARSE_ERROR: The request body could not be parsed as JSON, or is not a JSON object where one is required.
JSON_SCHEMA_MATCH_ERROR: The request body parsed as JSON but does not match the endpoint's request schema. The message includes a JSON pointer to the failing field.
MISSING_PARAMETER: A required body field is absent. The message names the field.
INPUT_ERROR: A field's value is unusable, such as a malformed id or a reference to a scene or resource that does not exist.
MISSING_QUERY_PARAMETER: A required query parameter is absent. The message names the parameter.
INVALID_QUERY_PARAMETER: A query parameter has an unparseable or out-of-range value. The message names the parameter and echoes the received value.
OPERATION_FAILED: The requested operation started but did not complete successfully. The message carries the underlying reason.
OPERATION_IN_PROGRESS: The resource is busy with another operation. Retry after it completes. Returned with HTTP 409.
NOT_FOUND: The requested resource does not exist. Returned with HTTP 404.
ESTIMATION_NOT_SUPPORTED: The scene's machine type or configuration does not support fast print time estimation. Returned with HTTP 422.
BUILD_VOLUME_LIMIT_EXCEEDED: The request needs more scenes than the server can hold at once, so it created none. Opening a .form file with more build volumes than the limit returns it. Returned with HTTP 409.
INTERNAL_ERROR: A server-side invariant was violated, not attributable to the request. Returned with HTTP 500.
UNKNOWN_FAILURE: An unexpected exception occurred inside PreFormServer. Returned with HTTP 500. The message may be empty.