blob: 98abf466c133849f3e4ad27d2ad8244c6225b151 [file] [log] [blame]
---++ GET api/metadata/discovery/:type/list
* <a href="#Description">Description</a>
* <a href="#Parameters">Parameters</a>
* <a href="#Results">Results</a>
* <a href="#Examples">Examples</a>
---++ Description
Get all dimensions of specified type.
---++ Parameters
* :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines
* cluster <optional query param> Show dimensions related to this cluster.
* doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
---++ Results
List of dimensions that match requested type [and cluster].
---++ Examples
---+++ Rest Call
<verbatim>
GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster&doAs=joe
</verbatim>
---+++ Result
<verbatim>
{
"results": ["sampleIngestProcess","testProcess","anotherProcess"],
"totalSize": 3
}
</verbatim>