{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Domains API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Domains", "type": "folder" }, "items": [ { "info": { "name": "Add a follower", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:id/followers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the DataProduct" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user identified by `userId` as followed of this DataProduct" }, { "info": { "name": "Bulk Add Assets", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:name/assets/add", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Data product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Assets" }, { "info": { "name": "Bulk Add Input Ports", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:name/inputPorts/add", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Input Ports to a Data Product" }, { "info": { "name": "Bulk Add Input Ports by Name", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/name/:fqn/inputPorts/add", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Input Ports to a Data Product by fully qualified name" }, { "info": { "name": "Bulk Add Output Ports", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:name/outputPorts/add", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Output Ports to a Data Product" }, { "info": { "name": "Bulk Add Output Ports by Name", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/name/:fqn/outputPorts/add", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Output Ports to a Data Product by fully qualified name" }, { "info": { "name": "Bulk Remove Assets", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:name/assets/remove", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Assets" }, { "info": { "name": "Bulk Remove Input Ports", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:name/inputPorts/remove", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Input Ports from a Data Product" }, { "info": { "name": "Bulk Remove Input Ports by Name", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/name/:fqn/inputPorts/remove", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Input Ports from a Data Product by fully qualified name" }, { "info": { "name": "Bulk Remove Output Ports", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:name/outputPorts/remove", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Output Ports from a Data Product" }, { "info": { "name": "Bulk Remove Output Ports by Name", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/name/:fqn/outputPorts/remove", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the Data Product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Output Ports from a Data Product by fully qualified name" }, { "info": { "name": "List dataProducts", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "domain", "value": "", "type": "query", "description": "Filter data products by domain name" }, { "name": "limit", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of DataProduct before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of DataProduct after this cursor" } ] }, "docs": "Get a list of DataProducts." }, { "info": { "name": "Create a dataProduct", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/dataProducts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new dataProduct." }, { "info": { "name": "Create or update a dataProduct", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a dataProduct. if it does not exist. If a dataProduct already exists, update the dataProduct." }, { "info": { "name": "Get a dataProduct by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the dataProduct" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" } ] }, "docs": "Get a dataProduct by `name`." }, { "info": { "name": "Delete a dataProduct by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/dataProducts/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the dataProduct" } ] }, "docs": "Delete a dataProduct by `name`." }, { "info": { "name": "Get a dataProduct by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "id", "value": "", "type": "path", "description": "Id of the dataProduct" } ] }, "docs": "Get a dataProduct by `Id`." }, { "info": { "name": "Update a dataProduct", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/dataProducts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the dataProduct" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing dataProduct using JsonPatch." }, { "info": { "name": "Delete a dataProduct by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/dataProducts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the dataProduct" } ] }, "docs": "Delete a dataProduct by `Id`." }, { "info": { "name": "Asynchronously delete a dataProduct by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/dataProducts/async/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the dataProduct" } ] }, "docs": "Asynchronously delete a dataProduct by `Id`." }, { "info": { "name": "Remove a follower", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/dataProducts/:id/followers/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" }, { "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 dataProduct." }, { "info": { "name": "Get all data products with their asset counts", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/assets/counts" }, "docs": "Get a map of data product fully qualified names to their asset counts using search aggregation." }, { "info": { "name": "Get assets for a data product", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/assets", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the data product" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. Maximum of 1000 records will be returned in a single request." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of assets belonging to a data product." }, { "info": { "name": "Get assets for a data product by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/name/:fqn/assets", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the data product" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. Maximum of 1000 records will be returned in a single request." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of assets belonging to a data product by data product name." }, { "info": { "name": "Get data contract for a data product", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/dataContract", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" } ] }, "docs": "Get the data contract associated with a data product." }, { "info": { "name": "Get input ports for a data product", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/inputPorts", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned" }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of input ports (data assets consumed) for a data product." }, { "info": { "name": "Get input ports for a data product by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/name/:fqn/inputPorts", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned" }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of input ports (data assets consumed) for a data product by name." }, { "info": { "name": "Get output ports for a data product", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/outputPorts", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned" }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of output ports (data assets produced/exposed) for a data product." }, { "info": { "name": "Get output ports for a data product by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/name/:fqn/outputPorts", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned" }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of output ports (data assets produced/exposed) for a data product by name." }, { "info": { "name": "Get combined input/output ports view for a data product", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/portsView", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "inputLimit", "value": "", "type": "query", "description": "Limit the number of input ports returned" }, { "name": "inputOffset", "value": "", "type": "query", "description": "Offset for input ports pagination" }, { "name": "outputLimit", "value": "", "type": "query", "description": "Limit the number of output ports returned" }, { "name": "outputOffset", "value": "", "type": "query", "description": "Offset for output ports pagination" } ] }, "docs": "Get a combined view of input and output ports with independent pagination, optimized for lineage-like visualization." }, { "info": { "name": "Get combined input/output ports view for a data product by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/name/:fqn/portsView", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the data product" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "inputLimit", "value": "", "type": "query", "description": "Limit the number of input ports returned" }, { "name": "inputOffset", "value": "", "type": "query", "description": "Offset for input ports pagination" }, { "name": "outputLimit", "value": "", "type": "query", "description": "Limit the number of output ports returned" }, { "name": "outputOffset", "value": "", "type": "query", "description": "Offset for output ports pagination" } ] }, "docs": "Get a combined view of input and output ports with independent pagination by name, optimized for lineage-like visualization." }, { "info": { "name": "Get a version of the dataProduct", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the dataProduct" }, { "name": "version", "value": "", "type": "path", "description": "DataProduct version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the dataProduct by given `Id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/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 dataProduct versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/dataProducts/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the dataProduct" } ] }, "docs": "Get a list of all the versions of a dataProduct identified by `Id`" }, { "info": { "name": "Update a dataProduct by name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/dataProducts/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the dataProduct" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing dataProduct using JsonPatch." }, { "info": { "name": "Update Vote for an Entity", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/dataProducts/:id/vote", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update vote for an Entity" }, { "info": { "name": "Add a follower", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/domains/:id/followers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Domain" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user identified by `userId` as followed of this Domain" }, { "info": { "name": "Bulk Add Assets", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/domains/:name/assets/add", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the domain" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Add Assets" }, { "info": { "name": "Bulk Remove Assets", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/domains/:name/assets/remove", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the domain" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Remove Assets" }, { "info": { "name": "List domains", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of Domain before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of Domain after this cursor" } ] }, "docs": "Get a list of Domains." }, { "info": { "name": "Create a domain", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/domains", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new domain." }, { "info": { "name": "Create or update a domain", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/domains", "body": { "type": "json", "data": "{}" } }, "docs": "Create a domain. if it does not exist. If a domain already exists, update the domain." }, { "info": { "name": "Get a domain by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the domain" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" } ] }, "docs": "Get a domain by `name`." }, { "info": { "name": "Delete a domain by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/domains/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the domain" } ] }, "docs": "Delete a domain by `name`." }, { "info": { "name": "Get a domain by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "id", "value": "", "type": "path", "description": "Id of the domain" } ] }, "docs": "Get a domain by `Id`." }, { "info": { "name": "Update a domain", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/domains/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the domain" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing domain using JsonPatch." }, { "info": { "name": "Delete a domain by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/domains/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the domain" } ] }, "docs": "Delete a domain by `Id`." }, { "info": { "name": "Asynchronously delete a domain by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/domains/async/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the domain" } ] }, "docs": "Asynchronously delete a domain by `Id`." }, { "info": { "name": "Remove a follower", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/domains/:id/followers/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" }, { "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 domain." }, { "info": { "name": "Get all domains with their asset counts", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/assets/counts" }, "docs": "Get a map of domain fully qualified names to their asset counts using search aggregation." }, { "info": { "name": "Get assets for a domain", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/:id/assets", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the domain" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. Maximum of 1000 records will be returned in a single request." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of assets belonging to a domain." }, { "info": { "name": "Get assets for a domain by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/name/:fqn/assets", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the domain" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. Maximum of 1000 records will be returned in a single request." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results" } ] }, "docs": "Get paginated list of assets belonging to a domain by domain name." }, { "info": { "name": "Get a version of the domain", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the domain" }, { "name": "version", "value": "", "type": "path", "description": "Domain version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the domain by given `Id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/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 domains in hierarchical order", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/hierarchy", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query" }, { "name": "directChildrenOf", "value": "", "type": "query", "description": "List domains filtered to retrieve the first level/immediate children of the domain `directChildrenOf` parameter. If not specified, returns only root domains (domains with no parent)." }, { "name": "offset", "value": "", "type": "query", "description": "Offset from which to start returning results (for offset-based pagination)" } ] }, "docs": "Get a list of Domains in hierarchical order." }, { "info": { "name": "List domain versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/domains/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the domain" } ] }, "docs": "Get a list of all the versions of a domain identified by `Id`" }, { "info": { "name": "Update a domain by name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/domains/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the domain" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing domain using JsonPatch." }, { "info": { "name": "Update Vote for an Entity", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/domains/:id/vote", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update vote for an Entity" } ] } ], "bundled": true }