API Documentation
Important
The dab Nexus API is available from version 1.20 onwards.
What is an API?
An API (Application Programming Interface) is a set of rules that allows different software applications to communicate with each other, sharing data, features, and functionality. The Nexus API allows our customers to retrieve information about workspaces, tasks and runs from dab Nexus, for example for reporting purposes.
What are the main functions of an API?
- Get: e.g. get Task by ID or get Parameter by Analytic Group ID
- Post: e.g. create a Task or cancel a Run
- Put: e.g. update the Task schedule or disable a Task
- Delete: e.g. delete a Workspace or a Task
What is the Nexus API?
The public Nexus API provides programmatic access to dab Nexus. It can be used to manage workspaces, create or schedule analytical tasks, trigger and monitor runs, and resolve object IDs and parameters.
The API offers different functions:
- Get one or all Workspaces by ID or create, update or delete Workspaces
- Get a Task by ID, create a new Task, update the start time or schedule, disable or enable it or delete the Task
- Get a Run by ID or Task ID or cancel it
- Get Object Types like SAP Connections, SQL Connections or Parameter Tables by their ID or name
- Get all Parameters by their Analytic Group ID or the Extraction Package ID
All endpoints are described in this section.
How to connect to the Nexus API
To connect to the API you'll need an API key. Find all information in this article.
HTTP status codes
| Code | Short Explanation | Description |
|---|---|---|
| 200 | OK | API call worked as expected |
| 400 | Bad Request | The request wasn't accepted, often due to missing required parameters |
| 401 | Unauthorized | The API key is not valid |
| 402 | Request Failed | The parameters were valid but the request failed |
| 403 | Forbidden | The API key doesn't have permissions to perform the request |
| 404 | Not Found | The requested resource doesn't exist |
| 409 | Conflict | The request conflicts with another request |
| 424 | External Dependency Failed | The request couldn’t be completed due to a failure in a dependency external to Nexus |
| 429 | Too Many Requests | oo many requests hit the API too quickly |
| 500 502 503 504 | Server Errors | Something went wrong on the dab Nexus side |