This project has retired. For details please refer to its Attic page.
Falcon - GET /api/entities/list/:entity-type?fields=:fields

GET /api/entities/list/:entity-type?fields=:fields

Description

Get list of the entities.

Parameters

  • :entity-type can be cluster, feed or process.
  • :fields (optional) additional fields that the client are interested in, separated by commas.
Currently falcon only support status as a valid field.

Results

List of the entities.

Examples

Rest Call

GET http://localhost:15000/api/entities/list/feed
Remote-User: rgautam

Result

{
    "entity": [
        {
            "name": "SampleOutput",
            "type": "feed"
        },
        {
            "name": "SampleInput",
            "type": "feed"
        }
    ]
}

Rest Call

GET http://localhost:15000/api/entities/list/feed?fields=status
Remote-User: rgautam

Result

{
    "entity": [
        {
            "name"  : "SampleOutput",
            "type"  : "feed",
            "status": "RUNNING"
        },
        {
            "name": "SampleInput",
            "type": "feed",
            "status": "RUNNING"
        }
    ]
}