Jump to

• Request
• Response

View a Gateway Flow Parameter (Deprecated since 24.2)

get

/api/restapi/pims/flowParameters/{id}

This endpoint returns Gateway flow parameters that meet the following requirements:

• The object has an ID that matches the value of the {id} path parameter.

Request

Path Parameters

• id(required): integer(int64)
  ID of flow parameter object.

  Default Value: 0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : FlowParameter

Type: object

Title: FlowParameter

A list of flow parameter objects associated with a flow.

Show Source

• defaultValue(required): string
  The default value of the parameter.
• flow(required): object Flow
  Title: Flow

  The flow object associated with a flow instance.
• hidden(required): boolean
  An indicator which determines whether the flow parameter is a hidden object.
• id(required): integer (int64)
  The unique ID of the flow parameter generated by the system.
• parameter(required): object Parameter
  Title: Parameter

  A reference to the parameter business object.
• readOnly(required): boolean
  An indicator which determines whether the flow parameter is a read-only object.
• required(required): boolean
  The parameter that must be present when a flow is run.

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

Nested Schema : Flow

Type: object

Title: Flow

The flow object associated with a flow instance.

Show Source

• configSteps: boolean
  The indicator determines whether to configure steps
• description(required): string
  A description of the flow.
• destinationApp(required): object App
  Title: App

  A reference to the App business object.
• disableCompare(required): boolean
  The indicator that determines whether the Compare step is enabled or disabled for a flow.
• enableFeedback(required): boolean
  The indicator which determines whether the feedback step is enabled in a business flow.
• flowDefinition(required): object FlowDefinition
  Title: FlowDefinition

  The flow definition object associated with a flow.
• flowType: string
  Flow Type
• id(required): integer (int64)
  The unique ID of the flow generated by the system.
• name(required): string
  The name of the flow.
• sourceApp(required): object App
  Title: App

  A reference to the App business object.

{
    "title":"Flow",
    "required":[
        "description",
        "destinationApp",
        "disableCompare",
        "enableFeedback",
        "flowDefinition",
        "id",
        "name",
        "sourceApp"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flow generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowType":{
            "type":"string",
            "description":"Flow Type",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowDefinition":{
            "$ref":"#/components/schemas/FlowDefinition",
            "exampleSetFlag":false
        },
        "disableCompare":{
            "type":"boolean",
            "description":"The indicator that determines whether the Compare step is enabled or disabled for a flow.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "sourceApp":{
            "$ref":"#/components/schemas/App",
            "exampleSetFlag":false
        },
        "destinationApp":{
            "$ref":"#/components/schemas/App",
            "exampleSetFlag":false
        },
        "enableFeedback":{
            "type":"boolean",
            "description":"The indicator which determines whether the feedback step is enabled in a business flow.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "configSteps":{
            "type":"boolean",
            "description":"The indicator determines whether to configure steps",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"The flow object associated with a flow instance.",
    "xml":{
        "name":"Flow"
    },
    "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
}

Nested Schema : App

Type: object

Title: App

A reference to the App business object.

Show Source

• appInstances(required): array appInstances
  Unique Items Required: true

  The list of application instances associated with a flow.
• description(required): string
  A description of the application.
• external: boolean
  The indicator which determines whether the provider is external.
• id(required): integer (int64)
  The unique ID of the application generated by the system.
• name(required): string
  The name of the application associated with the flow.
• providerName(required): string
  The Oracle Primavera Gateway provider associated with an application.
• providerPath(required): string
  The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Cloud application.
• supportFeedback: boolean
  The indicator which determines whether the feedback step in a business flow is enabled.
• version(required): string
  The application version number.

{
    "title":"App",
    "required":[
        "appInstances",
        "description",
        "id",
        "name",
        "providerName",
        "providerPath",
        "version"
    ],
    "type":"object",
    "properties":{
        "providerName":{
            "type":"string",
            "description":"The Oracle Primavera Gateway provider associated with an application.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "type":"string",
            "description":"The name of the application associated with the flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the application generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "version":{
            "type":"string",
            "description":"The application version number.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the application.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "providerPath":{
            "type":"string",
            "description":"The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Cloud application.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "supportFeedback":{
            "type":"boolean",
            "description":"The indicator which determines whether the feedback step in a business flow is enabled.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "external":{
            "type":"boolean",
            "description":"The indicator which determines whether the provider is external.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "appInstances":{
            "uniqueItems":true,
            "type":"array",
            "description":"The list of application instances associated with a flow.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/AppInstance",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"A reference to the App business object.",
    "xml":{
        "name":"App"
    },
    "exampleSetFlag":false
}

Nested Schema : FlowDefinition

Type: object

Title: FlowDefinition

The flow definition object associated with a flow.

Show Source

• description(required): string
  A description of the flow definition.
• hasCompareStep(required): boolean
  An indicator which determines whether the Compare step exists in a flow definition.
• id(required): integer (int64)
  The unique ID of the flow definition generated by the system.
• isEnabled(required): boolean
  An indicator which determines whether the flow definition is enabled.
• name(required): string
  The name of the flow definition.
• priority(required): integer (int32)
  The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
• type(required): string
  A description of the flow definition type.

{
    "title":"FlowDefinition",
    "required":[
        "description",
        "hasCompareStep",
        "id",
        "isEnabled",
        "name",
        "priority",
        "type"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flow definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "priority":{
            "type":"integer",
            "description":"The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flow definition generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "type":{
            "type":"string",
            "description":"A description of the flow definition type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the flow definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "hasCompareStep":{
            "type":"boolean",
            "description":"An indicator which determines whether the Compare step exists in a flow definition.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isEnabled":{
            "type":"boolean",
            "description":"An indicator which determines whether the flow definition is enabled.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"The flow definition object associated with a flow.",
    "xml":{
        "name":"FlowDefinition"
    },
    "exampleSetFlag":false
}

Nested Schema : appInstances

Type: array

Unique Items Required: true

The list of application instances associated with a flow.

Show Source

• Array of: object AppInstance
  Title: AppInstance

  The list of application instances associated with a flow.

{
    "uniqueItems":true,
    "type":"array",
    "description":"The list of application instances associated with a flow.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/AppInstance",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : AppInstance

Type: object

Title: AppInstance

The list of application instances associated with a flow.

Show Source

• app(required): object App
  Title: App

  A reference to the App business object.
• description(required): string
  A description of the application instance.
• id(required): integer (int64)
  The unique ID of the application instance generated by the system.
• name(required): string
  The name of the application instance associated with the application instance ID.

{
    "title":"AppInstance",
    "required":[
        "app",
        "description",
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the application instance associated with the application instance ID.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the application instance generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the application instance.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "app":{
            "$ref":"#/components/schemas/App",
            "exampleSetFlag":false
        }
    },
    "description":"The list of application instances associated with a flow.",
    "xml":{
        "name":"AppInstance"
    },
    "exampleSetFlag":false
}

404 Response

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

Back to Top