Error Handling

When a problem occurs in Launch, an error may be returned in one of the following ways:

API response

When performing an API request that results in an immediate error, an error response will be returned by the API, with the HTTP code reflecting the general type of error that occured.

Resource meta

When performing an API request that results in a delayed error, an asynchronous activity for example, an error may be returned by the API in the {"meta": {"status_details": ... }} of a related resource.

Error Format

Error responses aim to conform to the JSONAPI Errors specification, and will generally adhere to the following structure:

  • id: a unique identifier for this particular occurrence of the problem.
  • status: the HTTP status code applicable to this problem, expressed as a string value.
  • code: an application-specific error code, expressed as a string value.
  • title: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
  • detail: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
  • source: an object containing references to the source of the error, optionally including any of the following members:
    • pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. “/data” for a primary data object, or “/data/attributes/title” for a specific attribute].
  • meta: a meta object containing non-standard meta-information about the error.

For example:

{
  "errors": [
    {
      "id": "8a5526da-ab12-4be9-b084-2efe537f388c",
      "status": "404",
      "code": "not-found",
      "title": "Record Not Found",
      "meta": {
        "request_id": "jfb0dQ2e0XVTkQ6AOfEJFfTDjguw9x3d"
      },
      "source": {
      }
    }
  ]
}

Errors

adapter-type-error

Adapter pretest is only available for SFTP adapters.

authentication-failure

There was an error with the provided IMS access token. Please retry with a valid IMS access token.

connection-refused

Could not establish a connection to the server.

decrypt-bad-passphrase

The passphrase provided did not allow data to be decrypted.

decrypt-failed

The decryption failed. Ensure the key provided works locally. Ensure leading and trailing whitespace is trimmed.

decrypt-no-data

Expected an encrypted private key.

delegate-descriptor-unresolved

The expected extension did not provide a definition of this delegate descriptor. The extension may need to be updated.

deleted-resources

You tried to add deleted resources to the library.

environment-in-use

In order to prevent conflicts each environment can only be used by one library at a time.

environment-required

Build requires an environment.

extension-not-found

An extension that defines some data_element or rule_compnent was not added to the library. Ensure all required extensions including Core have been added to your library.

extension-package-path-error

A path was incorrectly constructed.

extension-package-transform-definition-error

The transform definition is invalid.

extension-package-zip-error

An error occurred while unzipping the ExtensionPackage or zipping the files for distribution.

illegal-custom-code-transform

only Core is allowed to define customeCode.

ims-not-authorized

There was a problem authorizing your account. Please retry again later.

ims-session-error

There was an error with the IMS session. The user should re-login.

internal-error

An unexpected error occurred in the application. The issue is under investigation.

invalid-embed_code

Ensure that you are using a valid embed code and migrating it to a Launch production environment.

invalid-extension_package_id

Extension Package error occured.

invalid-org

Your active Org doesn't have Launch access

library-file-not-found

A required file could not be found.

minification-error

Code could not be compiled due to invalid code or ES6 code.

multiple-revisions

A library can only have one revision of each resource.

no-available-orgs

The user has not been provisioned for an org that has Launch access.

not-authorized

The user doesn't have permissions to perform this action.

not-found

The record could not be found. Verify the id and that the object exists.

not-unique

Some attributes of this resource are in conflict with an existing resource.

read-only

Read only records cannot be modified.

session-timeout

The session has timed out. The user should re-login.

sftp-status-exception

An exception was encountered when using SFTP to connect to the server.

socket-error

Encountered a socket error trying to commumicate with the server.

ssh-disconnect

SSH was disconnected.

ssh-exception

An exception was encountered when using SSH to connect to the server.

timeout-error

Connection to the server timed out.

unknown-error

An unexpected error happened. The dev team is investigating.

unsupported-custom-code-language

A custome code language was supplied that is not supported.

upgraded-extension-required

Build requires an upgraded extension.

upstream-build-required

A successful build for the upstream build is required.