Show Source

• defaultValue: string
  The default value of the parameter.
• hidden: boolean
  Default Value: false

  An indicator which determines whether the flow parameter is a hidden object.
• 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.

{
    "type":"object",
    "properties":{
        "readOnly":{
            "type":"boolean",
            "description":"An indicator which determines whether the flow parameter is a read-only object.",
            "default":false
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flow parameter generated by the system."
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the parameter."
        },
        "required":{
            "type":"boolean",
            "description":"The parameter that must be present when a flow is run.",
            "default":false
        },
        "parameter":{
            "description":"A reference  to the parameter business object.",
            "$ref":"#/definitions/Parameter"
        },
        "hidden":{
            "type":"boolean",
            "description":"An indicator which determines whether the flow parameter is a hidden object.",
            "default":false
        }
    },
    "description":"A list of flow parameter objects associated with a flow.",
    "xml":{
        "name":"FlowParameter"
    }
}

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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the parameter."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the parameter generated by the system."
        },
        "type":{
            "type":"string",
            "description":"The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.",
            "enum":[
                "STRING",
                "INT",
                "DOUBLE",
                "DATETIME",
                "BOOLEAN",
                "ENUM",
                "PASSWORD",
                "FILTER",
                "CUSTOM",
                "HIDDENSTRING",
                "GROUP",
                "FILE"
            ]
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the parameter."
        },
        "description":{
            "type":"string",
            "description":"A description of the parameter."
        },
        "title":{
            "type":"string",
            "description":"The title of the parameter."
        },
        "customerDefined":{
            "type":"boolean",
            "description":"An indicator which determines whether a parameter is defined by the customer.",
            "default":false
        },
        "seqNo":{
            "type":"integer",
            "format":"int32",
            "description":"The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence."
        },
        "enumOptions":{
            "type":"string",
            "description":"The enumeration options associated with a parameter."
        },
        "appTitle":{
            "type":"string",
            "description":"The application title associated with the parameter."
        },
        "side":{
            "type":"string",
            "description":"The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI.",
            "enum":[
                "SOURCE",
                "DESTINATION",
                "PDI"
            ]
        },
        "group":{
            "type":"string",
            "description":"The parameter group associated with the parameter."
        }
    },
    "description":"PARAM",
    "xml":{
        "name":"Parameter"
    }
}