Returns all ParameterValue business objects associated with a setting.

get

/gatewayapi/restapi/v1/settings/list

Request

There are no request parameters for this operation.

Response

Supported Media Types

200 Response

successful operation
Body ()
The list of parameter values associated with a flow schedule.
Root Schema : ParameterValue
Type: object
The list of parameter values associated with a flow schedule.
Show Source
Nested Schema : Parameter
Type: object
PARAM
Show Source
  • The application title associated with the parameter.
  • Default Value: false
    An indicator which determines whether a parameter is defined by the customer.
  • The default value of the parameter.
  • A description of the parameter.
  • The enumeration options associated with a parameter.
  • The parameter group associated with the parameter.
  • The unique ID of the parameter generated by the system.
  • The name of the parameter.
  • The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.
  • Allowed Values: [ "SOURCE", "DESTINATION", "PDI" ]
    The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI.
  • The title of the parameter.
  • 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 Settings does not exist or you do not have access to it.