GET /config/flow/applications/default_applications/{id}

Gets an individual default flow application, as specified by an ID.

Gets an individual default flow application, as specified by the application ID. Default flow applications are read only. They are provided as a system backup in case the configuration of an active flow application is deleted or changed. You must have System Administrator or Security Administrator permissions to use this endpoint.

Table 1. GET /config/flow/applications/default_applications/{id} resource details
MIME Type

application/json

Table 2. GET /config/flow/applications/default_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 default 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 /config/flow/applications/default_applications/{id} response codes
HTTP Response Code Unique Code Description

404

1001

A default flow application does not exist for the specified ID.

422

1005

A field request parameter is not valid.

422

1010

The filter criteria supplied i snot valid.

422

1015

The sort field or order is not valid.

500

1020

An error occurred while retrieving the flow applications.

Response Description

The default flow application for the specified ID. A default 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"
}