{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Test Definitions API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Test Definitions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List test definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dataQuality/testDefinitions",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number test definitions returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of test definitions before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of test definitions after this cursor"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query",
                "description": "Filter by entityType."
              },
              {
                "name": "testPlatform",
                "value": "",
                "type": "query",
                "description": "Filter by a test platform"
              },
              {
                "name": "supportedDataType",
                "value": "",
                "type": "query",
                "description": "Filter tests definition by supported data type"
              },
              {
                "name": "supportedService",
                "value": "",
                "type": "query",
                "description": "Filter test definitions by supported service. Returns test definitions that either have an empty supportedServices list (supporting all services) or include the specified service."
              },
              {
                "name": "enabled",
                "value": "",
                "type": "query",
                "description": "Filter by enabled status (true/false). If not specified, returns all test definitions."
              }
            ]
          },
          "docs": "Get a list of test definitions, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params."
        },
        {
          "info": {
            "name": "Create a test definition",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/dataQuality/testDefinitions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Test definition."
        },
        {
          "info": {
            "name": "Update test definition",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dataQuality/testDefinitions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a test definition, if it does not exist, or update an existing test definition."
        },
        {
          "info": {
            "name": "Get a test definition by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dataQuality/testDefinitions/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the test definition"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a test definition by `name`."
        },
        {
          "info": {
            "name": "Delete a test definition",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dataQuality/testDefinitions/name/:name",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete this entity and it's children. (Default `false`)"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the test definition"
              }
            ]
          },
          "docs": "Delete a test definition by `name`."
        },
        {
          "info": {
            "name": "Get a test definition by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dataQuality/testDefinitions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the test definition"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              },
              {
                "name": "includeRelations",
                "value": "",
                "type": "query",
                "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value."
              }
            ]
          },
          "docs": "Get a Test Definition by `Id`."
        },
        {
          "info": {
            "name": "Update a test definition",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/dataQuality/testDefinitions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the test definition"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Test Definition using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a test definition",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dataQuality/testDefinitions/:id",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete this entity and it's children. (Default `false`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the test definition"
              }
            ]
          },
          "docs": "Delete a test definition by `id`."
        },
        {
          "info": {
            "name": "Asynchronously delete a test definition",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dataQuality/testDefinitions/async/:id",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete this entity and it's children. (Default `false`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the test definition"
              }
            ]
          },
          "docs": "Asynchronously delete a test definition by `id`."
        },
        {
          "info": {
            "name": "Get a version of the test definition",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dataQuality/testDefinitions/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the test definition"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Test Definition version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the test definition by given `Id`"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dataQuality/testDefinitions/history",
            "params": [
              {
                "name": "startTs",
                "value": "",
                "type": "query",
                "description": "Start timestamp in milliseconds since epoch"
              },
              {
                "name": "endTs",
                "value": "",
                "type": "query",
                "description": "End timestamp in milliseconds since epoch"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of entity returned (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of entity versions before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of entity versions after this cursor"
              }
            ]
          },
          "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. "
        },
        {
          "info": {
            "name": "List test definition versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dataQuality/testDefinitions/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the test definition"
              }
            ]
          },
          "docs": "Get a list of all the versions of a test definition identified by `Id`"
        },
        {
          "info": {
            "name": "Restore a soft deleted test definition",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dataQuality/testDefinitions/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted TestDefinition."
        }
      ]
    }
  ],
  "bundled": true
}