Database API
API Explorer The OpenAPI description for this API is available to view and download here.
The Anywhere Database API is used to retrieve the list of Anywhere Databases that the user has access to.
The retrieved information can then be used as an input to subsequent API calls, such as the Anywhere Project API.
Prerequisites
Section titled “Prerequisites”In order to use the API the user must:
- Must be permissioned in the Accubid Anywhere Manager for “API Data Access” (“Full” permission).
- Must be successfully authenticated via Trimble ID.
Use Cases
Section titled “Use Cases”Retrieve Database List
Section titled “Retrieve Database List”This API allows you to get a list of databases that the current user has access to
How-To Guides
Section titled “How-To Guides”Getting Started
Section titled “Getting Started”- Follow the below instructions regarding authorization
- Follow the instructions regarding authenticating with Trimble Identity.
- Call the database list API to return a list of database names and tokens. Note - database tokens do not change, so they can be saved for future use.
Authorization
Section titled “Authorization”In order to use the API the user must have “Full” permission for “API Data Access” setup in Accubid Anywhere Manager.
Reference
Section titled “Reference”Error Message Table
Section titled “Error Message Table”Please see below table containing the list of currently used error codes
| Code | Description |
|---|---|
| 200 | The request was successful |
| 400 | Parameter(s) are invalid |
| 401 | Request could not be authorized |
| 403 | Request was explicitly forbidden, user does not have access to database |
| 404 | A required reference was not found |
| 409 | Conflict. Database is locked please try again later |