Skip to main content
Skip table of contents

Tokens, Response Codes, Pagination, Methods, Caveats

Lucidum includes query-based APIs for accessing the Lucidum database and the Lab database. This document describes how to use the Lucidum APIs.

Authorization Tokens

There are three tokens for accessing the Lucidum API. You can generate all three tokens from the Lucidum UI.

Lucidum does not support SSO access for the Lucidum API.

  • Basic authorization with Client ID and Secret. Users can generate the Client ID and Secret in the Lucidum UI. The Client ID and Secret will expire in 30 days or after a system restart, whichever is earlier.

  • Permanent API token. Users can generate the permanent API token with the Lucidum API. The token will not expire unless it is re-generated by the user. This token can be used directly in the API request header. You can also generate this token with the Lucidum API.

To generate the Client ID and Secret:

  1. Go to Settings > User Management.

  2. Find your account. Click its Edit link.

  3. In the Edit User page, click the button Generate ClientID/Secret.

  4. Double-click on the Client ID field to copy the value. Save it somewhere safe.

  5. Double-click on the Secret field to copy the value. Save it somewhere safe.

  6. Click the button Generate Token.

  7. Double-click on the Token field to copy the value. Save it somewhere safe. Lucidum will not display this value again.

  8. Click the Confirm button.

Response Codes

The Lucidum APIs can return the following response codes:

Response Code

Description

200

Successful request

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

400001

Invalid numeric operator

400002

Invalid string operator

400003

Invalid Boolean operator

400004

Invalid list operator

400005

Invalid data operator

400006

Invalid page number

400007

Invalid item per page

401001

Invalid token

401002

Invalid collection name

401003

Invalid output field

Pagination

The Lucidum APIs can return multiple pages in a response. Lucidum recommends that you specify a page to return and the number of records to include in the page.

To do so, include the following in the request body:

CODE
"page": {

     "currentPage": 1,

     "itemPerPage": 25

 }

Methods

The Lucidum API supports the following methods:

  • GET (only for querying the lab databases)

  • POST

The Lucidum API requires a POST method instead of a GET method to query the Lucidum databases.

Caveats

  • Lucidum does not support SSO access for the Lucidum API.

  • Lucidum limits API access to the Lucidum database to no more than 10 queries per minute to avoid negative impact on the Lucidum system.

  • The endpoints for the Lucidum APIs are case-sensitive.

  • The Lucidum APIs do not allow you to perform an “OR” operation.

  • You cannot filter on date/time fields in the Lucidum API.

  • You cannot query Smart Labels with the Lucidum API.

  • You cannot query Tags with the Lucidum API.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.