Every API here is available over the APIs.io API and to AI agents over MCP.
{"openapi":"3.1.1","info":{"title":"Catalog API","version":"1.0","description":"API for managing the ADOC data catalog, including assets, asset metadata, tags, labels, sampling, lineage, and watched assets, as well as data reliability policies (data quality, reconciliation, data drift, schema drift, and related rule types) and their executions. Covers discovering and searching assets, retrieving asset configuration and activity, and creating, scheduling, and running policies against catalog assets."},"paths":{"/catalog-server/api/assets/{id}/metadata":{"get":{"operationId":"getAssetMetadata","tags":["Asset Metadata"],"summary":"Get asset metadata","description":"Metadata describes basic information about the data, making it easier to locate, use, and reuse specific instances of the data.\n\nThis endpoint retrieves the metadata of a specific asset by its `id`. For example, the metadata of a column name in a table `customer_information` would indicate that the column's data type is of string type.\n\n**Authorization**: requires `ASSET_VIEW` and `ASSET_METADATA_VIEW`.\n\n### Response\n\nReturns `StandardResponse<MetaData>` containing the asset metadata payload.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Asset metadata wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object"}}}}}},"404":{"description":"No Metadata found for assetId {id}"}}}},"/catalog-server/api/assets/{id}/sample/async":{"post":{"operationId":"requestAssetSampleAsync","tags":["Asset Sampling"],"summary":"Request an async sample of asset data","description":"This endpoint initiates an asynchronous request to retrieve sample data of a specified asset by its `id`. If the sample data is not cached, the API returns a job execution status of IN_PROGRESS along with a `requestId`. The client needs to poll the `catalog-server/api/assets/sample/result/{requestId}` endpoint until the job execution status is SUCCESSFUL. Once the result is cached or the job status is SUCCESSFUL, the API retrieves the first 100 rows of the asset's sample data.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n### Request Body\n\nOptional `SampleDataWithTransformUDFsRequest`:\n\n- `invalidateCache` (boolean): Specifies whether the cache should be invalidated. If set to `true`, the API bypasses any cached sample data and initiates a fresh sample generation. If set to `false`, cached data (if available) will be used.\n- Transform UDF fields may also be supplied to apply transformations during sampling.\n\n### Response\n\nReturns `SampleDataApiResponse` with job status and, when complete, sample rows.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sample data request with optional transform UDFs and `invalidateCache` flag.\nSchema: `SampleDataWithTransformUDFsRequest`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SampleDataWithTransformUDFsRequest"}}}},"responses":{"200":{"description":"Sample data response with job status and optional sample rows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SampleDataApiResponse"}}}}}}},"/catalog-server/api/assets/{id}/tags":{"get":{"operationId":"getAssetTagsById","tags":["Asset Tags & Labels"],"summary":"Get tags for an asset","description":"This endpoint retrieves the tags associated with an asset.\n\n**Authorization**: requires `ASSET_VIEW` and `TAGS_VIEW` (feature permission).\n\n### Response\n\nReturns `AssetTagResponse` containing the list of tags linked to the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of asset tags","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTagResponse"}}}}}}},"/catalog-server/api/assets/{id}/tag":{"post":{"operationId":"addAssetTag","tags":["Asset Tags & Labels"],"summary":"Add a tag to an asset","description":"This endpoint is used to add a tag to a specific asset by making an HTTP POST request to the provided URL.\n\n**Authorization**: requires `ASSET_VIEW` and `TAGS_CREATE` (feature permission).\n\n#### Request Body\n\nThe request body should be in raw JSON format (`AssetTagRequest`) and include one of:\n\n- `name` (string): The name of the tag to be added to the asset.\n- `id` (number): The ID of an existing tag to associate with the asset.\n\n#### Response\n\nUpon a successful request, the response will include the following parameters:\n\n- `assetId` (number): The ID of the asset.\n- `autoTagged` (boolean): Indicates if the asset was auto-tagged.\n- `domains` (array): An array of domains.\n- `id` (number): The ID of the tag.\n- `name` (string): The name of the tag.\n- `protectedData` (boolean): Indicates if the data is protected.\n- `state` (string): The state of the tag.\n- `tagId` (number): The ID of the tag.\n- `tenantId` (null): The ID of the tenant.\n- `uid` (null): The unique identifier.\n\n> If autotagging is not enabled and an asset lacks a tag, the POST Add Tags method can be used to create tags for the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tag to associate with the asset (`name` or `id` required). Schema: `AssetTagRequest`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTagRequest"}}}},"responses":{"200":{"description":"Tag association result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTag"}}}}}}},"/catalog-server/api/assets/{id}/tag/{tagId}":{"delete":{"operationId":"deleteAssetTag","tags":["Asset Tags & Labels"],"summary":"Remove a tag from an asset","description":"This endpoint removes the specified tag associated with an asset using the provided `tagId`.\n\n**Authorization**: requires `ASSET_VIEW` and `TAGS_MODIFY` (feature permission).\n\n### Response\n\nReturns `true` when the tag was removed successfully.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"tagId","in":"path","description":"Tag ID to remove","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tag removal result","content":{"application/json":{"schema":{"type":"boolean"}}}}}}},"/catalog-server/api/assets/{id}/labels":{"put":{"operationId":"updateAssetLabels","tags":["Asset Tags & Labels"],"summary":"Update asset labels","description":"This endpoint is used to add, delete, or update labels for a specific asset identified by its `ID`.\n\n**Authorization**: requires `ASSET_VIEW` and `TAGS_MODIFY` (feature permission).\n\n### Request Body\n\nThe request body should contain a JSON object with a \"labels\" key, which is an array of label objects. Each label object should have a \"key\" and \"value\" field. These fields are used to specify the key-value pairs for the labels to be added, deleted, or updated.\n\n- `labels`: An array of label objects, where each object contains the following fields:\n - `key`: Specifies the type or category of information (e.g., \"Confidentiality\").\n - `value`: Provides specific details or levels within that category (e.g., \"High\", \"Medium\", \"Low\").\n\n### Response\n\nReturns the updated list of `Label` objects for the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Label update request. Schema: `AssetLabelRequest`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetLabelRequest"}}}},"responses":{"200":{"description":"Updated labels","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}}}},"get":{"operationId":"getAssetLabels","tags":["Asset Tags & Labels"],"summary":"Get asset labels","description":"This endpoint returns all the labels associated with an asset based on the asset's `ID`.\n\n**Authorization**: requires `ASSET_VIEW` and `TAGS_VIEW` (feature permission).\n\n### Response\n\nReturns a list of `Label` key/value pairs for the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Asset labels","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}}}}},"/catalog-server/api/assets/{id}/watch":{"post":{"operationId":"watchAsset","tags":["Asset Watch"],"summary":"Watch an asset","description":"This endpoint monitors a selected asset by its `ID` and triggers notifications whenever there are changes to the asset.\n\n**Authorization**: requires `ASSET_CONFIGURATION_MODIFY`.\n\n### Response\n\nReturns `Response` confirming the asset was added to the watch list.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Watch added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"403":{"description":"Either the asset is not present, or the user doesn't have permissions to perform the operation."}}},"delete":{"operationId":"unwatchAsset","tags":["Asset Watch"],"summary":"Unwatch an asset","description":"This endpoint removes a selected asset from the watch list by its `ID`. This action will stop all notifications for any changes to the asset.\n\n**Authorization**: requires `ASSET_CONFIGURATION_MODIFY`.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Watch removed successfully"},"403":{"description":"Either the asset is not present, or the user doesn't have permissions to perform the operation."},"404":{"description":"Resource not found"}}}},"/catalog-server/api/assets/{id}/activity":{"get":{"operationId":"getAssetActivity","tags":["Asset Activity"],"summary":"Get asset activity","description":"This endpoint returns the total number of upvotes and downvotes for an asset using the asset's `id`.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n### Response\n\nReturns `AssetActivityInfo` with upvote/downvote counts.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Asset activity log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetActivityInfo"}}}},"404":{"description":"Either the asset is not present, or the user doesn't have permissions to perform the operation."}}}},"/catalog-server/api/assets/{id}/comments":{"get":{"operationId":"getAssetComments","tags":["Asset Activity"],"summary":"Get asset comments","description":"This endpoint retrieves all the comments mentioned for a specific asset identified by its `id`.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n### Response\n\nReturns `AssetCommentResponse` containing the list of comments for the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of comments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCommentResponse"}}}},"404":{"description":"Either the asset is not present, or the user doesn't have permissions to perform the operation."}}}},"/catalog-server/api/assets/{id}/incremental-strategies":{"get":{"operationId":"getIncrementalStrategies","tags":["Asset Configuration"],"summary":"Get incremental profiling strategies","description":"This endpoint makes an HTTP GET request to retrieve the incremental strategies for a specific asset. The response will be a JSON object with an array of \"strategies\", where each strategy object contains the \"description\", \"name\", and \"type\" properties.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n### Response\n\nReturns `IncrementalStrategiesResponse` with the available strategies for the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of incremental strategies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncrementalStrategiesResponse"}}}}}}},"/catalog-server/api/assets/{id}/reference-assets/inferredMetadata":{"get":{"operationId":"getInferredMetadataByAssetId","tags":["Reference Assets"],"summary":"Get inferred reference metadata for an asset","description":"This endpoint retrieves the inferred metadata for a specific asset.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n### Response\n\nReturns `StandardResponse<List<ChildAssetMetadata>>` containing inferred column and schema metadata for reference assets associated with the given asset ID.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Inferred column metadata wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object"}}}}}}}}},"/catalog-server/api/assets/{id}/udf-variables":{"post":{"operationId":"createAssetUdfVariable","tags":["Asset UDF Variables"],"summary":"Create a UDF variable for an asset","description":"This endpoint makes an HTTP POST request to create a user-defined field (UDF) variable for a specific asset.\n\n**Authorization**: requires `ASSET_VIEW` and `USER_DEFINED_FUNCTION_CREATE` (feature permission).\n\n#### Request Body\n\n- `assetId` (number, optional): The ID of the asset (path `id` sets scope when omitted).\n- `key` (string): The key or name of the UDF variable.\n- `value` (string): The value associated with the UDF variable.\n\nSchema: `AssetUDFVariableRequest`.\n\n#### Response Body\n\nThe response body contains the created `AssetUDFVariable` record.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"UDF variable definition (key, value; assetId optional). Schema: `AssetUDFVariableRequest`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUDFVariableRequest"}}}},"responses":{"200":{"description":"Created UDF variable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUDFVariable"}}}},"422":{"description":"Could not create Asset Udf Variable : {message}"}}},"get":{"operationId":"getAssetUdfVariables","tags":["Asset UDF Variables"],"summary":"List UDF variables for an asset","description":"This endpoint retrieves the user-defined variables for a specific asset.\n\n**Authorization**: requires `ASSET_VIEW` and `USER_DEFINED_FUNCTION_VIEW` (feature permission).\n\n### Response\n\nReturns `AssetUDFVariableResponse` containing all UDF variables scoped to the asset.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of UDF variables","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUDFVariableResponse"}}}},"422":{"description":"Could not fetch Asset Udf Variables: {message}"}}}},"/catalog-server/api/assets/{id}/udf-variables/{variableId}":{"put":{"operationId":"updateAssetUdfVariable","tags":["Asset UDF Variables"],"summary":"Update a UDF variable for an asset","description":"This endpoint allows the user to update a specific user-defined field variable for a particular asset.\n\n**Authorization**: requires `ASSET_VIEW` and `USER_DEFINED_FUNCTION_MODIFY` (feature permission).\n\n#### Request Body\n\n- `key` (string, optional): The key of the user-defined field variable.\n- `value` (string, optional): The value of the user-defined field variable.\n\nSchema: `AssetUDFVariableRequest`.\n\n#### Response\n\nReturns the updated `AssetUDFVariable`.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"variableId","in":"path","description":"Variable ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated UDF variable definition. Schema: `AssetUDFVariableRequest`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUDFVariableRequest"}}}},"responses":{"200":{"description":"Updated UDF variable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUDFVariable"}}}},"404":{"description":"Asset Udf Variable {variableId} not found"},"422":{"description":"Could not update Asset Udf Variable: {message}"}}},"delete":{"operationId":"deleteAssetUdfVariable","tags":["Asset UDF Variables"],"summary":"Delete a UDF variable from an asset","description":"This endpoint deletes a specific user-defined function (UDF) variable for a particular asset by its `variableId`.\n\n**Authorization**: requires `ASSET_VIEW` and `USER_DEFINED_FUNCTION_MODIFY` (feature permission).","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"variableId","in":"path","description":"Variable ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"UDF variable deleted successfully"},"404":{"description":"Asset UDF variable with id {variableId} not found"}}},"get":{"operationId":"getAssetUdfVariable","tags":["Asset UDF Variables"],"summary":"Get a specific UDF variable for an asset","description":"This endpoint retrieves user-defined variables for a specific asset using the asset `ID` and `variableId` with this endpoint.\n\n**Authorization**: requires `ASSET_VIEW` and `USER_DEFINED_FUNCTION_VIEW` (feature permission).\n\n### Response\n\nReturns `AssetUDFVariable` with the variable key, value, and identifiers.","parameters":[{"name":"id","in":"path","description":"Asset ID","required":true,"schema":{"type":"integer"}},{"name":"variableId","in":"path","description":"Variable ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UDF variable details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUDFVariable"}}}},"404":{"description":"Asset Udf Variable {variableId} not found"},"422":{"description":"Could not fetch Asset Udf Variable: {message}"}}}},"/catalog-server/api/assets/sample/result/{requestId}":{"get":{"operationId":"getAssetSampleResult","tags":["Asset Sampling"],"summary":"Get sample data result","description":"This endpoint retrieves the status and results of a sample data request, triggered by the `POST /catalog-server/api/assets/{id}/sample/async` endpoint.\n\nThis process involves the following steps:\n\n1. **Poll for Status**: Use the `requestId` to poll the status of the job by making GET requests to the endpoint `catalog-server/api/assets/sample/result/{requestId}`.\n2. **Retrieve Sample Data**: Continue polling until the job execution status is `SUCCESSFUL`. Once successful, the API will retrieve and return the first 100 rows of the asset's sample data.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n### Response\n\nReturns `SampleDataApiResponse` containing execution status and sample data when available.","parameters":[{"name":"requestId","in":"path","description":"Sample request ID","required":true,"schema":{"type":"string"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sample data result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SampleDataApiResponse"}}}},"404":{"description":"Dataplane job not found for requestId: {requestId}"}}}},"/catalog-server/api/assets/byUid/{uid}/watch":{"post":{"operationId":"watchAssetByUid","tags":["Asset Watch"],"summary":"Watch an asset by UID","description":"This endpoint is used to monitor a selected asset by its `UID`. This request will also trigger notifications whenever there are changes to the asset.\n\n**Authorization**: requires `ASSET_CONFIGURATION_MODIFY`. Missing or inaccessible asset returns 403 via `getAssetId`.\n\n### Response\n\nReturns `Response` confirming the asset was added to the watch list.","parameters":[{"name":"uid","in":"path","description":"Asset unique identifier","required":true,"schema":{"type":"string"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Watch added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"403":{"description":"Either the asset is not present, or the user doesn't have permissions to perform the operation."}}},"delete":{"operationId":"unwatchAssetByUid","tags":["Asset Watch"],"summary":"Unwatch an asset by UID","description":"The endpoint is used to remove a selected asset from the watch list by its UID. This request will stop all notifications for any changes to the asset.\n\n**Authorization**: requires `ASSET_CONFIGURATION_MODIFY`. Missing or inaccessible asset returns 403 via `getAssetId`.","parameters":[{"name":"uid","in":"path","description":"Asset unique identifier","required":true,"schema":{"type":"string"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Watch removed successfully"},"403":{"description":"Either the asset is not present, or the user doesn't have permissions to perform the operation."},"404":{"description":"Resource not found"}}}},"/catalog-server/api/asset-types":{"get":{"operationId":"listAssetTypes","tags":["Asset Types"],"summary":"List all asset types","description":"This endpoint retrieves a list of supported asset types.\n\n**Authorization**: requires `ASSET_VIEW`.\n\n**Query parameters**:\n\n- `onlyCrawledAssetTypes` (boolean, optional, default false): When true, return only asset types that have been crawled in the tenant.\n\n### Response\n\nReturns `StandardResponse<List<AssetType>>` containing all supported asset type definitions (or crawled subset when filtered).","parameters":[{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"onlyCrawledAssetTypes","in":"query","description":"Return only asset types that have been crawled (default false)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of asset types wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object"}}}}}}}}},"/catalog-server/api/rules/{id}/schedule":{"put":{"operationId":"setRuleSchedule","tags":["Rules"],"summary":"Toggle schedule for a policy","description":"Enables or disables scheduling for any policy type (data quality, reconciliation,\ndata drift, schema drift, profile anomaly, etc.) and optionally updates the\ncron expression and time zone. Returns the effective schedule after the update.\n\n**Authorization**: requires `ASSET_VIEW` and `POLICY_MODIFY`.\n\n**Request body**: `ScheduleRequest` with required `scheduled`; optional `cronExpression`\nand `timeZone` when updating cron while on or off.\n\n**Supported types**: DATA_QUALITY, DATA_DRIFT, RECONCILIATION, EQUALITY, PROFILE_ANOMALY,\nAUTO_ANOMALY, DATA_CADENCE, SCHEMA_DRIFT.","parameters":[{"name":"id","in":"path","description":"Numeric rule / policy ID","required":true,"schema":{"type":"integer"}},{"name":"accessKey","in":"header","description":"API access key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"secretKey","in":"header","description":"API secret key generated from ADOC UI","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Always set to application/json","required":true,"schema":{"type":"string"}}],"request
# --- truncated at 32 KB (322 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/openapi/_original/acceldata-catalog-api-openapi.json