POST /staged_config/flow/applications/active_applications

Create a new active flow application in the staged configuration area.

Create a new active flow application in the staged configuration area. The ID for custom applications should be in the 15,000 - 20,000 range. 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. POST /staged_config/flow/applications/active_applications resource details
MIME Type
application/json

Table 2. POST /staged_config/flow/applications/active_applications request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	header	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. POST /staged_config/flow/applications/active_applications request body details
Parameter	Data Type	MIME Type	Description	Sample
body	Object	application/json	Only id, level_one, level_two, level_three, level_four and level_five fields can be set when creating a staged active flow application. All other fields are ignored. id - Long - The unique ID for the application. 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.	{ "id": 42, "level_five": "String", "level_four": "String", "level_one": "String", "level_three": "String", "level_two": "String" }

Table 4. POST /staged_config/flow/applications/active_applications response codes
HTTP Response Code	Unique Code	Description
201		The active flow application was created in the staged configuration area.
409	2010	The ID for the staged active flow application must be unique.
422	2015	The id field is required, but was not provided.
422	2016	The id field must be between 0 and 2147483647 inclusive.
422	2020	The first category of the application must not be empty.
422	2025	The first category is required, but was not provided.
422	2030	The second category of the application must not be empty if lower level categories are populated.
422	2031	The third category of the application must not be empty if lower level categories are populated.
422	2032	The fourt category of the application must not be empty if lower level categories are populated.
500	1020	An error occurred while retrieving the flow applications.

Response Description

201 response with the new staged active flow application structure. The location header will be set to the URL of the new staged active flow application. 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"
}