API Errors

The standard Technopedia API returns HTTP status codes and JSON-based error codes with error messages.

JSON-based error messages are returned with an error code.
The following example shows the format of the JSON-error message.

"error": {
    "code": "E1234",
    "message": "Error Message"
 }

The following table describes some of the HTTP status codes that might be returned:

Table 1. HTTP Status Codes

HTTP Status Code
Message
Description

200

OK

The request succeeded.

400

Bad request

The request was not understood by the server because the query syntax or URL was malformed.

401

Unauthorized

The request requires user authentication.

404

Not Found

The server did not find anything that matches the Request URI.

500

Internal Server Error

An unexpected error prevented the server from fulfilling the request.

The following table describes some of the API error codes and messages that might be returned and the corresponding HTTP codes:

Table 2. Error Codes

Error Code
Error Message
HTTP code
Message Description

E1000

"<alias_name>" is not referenced in the ORDER BY statement and cannot be returned.

400

An alias that is referenced by the RETURN clause is not referenced by the ORDER BY clause.

E1001

Unknown node "<node_name>" referenced in the query

400

The node that is referenced in the MATCH statement is invalid or unavailable.

E1002

Unknown attribute "<attribute_name>" on node "<node_name>"

400

The attribute is invalid or unavailable.

E1003

Unknown relationship "<relationship_name>"

400

The relationship name that is specified in the MATCH statement is unknown or unavailable.

E1004

The return alias "<alias_name>" was not defined in the query

400

The RETURN clause specifies an alias that is not assigned to a node or relationship in the MATCH statement.

E1008

LIMIT cannot be greater than <max_limit>

400

The LIMIT value specified in the query exceeds the maximum permitted limit, which is 1000.

E1009

"<alias_name>" has not been defined in the query and cannot be returned.

400

To call an alias with the RETURN clause, you must assign that alias to a node or relationship in the MATCH statement.

E1021

The alias "<alias_name>" is a duplicate and cannot be used.

400

The same alias is assigned to more than one node or relationship in the query.

E1022

Invalid TQL: each attribute can only be returned once

400

When you use the RETURN clause to call an attribute more than once, an error is returned. For example, RETURN a.product, a calls the product attribute twice, which results in an error.

E1023

The alias "<alias_name>" does not exist.

400

The referenced alias does not exist.

E1024

Invalid LIMIT value "<limit>" in query

400

The LIMIT value specified in the query is invalid.

E1029

Syntax Error: “<error detail>

400

The error message provides some detail about the type of syntax error.

E2000

"Authorization" header must be formed the following way: "Bearer <oauth2 token>"

400

The authorization header must include the token by using the following format: "Bearer <token>".

E2004

Invalid username or password

401

The username or password is invalid.

E2026

Invalid Token

400

The authorization token is invalid.

E3002

User is unauthorized

403

The user is unauthorized.

E4001

Invalid URL

400

An invalid path is passed to the Technopedia ID endpoint.

E4002

Invalid Technopedia ID

400

The Technopedia ID provided is invalid.

E4003

No Technopedia ID was sent

400

A Technopedia ID is not provided.

E4004

A Technopedia ID was not provided.

404

The Technopedia ID is not found.

API Errors


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.