API Keys
The API Keys window displays a list of API Keys. Also, you can generate new API keys.
Why API Keys are needed: In ADOC, you can perform elemental tasks such as rule execution, starting a crawler, and profiling an asset through direct API calls in addition to the existing UI interface. These sets of exposed APIs are authenticated through a pair of ‘accessKey’ and ‘secretKey’ present in the API request header. This page displays the API keys that you need for using the APIs.
To access the API key page:
- Click Settings from the left pane.
- Click API Keys.
Generating API Keys
To generate new API Keys perform the following steps:
- Click the Generate API Key button to proceed to the Generate API Key page.
- Enter a Display Name and select a validity date from the calendar.
- Click the Generate Key button.
- Click the Download API Key button to download the secret and access keys.
Rule Execution
Request
Request Parameters(mandatory)
- Headers
- accessKey(string)
- secretKey(string)
- Path parameters
- id - Rule Id (Rule should be enabled)
- Rule Execution Response
{ "execution": { "executionError": null, "executionMode": "API", "executionStatus": "RUNNING", "finishedAt": null, "id": 120, "lastMarker": null, "leftLastMarker": null, "resultStatus": "RUNNING", "rightLastMarker": null, "ruleId": 24, "ruleName": "example_fb_policy", "ruleType": "DATA_QUALITY", "startedAt": "2021-01-31T21:24:52.104+05:30" }, "items": [ { "analyticsPipelineName": "default", "businessItemId": null, "error": null, "executionId": 120, "finishedAt": null, "id": 114, "requestId": "d21dacc1-2532-4405-b909-9f689b531206", "result": null, "rowsFailed": null, "rowsScanned": null, "ruleItemId": 22, "sparkClusterContext": "LOCAL", "startedAt": "2021-01-31T21:24:52.121+05:30", "threshold": 100.0 } ]}- Incorrect API Key Response
{ "errors": [ { "details": null, "message": "Unauthorised:: Authorisation through API Keys failed", "status": 401 } ]}Was this page helpful?