Data APIs are RESTful API endpoints used to interact with ingested data within the NexusOne platform. This interaction leverages the Ask or Engineer feature.Documentation Index
Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
- Appropriate permission:
nx1_askornx1_engineer - An existing domain created using DataHub
- A previously ingested dataset within a DataHub domain
Create a data API
- Web portal
- REST API
While creating a data API, ensure it’s for a specific purpose. This could be to gather data insights or
perform data transformation.
- Log in to NexusOne.
- On the NexusOne homepage, click Connect.
- Click the plus
+icon in the top right corner of the Data APIs page. - Select a domain relevant to your data.
- Enter the SQL query used to fetch your data.
- Enter a name for your API.
- Select the appropriate role based on the API’s purpose.
- Click Create to generate the new API.
Additional resources
- For an overview of the Connect feature, refer to Connect Overview.
- For more information about the Ask API, refer to Create an Ask API.
- For more information about the Engineer API, refer to Create an Engineer API.
- For more information about roles or permissions, refer to Govern Overview.