{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Dashboard Data Models API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Dashboard Data Models",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a follower",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dashboard/datamodels/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the data model"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a user identified by `userId` as followed of this data model"
        },
        {
          "info": {
            "name": "Bulk create or update dashboardDataModels",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dashboard/datamodels/bulk",
            "params": [
              {
                "name": "async",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update multiple dashboardDataModels in a single operation. Returns a BulkOperationResult with success/failure details for each dashboardDataModel."
        },
        {
          "info": {
            "name": "List Dashboard Data Models",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "Filter dashboardDataModel by service name"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number dashboardDataModel returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of dashboardDataModel before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of dashboardDataModel after this cursor"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a list of dashboard datamodels, 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 dashboard datamodel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/dashboard/datamodels",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a dashboard datamodel under an existing `service`."
        },
        {
          "info": {
            "name": "Create or update dashboard datamodel",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dashboard/datamodels",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a dashboard datamodel, it it does not exist or update an existing dashboard datamodel."
        },
        {
          "info": {
            "name": "Get a dashboard datamodel by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the dashboard datamodel"
              },
              {
                "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 dashboard datamodel by `fullyQualifiedName`."
        },
        {
          "info": {
            "name": "Update a dashboard datamodel by name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/dashboard/datamodels/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the dashboard datamodel"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing dashboard datamodel using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a data model by fully qualified name.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dashboard/datamodels/name/:fqn",
            "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": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the data model"
              }
            ]
          },
          "docs": "Delete a data model by `fullyQualifiedName`."
        },
        {
          "info": {
            "name": "Get a dashboard datamodel by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the dashboard datamodel"
              },
              {
                "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 dashboard datamodel by `id`."
        },
        {
          "info": {
            "name": "Update a dashboard datamodel",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/dashboard/datamodels/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the dashboard datamodel"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing dashboard datamodel using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a data model by `id`.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dashboard/datamodels/: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 data model"
              }
            ]
          },
          "docs": "Delete a dashboard datamodel by `id`."
        },
        {
          "info": {
            "name": "Asynchronously delete a data model by `id`.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dashboard/datamodels/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 data model"
              }
            ]
          },
          "docs": "Asynchronously delete a dashboard datamodel by `id`."
        },
        {
          "info": {
            "name": "Remove a follower",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/dashboard/datamodels/:id/followers/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the data model"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "Id of the user being removed as follower"
              }
            ]
          },
          "docs": "Remove the user identified `userId` as a follower of the data model."
        },
        {
          "info": {
            "name": "Get data model columns with pagination",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/:id/columns",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the data model"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of columns returned (1 to 1000, default = 50)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (default = 0)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned columns"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a paginated list of data model columns. This endpoint provides server-side pagination to handle data models with large numbers of columns efficiently."
        },
        {
          "info": {
            "name": "Get data model columns with pagination by FQN",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/name/:fqn/columns",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the data model"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of columns returned (1 to 1000, default = 50)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (default = 0)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned columns"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a paginated list of data model columns by fully qualified name. This endpoint provides server-side pagination to handle data models with large numbers of columns efficiently."
        },
        {
          "info": {
            "name": "Get a version of the dashboard datamodel",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the dashboard datamodel"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "DataModel version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the dashboard datamodel by given `id`"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/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 dashboard datamodel versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the dashboard datamodel"
              }
            ]
          },
          "docs": "Get a list of all the versions of a dashboard datamodel identified by `id`"
        },
        {
          "info": {
            "name": "Restore a soft deleted data model.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dashboard/datamodels/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted data model."
        },
        {
          "info": {
            "name": "Search data model columns with pagination by FQN",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/name/:fqn/columns/search",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the data model"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Search query for column names, descriptions, or data types"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of columns returned (1 to 1000, default = 50)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (default = 0)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned columns"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Search data model columns by name, description, or data type with server-side pagination. This endpoint provides efficient search functionality for data models with large numbers of columns."
        },
        {
          "info": {
            "name": "Search data model columns with pagination by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/dashboard/datamodels/:id/columns/search",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the data model"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Search query for column names, descriptions, or data types"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of columns returned (1 to 1000, default = 50)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (default = 0)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned columns"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Search data model columns by name, description, or data type with server-side pagination. This endpoint provides efficient search functionality for data models with large numbers of columns."
        },
        {
          "info": {
            "name": "Update Vote for a Entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/dashboard/datamodels/:id/vote",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Entity"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update vote for a Entity"
        }
      ]
    }
  ],
  "bundled": true
}