Show Source

• configSteps: boolean
  Default Value: false

  The indicator determines whether to configure steps
• description: string
  A description of the flow.
• destinationApp: object App
  A reference to the App business object.
• disableCompare: boolean
  Default Value: false

  The indicator that determines whether the Compare step is enabled or disabled for a flow.
• enableFeedback: boolean
  Default Value: false

  The indicator which determines whether the feedback step is enabled in a business flow.
• flowDefinition: object FlowDefinition
  The flow definition object associated with a flow.
• flowType: string
  Flow Type
• id: integer(int64)
  The unique ID of the flow generated by the system.
• name: string
  The name of the flow.
• sourceApp: object App
  A reference to the App business object.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flow."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flow generated by the system."
        },
        "description":{
            "type":"string",
            "description":"A description of the flow."
        },
        "flowDefinition":{
            "description":"The flow definition object associated with a flow.",
            "$ref":"#/definitions/FlowDefinition"
        },
        "disableCompare":{
            "type":"boolean",
            "description":"The indicator that determines whether the Compare step is enabled or disabled for a flow.",
            "default":false
        },
        "destinationApp":{
            "description":"A reference to the App business object.",
            "$ref":"#/definitions/App"
        },
        "enableFeedback":{
            "type":"boolean",
            "description":"The indicator which determines whether the feedback step is enabled in a business flow.",
            "default":false
        },
        "sourceApp":{
            "description":"A reference to the App business object.",
            "$ref":"#/definitions/App"
        },
        "flowType":{
            "type":"string",
            "description":"Flow Type"
        },
        "configSteps":{
            "type":"boolean",
            "description":"The indicator determines whether to configure steps",
            "default":false
        }
    },
    "description":"The flow object associated with a flow instance.",
    "xml":{
        "name":"Flow"
    }
}

Show Source

• appInstances: array appInstances
  Unique Items Required: true

  The list of application instances associated with a flow.
• description: string
  A description of the application.
• external: boolean
  Default Value: false

  The indicator which determines whether the provider is external.
• id: integer(int64)
  The unique ID of the application generated by the system.
• name: string
  The name of the application associated with the flow.
• providerName: string
  The Oracle Primavera Gateway provider associated with an application.
• providerPath: 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 Prime application.
• supportFeedback: boolean
  Default Value: false

  The indicator which determines whether the feedback step in a business flow is enabled.
• version: string
  The application version number.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the application associated with the flow."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the application generated by the system."
        },
        "version":{
            "type":"string",
            "description":"The application version number."
        },
        "description":{
            "type":"string",
            "description":"A description of the application."
        },
        "appInstances":{
            "type":"array",
            "description":"The list of application instances associated with a flow.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AppInstance"
            }
        },
        "supportFeedback":{
            "type":"boolean",
            "description":"The indicator which determines whether the feedback step in a business flow is enabled.",
            "default":false
        },
        "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 Prime application."
        },
        "providerName":{
            "type":"string",
            "description":"The Oracle Primavera Gateway provider associated with an application."
        },
        "external":{
            "type":"boolean",
            "description":"The indicator which determines whether the provider is external.",
            "default":false
        }
    },
    "description":"A reference to the App business object.",
    "xml":{
        "name":"App"
    }
}

Show Source

• description: string
  A description of the flow definition.
• hasCompareStep: boolean
  Default Value: false

  An indicator which determines whether the Compare step exists in a flow definition.
• id: integer(int64)
  The unique ID of the flow definition generated by the system.
• isEnabled: boolean
  Default Value: false

  An indicator which determines whether the flow definition is enabled.
• name: string
  The name of the flow definition.
• priority: integer(int32)
  The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
• type: string
  A description of the flow definition type.

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

Show Source

• [0]: object AppInstance
  The list of application instances associated with a flow.

{
    "type":"array",
    "description":"The list of application instances associated with a flow.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AppInstance"
    }
}

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the application instance associated with the application instance ID."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the application instance generated by the system."
        },
        "description":{
            "type":"string",
            "description":"A description of the application instance."
        },
        "app":{
            "description":"A reference to the App business object.",
            "$ref":"#/definitions/App"
        }
    },
    "description":"The list of application instances associated with a flow.",
    "xml":{
        "name":"AppInstance"
    }
}