GET /staged_config/flow/applications/active_applications/{id}

Edit online

Gets an individual active flow application that is in the staged configuration area, as specified by the application ID. 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. Changes or modifications to a flow application should always be made to the active applications list. Do not update the default applications. You must have System Administrator or Security Administrator permissions to use this endpoint.

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

Table 2. GET /staged_config/flow/applications/active_applications/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	The ID number of the active flow application to get.
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.

Table 3. GET /staged_config/flow/applications/active_applications/{id} response codes
HTTP Response Code	Unique Code	Description
200		The staged active flow application for the specified ID.
404	2001	An active flow application for the specified ID does not exist in the staged configuration area.
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

The staged active flow application for the specified ID. An 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"
}