{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions SearchIndex API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "SearchIndex",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a follower",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/searchIndexes/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a user identified by `userId` as followed of this SearchIndex"
        },
        {
          "info": {
            "name": "Get sample data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes/:id/sampleData",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              }
            ]
          },
          "docs": "Get sample data from the SearchIndex."
        },
        {
          "info": {
            "name": "Add sample data",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/searchIndexes/:id/sampleData",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add sample data to the searchIndex."
        },
        {
          "info": {
            "name": "Bulk create or update search indexes",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/searchIndexes/bulk",
            "params": [
              {
                "name": "async",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update multiple search indexes in a single operation. Returns a BulkOperationResult with success/failure details for each search index."
        },
        {
          "info": {
            "name": "List searchIndexes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "Filter SearchIndexes by service name"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number SearchIndexes returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of SearchIndexes before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of SearchIndexes after this cursor"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a list of SearchIndexes, 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 SearchIndex",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/searchIndexes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a SearchIndex under an existing `service`."
        },
        {
          "info": {
            "name": "Update SearchIndex",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/searchIndexes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a SearchIndex, it it does not exist or update an existing SearchIndex."
        },
        {
          "info": {
            "name": "Get a SearchIndex by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the SearchIndex"
              },
              {
                "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 SearchIndex by fully qualified name."
        },
        {
          "info": {
            "name": "Update a SearchIndex using name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/searchIndexes/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the SearchIndex"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing SearchIndex using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a SearchIndex by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/searchIndexes/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 SearchIndex"
              }
            ]
          },
          "docs": "Delete a SearchIndex by `fullyQualifiedName`."
        },
        {
          "info": {
            "name": "Get a SearchIndex by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              },
              {
                "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 SearchIndex by `id`."
        },
        {
          "info": {
            "name": "Update a SearchIndex",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/searchIndexes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing SearchIndex using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a SearchIndex by id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/searchIndexes/: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 SearchIndex"
              }
            ]
          },
          "docs": "Delete a SearchIndex by `id`."
        },
        {
          "info": {
            "name": "Asynchronously delete a SearchIndex by id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/searchIndexes/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 SearchIndex"
              }
            ]
          },
          "docs": "Asynchronously delete a SearchIndex by `id`."
        },
        {
          "info": {
            "name": "Remove a follower",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/searchIndexes/:id/followers/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              },
              {
                "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 SearchIndex."
        },
        {
          "info": {
            "name": "Get a version of the SearchIndex",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "SearchIndex version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the SearchIndex by given `id`"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes/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 SearchIndex versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/searchIndexes/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the SearchIndex"
              }
            ]
          },
          "docs": "Get a list of all the versions of a SearchIndex identified by `id`"
        },
        {
          "info": {
            "name": "Restore a soft deleted SearchIndex",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/searchIndexes/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted SearchIndex."
        },
        {
          "info": {
            "name": "Update Vote for a Entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/searchIndexes/: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
}