Returns all parameterValue business objects. (Deprecated since 24.2)
get
/api/restapi/pims/parameterValues/list
Returns all parameterValue business objects
Request
Query Parameters
-
scheduleId(required): integer(int64)
ID of flow schedule object.
This is a required field.Default Value:0
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ParameterValue>
Type:
array
Title:
Show Source
List<ParameterValue>
-
Array of:
object ParameterValue
Title:
ParameterValue
The list of parameter values associated with a flow schedule.
Nested Schema : ParameterValue
Type:
object
Title:
ParameterValue
The list of parameter values associated with a flow schedule.
Show Source
-
id(required): integer
(int64)
The unique ID of the parameter value generated by the system.
-
parameter(required): object
Parameter
Title:
Parameter
A reference to the parameter business object. -
value(required): string
The value of the parameter.
Nested Schema : Parameter
Type:
object
Title:
Parameter
A reference to the parameter business object.
Show Source
-
appTitle(required): string
The application title associated with the parameter.
-
customerDefined(required): boolean
An indicator which determines whether a parameter is defined by the customer.
-
defaultValue(required): string
The default value of the parameter.
-
description(required): string
A description of the parameter.
-
enumOptions(required): string
The enumeration options associated with a parameter.
-
group(required): string
The parameter group associated with the parameter.
-
id(required): integer
(int64)
The unique ID of the parameter generated by the system.
-
name(required): string
The name of the parameter.
-
seqNo(required): integer
(int32)
The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.
-
side(required): 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(required): string
The title of the parameter.
-
type(required): 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 requested Gateway flow parameter value does not exist, or you do not have access to it.