GET /staged_config/flow/applications/active_applications

Gets the list of active flow applications that are in the staged configuration area.

Gets the list of active flow applications that are in the staged configuration area. Active applications are flow applications that are currently in-use by the system. Active applications that are in the staged configuration area are not yet deployed to the system. Changes or modifications to a flow application should always be made to the active applications list. Do not update the default applications list. You must have System Administrator or Security Administrator permissions to use this endpoint.

Table 1. GET /staged_config/flow/applications/active_applications resource details
MIME Type
application/json

Table 2. GET /staged_config/flow/applications/active_applications request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
sort	query	Optional	String	text/plain	Optional - This parameter is used to sort the elements in a list.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3. GET /staged_config/flow/applications/active_applications response codes
HTTP Response Code	Unique Code	Description
200		An array of staged active flow applications. The level_one field is used as the default sort input in ascending order.
422	1005	A field request parameter is not valid.
422	1010	The filter criteria supplied is not valid.
422	1015	The sort field or order is not valid.
500	1020	An error occurred while retrieving the flow applications.

Response Description

An array of staged active flow applications. The level_one field is used as the default sort input in ascending order. A staged active flow application object contains the following fields:

id - Long - The unique ID for the application.
name - String - The system-generated name of the application as it would appear on the Network Activity tab. The Network Activity tab displays only the first three subcategories of the application name
level_one - String - The first category of the application name.
level_two - String - The second category of the application name.
level_three - String - The third category of the application name.
level_four - String - The fourth category of the application name.
level_five - String - The fifth category of the application name.
last_update_time - String - The epoch timestamp, represented in milliseconds, since the application was last modified.

Response Sample


[
    {
        "id": 42,
        "last_update_time": 42,
        "level_five": "String",
        "level_four": "String",
        "level_one": "String",
        "level_three": "String",
        "level_two": "String",
        "name": "String"
    }
]