Jump to

• Request
• Response

Returns the parameterValue business objects for the specified Job ID. (Deprecated since 24.2)

get

/api/restapi/pims/parameterValues/byJobId

Returns the parameterValue business objects for the specified Job ID

Request

Query Parameters

• jobId(required): integer(int64)
  ID of flow instance object.
  This is a required field.

  Default Value: 0
• paramName(required): string
  The name of the parameter.
  This is a required field.

  Default Value:

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root 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.

{
    "title":"ParameterValue",
    "required":[
        "id",
        "parameter",
        "value"
    ],
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The value of the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the parameter value generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parameter":{
            "$ref":"#/components/schemas/Parameter",
            "exampleSetFlag":false
        }
    },
    "description":"The list of parameter values associated with a flow schedule.",
    "xml":{
        "name":"ParameterValue"
    },
    "exampleSetFlag":false
}

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.

{
    "title":"Parameter",
    "required":[
        "appTitle",
        "customerDefined",
        "defaultValue",
        "description",
        "enumOptions",
        "group",
        "id",
        "name",
        "seqNo",
        "side",
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the parameter generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "type":{
            "type":"string",
            "description":"The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.",
            "xml":{
                "name":"ParameterType"
            },
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "String",
                "Int",
                "Double",
                "DateTime",
                "Boolean",
                "Enum",
                "Password",
                "Filter",
                "Custom",
                "HiddenString",
                "Group",
                "File"
            ]
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "title":{
            "type":"string",
            "description":"The title of the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "group":{
            "type":"string",
            "description":"The parameter group associated with the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "enumOptions":{
            "type":"string",
            "description":"The enumeration options associated with a parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "seqNo":{
            "type":"integer",
            "description":"The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "side":{
            "type":"string",
            "description":"The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI.",
            "xml":{
                "name":"FlowSide"
            },
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "Source",
                "Destination",
                "PDI"
            ]
        },
        "customerDefined":{
            "type":"boolean",
            "description":"An indicator which determines whether a parameter is defined by the customer.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "appTitle":{
            "type":"string",
            "description":"The application title associated with the parameter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"A reference to the parameter business object.",
    "xml":{
        "name":"Parameter"
    },
    "exampleSetFlag":false
}

404 Response

The requested Gateway flow parameter value does not exist, or you do not have access to it.

Back to Top