{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Classifications API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Classifications", "type": "folder" }, "items": [ { "info": { "name": "List classifications", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/classifications", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "disabled", "value": "", "type": "query", "description": "Filter Disabled Classifications" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number classifications returned. (1 to 1000000, default = 10) " }, { "name": "before", "value": "", "type": "query", "description": "Returns list of classifications before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of classifications after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of classifications." }, { "info": { "name": "Create a classification", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/classifications", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new classification. The request can include the children tags to be created along with the classification." }, { "info": { "name": "Update a classification", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/classifications", "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing category identify by category name" }, { "info": { "name": "Get a classification by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/classifications/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the classification" }, { "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 classification identified by name. The response includes classification information along with the entire hierarchy of all the children tags." }, { "info": { "name": "Delete classification by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/classifications/name/:name", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "name", "value": "", "type": "path", "description": "Name of the classification" } ] }, "docs": "Delete a classification by `name` and all the tags under it." }, { "info": { "name": "Get a classification by id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/classifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the classification" }, { "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 classification by `id`" }, { "info": { "name": "Update a classification", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/classifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the classification" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing classification using JsonPatch." }, { "info": { "name": "Delete classification by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/classifications/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the classification" } ] }, "docs": "Delete a classification and all the tags under it." }, { "info": { "name": "Asynchronously delete classification by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/classifications/async/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the classification" } ] }, "docs": "Asynchronously delete a classification and all the tags under it." }, { "info": { "name": "Get a version of the classification", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/classifications/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the classification" }, { "name": "version", "value": "", "type": "path", "description": "classification version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the classification by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/classifications/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 classification versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/classifications/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the classification" } ] }, "docs": "Get a list of all the versions of a classification identified by `id`" }, { "info": { "name": "Update a classification using name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/classifications/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the classification" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing classification using JsonPatch." }, { "info": { "name": "Restore a soft deleted classification", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/classifications/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted classification." }, { "info": { "name": "Bulk Add Classification Tag to Assets", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/tags/:id/assets/add", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Classification Tag to Assets" }, { "info": { "name": "Bulk Remove Tag from Assets", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/tags/:id/assets/remove", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Tag from Assets" }, { "info": { "name": "List tags", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags", "params": [ { "name": "parent", "value": "", "type": "query", "description": "List tags filtered by children of tag identified by fqn given in `parent` parameter. The fqn can either be classificationName or fqn of a parent tag" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "disabled", "value": "", "type": "query", "description": "Filter Disabled Classifications" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number tags returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of tags before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of tags after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of tags. 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 tag", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/tags", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tag." }, { "info": { "name": "Create or update a tag", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/tags", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tag, if it does not exist or update an existing tag." }, { "info": { "name": "Get a tag by fully qualified name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the tag" }, { "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 tag by `fullyQualifiedName`." }, { "info": { "name": "Update a tag using name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/tags/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the tag" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing tag using JsonPatch." }, { "info": { "name": "Delete a tag by fully qualified name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/tags/name/:fqn", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the tag" } ] }, "docs": "Delete a tag by `fullyQualifiedName`." }, { "info": { "name": "Get a tag by id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the tag" }, { "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 tag by `id`." }, { "info": { "name": "Update a tag", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/tags/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the tag" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing tag using JsonPatch." }, { "info": { "name": "Delete a tag by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/tags/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the tag" } ] }, "docs": "Delete a tag by `id`." }, { "info": { "name": "Asynchronously delete a tag by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/tags/async/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the tag" } ] }, "docs": "Asynchronously delete a tag by `id`." }, { "info": { "name": "Get all tags with their asset counts", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/assets/counts" }, "docs": "Get a map of tag fully qualified names to their asset counts using search aggregation." }, { "info": { "name": "Get all pending feedback", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/feedback/pending" }, "docs": "Get all feedback entries pending review across all tags" }, { "info": { "name": "Get feedback by ID", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/feedback/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the feedback" } ] }, "docs": "Get a specific feedback entry by its ID" }, { "info": { "name": "Get all feedback for a tag", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/name/:fqn/feedback", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the tag" } ] }, "docs": "Get all feedback entries for a specific tag" }, { "info": { "name": "Submit feedback on auto-applied tag", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/tags/name/:fqn/feedback", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the tag" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit user feedback when a recognizer incorrectly applies this tag" }, { "info": { "name": "Get a version of the tags", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the tag" }, { "name": "version", "value": "", "type": "path", "description": "tag version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the tag by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/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": "Lists a tag's recognizers", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/name/:fqn/recognizers", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully Qualified Name of the tag in question" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number tags returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of tags before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of tags after this cursor" } ] }, "docs": "Paginated endpoint to return a tag's recognizer list" }, { "info": { "name": "Lists a tag's recognizers", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/:id/recognizers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the tag in question" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number tags returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of tags before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of tags after this cursor" } ] }, "docs": "Paginated endpoint to return a tag's recognizer list" }, { "info": { "name": "List assets tagged with this tag", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/:id/assets", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the tag" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of assets returned. (1 to 1000, default = 100)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset for pagination (default = 0)" } ] }, "docs": "Get a paginated list of assets that have this tag applied. Use limit and offset query params for pagination." }, { "info": { "name": "List assets tagged with this tag by fully qualified name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/name/:fqn/assets", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the tag" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of assets returned. (1 to 1000, default = 100)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset for pagination (default = 0)" } ] }, "docs": "Get a paginated list of assets that have this tag applied. Use limit and offset query params for pagination." }, { "info": { "name": "List tag versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/tags/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the tag" } ] }, "docs": "Get a list of all the versions of a tag identified by `id`" }, { "info": { "name": "Restore a soft deleted tag.", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/tags/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted tag." } ] } ], "bundled": true }