{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Metadata API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Metadata", "type": "folder" }, "items": [ { "info": { "name": "Get a type", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" }, { "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 type by `id`." }, { "info": { "name": "Add or update a Property to an entity", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metadata/types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update a property to an entity type. Properties can only be added to entity type and not property type." }, { "info": { "name": "Update a type", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/metadata/types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing type using JsonPatch." }, { "info": { "name": "Delete a type by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metadata/types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" } ] }, "docs": "Delete a type by `id`." }, { "info": { "name": "List types", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types", "params": [ { "name": "category", "value": "", "type": "query", "description": "Filter types by metadata type category." }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number types returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of types before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of types after this cursor" } ] }, "docs": "Get a list of types. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Create a custom property definition", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/metadata/types", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new custom property definition that can be applied to entities. This creates a property template using existing OpenMetadata data types (String, Integer, Date, Enum, etc.). The created property can then be used to extend metadata for data assets like tables, dashboards, and pipelines. Note: This does not create new data types - only custom property definitions." }, { "info": { "name": "Create or update a type", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metadata/types", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new type, if it does not exist or update an existing type." }, { "info": { "name": "Get a type by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the type" }, { "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 type by name." }, { "info": { "name": "Delete a type by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metadata/types/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the type" } ] }, "docs": "Delete a type by `name`." }, { "info": { "name": "Asynchronously delete a type by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metadata/types/async/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" } ] }, "docs": "Asynchronously delete a type by `id`." }, { "info": { "name": "getAllCustomPropertiesByEntityType", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/customProperties" } }, { "info": { "name": "Get custom properties for an entity type", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/name/:entityType/customProperties", "params": [ { "name": "entityType", "value": "", "type": "path", "description": "Name of the entity type" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get custom properties defined for a specific entity type by name." }, { "info": { "name": "getEntityTypeFields", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/fields/:entityType", "params": [ { "name": "entityType", "value": "", "type": "path" }, { "name": "include", "value": "", "type": "query" } ] } }, { "info": { "name": "Get a version of the types", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" }, { "name": "version", "value": "", "type": "path", "description": "type version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the type by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/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 type versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metadata/types/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the type" } ] }, "docs": "Get a list of all the versions of a type identified by `id`" }, { "info": { "name": "Update a type using name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/metadata/types/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the type" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing type using JsonPatch." } ] } ], "bundled": true }