Returns the flowParameter business object for the specified flowParameter ID.
get
/gatewayapi/restapi/v1/flowParameters/{id}
Request
Path Parameters
-
id: integer(int64)
ID of flow parameter object.Default Value:
0
Response
Supported Media Types
- application/json
200 Response
successful operation
A list of flow parameter objects associated with a flow.
Root Schema : FlowParameter
Type:
object
A list of flow parameter objects associated with a flow.
Show Source
-
defaultValue:
string
The default value of the parameter.
- hidden: boolean
-
id:
integer(int64)
The unique ID of the flow parameter generated by the system.
-
parameter:
object Parameter
PARAM
-
readOnly:
boolean
Default Value:
false
An indicator which determines whether the flow parameter is a read-only object. -
required:
boolean
Default Value:
false
The parameter that must be present when a flow is run.
Nested Schema : Parameter
Type:
object
PARAM
Show Source
-
appTitle:
string
The application title associated with the parameter.
-
customerDefined:
boolean
Default Value:
false
An indicator which determines whether a parameter is defined by the customer. -
defaultValue:
string
The default value of the parameter.
-
description:
string
A description of the parameter.
-
enumOptions:
string
The enumeration options associated with a parameter.
-
group:
string
The parameter group associated with the parameter.
-
id:
integer(int64)
The unique ID of the parameter generated by the system.
-
name:
string
The name of the parameter.
-
seqNo:
integer(int32)
The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.
-
side:
string
Allowed Values:
[ "SOURCE", "DESTINATION", "PDI" ]
The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. -
title:
string
The title of the parameter.
-
type:
string
Allowed Values:
[ "STRING", "INT", "DOUBLE", "DATETIME", "BOOLEAN", "ENUM", "PASSWORD", "FILTER", "CUSTOM", "HIDDENSTRING", "GROUP", "FILE" ]
The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
404 Response
The FlowParameter does not exist or you do not have access to it.