{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Test Case Results API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Test Case Results", "type": "folder" }, "items": [ { "info": { "name": "List of test case results for a given test case", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataQuality/testCases/testCaseResults/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the test case" }, { "name": "startTs", "value": "", "type": "query", "description": "Filter testCase results after the given start timestamp" }, { "name": "endTs", "value": "", "type": "query", "description": "Filter testCase results before the given end timestamp" } ] }, "docs": "Get a list of all the test case results for the given testCase FQN, optionally filtered by `startTimestamp` and `endTimestamp`. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Add test case result data to a testCase", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/dataQuality/testCases/testCaseResults/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the test case" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add test case result data to the testCase." }, { "info": { "name": "Update a test case result", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/dataQuality/testCases/testCaseResults/:fqn/:timestamp", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "fqn of the test case" }, { "name": "timestamp", "value": "", "type": "path", "description": "Timestamp of the testCase result" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing test case using JsonPatch." }, { "info": { "name": "Delete test case result", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/dataQuality/testCases/testCaseResults/:fqn/:timestamp", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the test case" }, { "name": "timestamp", "value": "", "type": "path", "description": "Timestamp of the testCase result" } ] }, "docs": "Delete testCase result for a testCase." }, { "info": { "name": "Latest test case results using search service", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataQuality/testCases/testCaseResults/search/latest", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "testCaseStatus", "value": "", "type": "query", "description": "Status of the test case -- one of Success, Failed, Aborted, Queued" }, { "name": "testCaseFQN", "value": "", "type": "query", "description": "FullyQualifiedName of the test case" }, { "name": "testSuiteId", "value": "", "type": "query", "description": "FullyQualifiedName of the test case" }, { "name": "q", "value": "", "type": "query", "description": "search query term to use in list" } ] }, "docs": "Get latest test case results from the search service. Use `testCaseFQN` to filter the results by test case fully qualified name. Use `testCaseStatus` to filter the results by test case status. Use `fields` to get only necessary fields. " }, { "info": { "name": "List test case results using search service", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataQuality/testCases/testCaseResults/search/list", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number tests case results returned. (1 to 1000000, default = 10)" }, { "name": "offset", "value": "", "type": "query", "description": "Returns list of tests after this offset" }, { "name": "startTimestamp", "value": "", "type": "query", "description": "Start timestamp to list test case from" }, { "name": "endTimestamp", "value": "", "type": "query", "description": "End timestamp to list test case from" }, { "name": "testCaseStatus", "value": "", "type": "query", "description": "Status of the test case -- one of Success, Failed, Aborted, Queued" }, { "name": "testCaseFQN", "value": "", "type": "query", "description": "FullyQualifiedName of the test case" }, { "name": "testSuiteId", "value": "", "type": "query", "description": "Test Suite Id the test case belongs to" }, { "name": "entityFQN", "value": "", "type": "query", "description": "Entity FQN the test case belongs to" }, { "name": "latest", "value": "", "type": "query", "description": "Get the latest test case result for each test case -- requires `testSuiteId`" }, { "name": "testCaseType", "value": "", "type": "query", "description": "Filter for test case result by type (e.g. column, table, all)" }, { "name": "dataQualityDimension", "value": "", "type": "query", "description": "Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.)" }, { "name": "q", "value": "", "type": "query", "description": "search query term to use in list" }, { "name": "queryString", "value": "", "type": "query", "description": "raw elasticsearch query to use in list" } ] }, "docs": "List test case results from the search service. Use `startTimestamp` and `endTimestamp` to filter the results by timestamp. Use `testCaseFQN` to filter the results by test case fully qualified name. Use `testCaseStatus` to filter the results by test case status. Use `fields` to get only necessary fields. " } ] } ], "bundled": true }