• customization: object Customization
• errMsg: string
  The error message of external flow step.
• externalRequestType: string
  Allowed Values: [ "CUSTOM_STEP", "LOAD_STEP", "SAVE_STEP", "VALIDATE_DEPLOYMENT", "GET_CHILD_FLOWS", "GET_PROJECT_KEY" ]

  External Request Type.
• flowInstance: object FlowInstance
  A reference to the flowInst business object.
• flowStepInstance: object FlowStepInstance
  A reference to the flowStepInst business object.
• id: integer(int64)
  The unique ID of the external step request generated by the system.
• provider: object Provider
• reqData: array reqData
  The request data of external flow step.
• reqPara: array reqData
  The request parameters of external flow step.
• respData: array respData
  The response data of external flow step.
• status: string
  The status of external flow step.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the external step request generated by the system."
        },
        "provider":{
            "description":"The Provider object associated with an external step request",
            "$ref":"#/definitions/ProviderRO"
        },
        "status":{
            "type":"string",
            "description":"The status of external flow step."
        },
        "flowStepInstance":{
            "description":"The flowStepInstance object associated with an external step request",
            "$ref":"#/definitions/FlowStepInstance"
        },
        "flowInstance":{
            "description":"The flowInstance object associated with an external step request",
            "$ref":"#/definitions/FlowInstance"
        },
        "reqData":{
            "type":"array",
            "description":"The request data of external flow step.",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "respData":{
            "type":"array",
            "description":"The response data of external flow step.",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "reqPara":{
            "type":"array",
            "xml":{
                "name":"reqData"
            },
            "description":"The request parameters of external flow step.",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "errMsg":{
            "type":"string",
            "description":"The error message of external flow step."
        },
        "externalRequestType":{
            "type":"string",
            "description":"External Request Type.",
            "enum":[
                "CUSTOM_STEP",
                "LOAD_STEP",
                "SAVE_STEP",
                "VALIDATE_DEPLOYMENT",
                "GET_CHILD_FLOWS",
                "GET_PROJECT_KEY"
            ]
        },
        "customization":{
            "description":"The Customization object associated with an external step request",
            "$ref":"#/definitions/CustomizationRO"
        }
    },
    "description":"A reference to store the request for an external step to run.",
    "xml":{
        "name":"ExternalStepRequest"
    }
}

• classPath: string
• external: boolean
  Default Value: false

  This indicates whether step is external or internal
• getlastPinged: string(date-time)
• guid: string
• id: integer(int64)
• name: string
• sessionId: string
• sessionStart: string(date-time)
• version: string

{
    "type":"object",
    "required":[
        "classPath",
        "id",
        "name",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "classPath":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "sessionId":{
            "type":"string"
        },
        "sessionStart":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"sessionstart"
            }
        },
        "getlastPinged":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"lastpinged"
            }
        },
        "guid":{
            "type":"string"
        },
        "external":{
            "type":"boolean",
            "description":"This indicates whether step is external or internal",
            "default":false
        }
    },
    "xml":{
        "name":"Customization"
    }
}

• childInstances: array childInstances
  A list of child flow instances associated with a flow instance object.
• endTime: string(date-time)
  The end time when a flow instance was completed.
• errorDataDesc: string
  A description of the error data associated with the flow instance.
• externalStepStatus: string
  Custom external step status
• flow: object Flow
  The flow object associated with a flow instance.
• flowDefName: string
  The name of the flow definition.
• flowSchedule: object FlowSchedule
  The flow schedule object associated with a flow instance.
• flowStepInstances: array flowStepInstances
  Unique Items Required: true

  Set of flow step instances
• hostName: string
  The host name associated with a flow instance.
• id: integer(int64)
  The unique ID of the flow instance generated by the system.
• parentFlowInstanceId: integer(int64)
  The unique ID of the parent flow instance associated with the child flow instance.
• startTime: string(date-time)
  The start time of the flow instance.
• status: string
  Allowed Values: [ "New", "Queued", "Running", "Delegated", "On Hold", "Rejected", "Completed", "Completed with Errors", "Failed", "Noop", "Completed with Warnings" ]

  The status of the flow instance. Choices include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, and Completed with Warnings.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flow instance generated by the system."
        },
        "hostName":{
            "type":"string",
            "description":"The host name associated with a flow instance."
        },
        "status":{
            "type":"string",
            "description":"The status of the flow instance. Choices include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, and Completed with Warnings.",
            "enum":[
                "New",
                "Queued",
                "Running",
                "Delegated",
                "On Hold",
                "Rejected",
                "Completed",
                "Completed with Errors",
                "Failed",
                "Noop",
                "Completed with Warnings"
            ]
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end time when a flow instance was completed."
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start time of the flow instance."
        },
        "flow":{
            "description":"The flow object associated with a flow instance.",
            "$ref":"#/definitions/Flow"
        },
        "flowSchedule":{
            "description":"The flow schedule object associated with a flow instance.",
            "$ref":"#/definitions/FlowSchedule"
        },
        "parentFlowInstanceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the parent flow instance associated with the child flow instance."
        },
        "externalStepStatus":{
            "type":"string",
            "description":"Custom external step status"
        },
        "flowStepInstances":{
            "type":"array",
            "description":"Set of flow step instances ",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/FlowStepInstance"
            }
        },
        "childInstances":{
            "type":"array",
            "description":"A list of child flow instances associated with a flow instance object.",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "errorDataDesc":{
            "type":"string",
            "description":"A description of the error data associated with the flow instance."
        },
        "flowDefName":{
            "type":"string",
            "description":"The name of the flow definition."
        }
    },
    "description":"A reference to the flowInst business object.",
    "xml":{
        "name":"FlowInstance"
    }
}

• endTime: string(date-time)
  The end time of the flow step instance.
• errorData: string
  An exception occured. The synchronization has failed.
• errorDataDesc: string
  A description of the error data object associated with a flow step instance.
• externalStepStatus: string
  Custom external step status
• flowInstance: object FlowInstance
  A reference to the flowInst business object.
• flowStep: object FlowStep
  A reference to the flowStep business object.
• flowStepInstanceMessages: array flowStepInstanceMessages
  Unique Items Required: true

  A reference to the flowStepInstMsg business object.
• flowType: string
  Flow Type
• id: integer(int64)
  The unique ID of the flowstep instance generated by the system.
• startTime: string(date-time)
  The start time of the flow step instance.
• status: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]

  The job status associated with the flowstep instance.
• warningData: string
  Depending on the flow, indicates that data is missing or that there is extra data. The synchronization will run and finish. The user should investigate the messages and fix any problems that are found.
• warningDataDesc: string
  A description of the error data associated with the warning data.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flowstep instance generated by the system."
        },
        "status":{
            "type":"string",
            "description":"The job status associated with the flowstep instance.",
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS"
            ]
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end time of the flow step instance."
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start time of the flow step instance."
        },
        "flowInstance":{
            "description":"A reference to the flowInst business object.",
            "$ref":"#/definitions/FlowInstance"
        },
        "externalStepStatus":{
            "type":"string",
            "description":"Custom external step status"
        },
        "flowStepInstanceMessages":{
            "type":"array",
            "description":"A reference to the flowStepInstMsg business object.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/FlowStepInstanceMessage"
            }
        },
        "warningDataDesc":{
            "type":"string",
            "description":"A description of the error data associated with the warning data."
        },
        "warningData":{
            "type":"string",
            "xml":{
                "name":"WarningData"
            },
            "description":"Depending on the flow, indicates that data is missing or that there is extra data. The synchronization will run and finish.  The user should investigate the messages and fix any problems that are found."
        },
        "flowStep":{
            "description":"A reference to the flowStep business object.",
            "$ref":"#/definitions/FlowStep"
        },
        "errorData":{
            "type":"string",
            "description":"An exception occured. The synchronization has failed."
        },
        "errorDataDesc":{
            "type":"string",
            "description":"A description of the error data object associated with a flow step instance."
        },
        "flowType":{
            "type":"string",
            "description":"Flow Type"
        }
    },
    "description":"A reference to the flowStepInst business object.",
    "xml":{
        "name":"FlowStepInstance"
    }
}

• external: boolean
  Default Value: false

  This indicates whether step is external or internal
• getlastPinged: string(date-time)
• guid: string
• id: integer(int64)
• name: string
• path: string
• sessionId: string
• sessionStart: string(date-time)
• type: string
  Allowed Values: [ "TYPE1", "TYPE2" ]

  Provider type: Type1, Type2
• version: string

{
    "type":"object",
    "required":[
        "id",
        "name",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"provider_type"
            },
            "description":"Provider type: Type1, Type2",
            "enum":[
                "TYPE1",
                "TYPE2"
            ]
        },
        "path":{
            "type":"string",
            "xml":{
                "name":"provider_path"
            }
        },
        "version":{
            "type":"string"
        },
        "sessionId":{
            "type":"string"
        },
        "sessionStart":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"sessionstart"
            }
        },
        "getlastPinged":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"lastpinged"
            }
        },
        "guid":{
            "type":"string"
        },
        "external":{
            "type":"boolean",
            "description":"This indicates whether step is external or internal",
            "default":false
        }
    },
    "xml":{
        "name":"Provider"
    }
}

• [0]: string(byte)

{
    "type":"array",
    "description":"The request data of external flow step.",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

• [0]: string(byte)

{
    "type":"array",
    "xml":{
        "name":"reqData"
    },
    "description":"The request parameters of external flow step.",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

• [0]: string(byte)

{
    "type":"array",
    "description":"The response data of external flow step.",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

• [0]: integer(int64)

{
    "type":"array",
    "description":"A list of child flow instances associated with a flow instance object.",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

• 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"
    }
}

• active: boolean
  Default Value: false

  An indicator which determines whether the flow schedule is active.
• description: string
  A description of the flow schedule.
• destinationAppInstance: object AppInstance
  The list of application instances associated with a flow.
• eventListenerInstance: object EventProviderInstance
  A reference to the event listener instance object.
• externalStepStatus: string
  Custom external step status
• flow: object Flow
  The flow object associated with a flow instance.
• flowDefName: string
  The name of the flow definition.
• flowInstRuns: integer(int32)
  The number of flow instance runs associated with a flow schedule.
• id: integer(int64)
  The unique ID of the flow schedule generated by the system.
• isParent: boolean
  Default Value: false

  The indicator that determines whether a flow schedule is a parent object.
• lastCompletionDate: string(date-time)
  The last completion date of the flow schedule.
• lastJobRunStatus: string
  Allowed Values: [ "New", "Queued", "Running", "Delegated", "On Hold", "Rejected", "Completed", "Completed with Errors", "Failed", "Noop", "Completed with Warnings" ]

  The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.
• lastRunJobId: integer(int64)
  The unique ID of the last job run in the flow schedule generated by the system.
• lastStartDate: string(date-time)
  The last start date associated with the flow schedule.
• maxRuns: integer(int32)
  The maximum number of runs allowed for a flow schedule.
• name: string
  The name of the flow schedule.
• nextRunDate: string(date-time)
  The next run date associated with a flow schedule.
• noEndDate: boolean
  Default Value: false

  An indicator which determines whether the flow schedule has no end date specified.
• predecessorFlowScheduleId: integer(int64)
  The predecessor ID of the flow schedule
• predecessorFlowScheduleName: string
  The predecessor Name of the flow schedule
• previousFlowScheduleId: integer(int64)
  Previous FlowSchedule Id
• recurring: boolean
  Default Value: false

  The indicator that determines whether a flow schedule recurs.
• schedule: object Schedule
  The schedule object associated with a flow schedule. This is used for scheduling jobs.
• sourceAppInstance: object AppInstance
  The list of application instances associated with a flow.
• status: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]

  The status of the flow schedule.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flow schedule."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flow schedule generated by the system."
        },
        "description":{
            "type":"string",
            "description":"A description of the flow schedule."
        },
        "status":{
            "type":"string",
            "description":"The status of the flow schedule.",
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS"
            ]
        },
        "schedule":{
            "description":"The schedule object associated with a flow schedule. This is used for scheduling jobs.",
            "$ref":"#/definitions/Schedule"
        },
        "flow":{
            "description":"The flow object associated with a flow instance.",
            "$ref":"#/definitions/Flow"
        },
        "externalStepStatus":{
            "type":"string",
            "description":"Custom external step status"
        },
        "predecessorFlowScheduleId":{
            "type":"integer",
            "format":"int64",
            "description":"The predecessor ID of the flow schedule"
        },
        "predecessorFlowScheduleName":{
            "type":"string",
            "description":"The predecessor Name of the flow schedule"
        },
        "lastCompletionDate":{
            "type":"string",
            "format":"date-time",
            "description":"The last completion date of the flow schedule."
        },
        "sourceAppInstance":{
            "description":"The list of application instances associated with a flow.",
            "$ref":"#/definitions/AppInstance"
        },
        "eventListenerInstance":{
            "description":"The event listener associated with the flow schedule.",
            "$ref":"#/definitions/EventListenerInstance"
        },
        "previousFlowScheduleId":{
            "type":"integer",
            "format":"int64",
            "description":"Previous FlowSchedule Id"
        },
        "lastJobRunStatus":{
            "type":"string",
            "description":"The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.",
            "enum":[
                "New",
                "Queued",
                "Running",
                "Delegated",
                "On Hold",
                "Rejected",
                "Completed",
                "Completed with Errors",
                "Failed",
                "Noop",
                "Completed with Warnings"
            ]
        },
        "destinationAppInstance":{
            "description":"The list of application instances associated with a flow.",
            "$ref":"#/definitions/AppInstance"
        },
        "flowDefName":{
            "type":"string",
            "description":"The name of the flow definition."
        },
        "recurring":{
            "type":"boolean",
            "description":"The indicator that determines whether a flow schedule recurs. ",
            "default":false
        },
        "active":{
            "type":"boolean",
            "description":"An indicator which determines whether the flow schedule is active.",
            "default":false
        },
        "nextRunDate":{
            "type":"string",
            "format":"date-time",
            "description":"The next run date associated with a flow schedule."
        },
        "isParent":{
            "type":"boolean",
            "description":"The indicator that determines whether a flow schedule is a parent object.",
            "default":false
        },
        "maxRuns":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum number of runs allowed for a flow schedule."
        },
        "flowInstRuns":{
            "type":"integer",
            "format":"int32",
            "description":"The number of flow instance runs associated with a flow schedule."
        },
        "lastRunJobId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the last job run in the flow schedule generated by the system."
        },
        "lastStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The last start date associated with the flow schedule."
        },
        "noEndDate":{
            "type":"boolean",
            "description":"An indicator which determines whether the flow schedule has no end date specified.",
            "default":false
        }
    },
    "description":"The flow schedule object associated with a flow instance.",
    "xml":{
        "name":"FlowSchedule"
    }
}

• [0]: object FlowStepInstance
  A reference to the flowStepInst business object.

{
    "type":"array",
    "description":"Set of flow step instances ",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/FlowStepInstance"
    }
}

• 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"
    }
}

• 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"
    }
}

• [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"
    }
}

• 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"
    }
}

• delayInMinutes: integer(int32)
  The delay in minutes before triggering a event-based synchronization job.
• eventDisabled: boolean
  Default Value: false

  The indicator which determines whether the event is disabled or eneabled.
• eventInstanceConfigs: array eventInstanceConfigs
  Unique Items Required: true

  A reference to the eventInstConfig object.
• eventListener: object EventListener
  A reference to the event listener object.
• flowSchedule: object FlowSchedule
  The flow schedule object associated with a flow instance.
• id: integer(int64)
  The unique ID of the event listener instance generated by the system.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the event listener instance generated by the system."
        },
        "eventInstanceConfigs":{
            "type":"array",
            "description":"A reference to the eventInstConfig object.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/EventInstanceConfig"
            }
        },
        "flowSchedule":{
            "description":"The flow schedule object associated with a flow instance.",
            "$ref":"#/definitions/FlowSchedule"
        },
        "delayInMinutes":{
            "type":"integer",
            "format":"int32",
            "description":"The delay in minutes before triggering a event-based synchronization job."
        },
        "eventDisabled":{
            "type":"boolean",
            "description":"The indicator which determines whether the event is disabled or eneabled.",
            "default":false
        },
        "eventListener":{
            "description":"A reference to the event listener object.",
            "$ref":"#/definitions/EventListener"
        }
    },
    "description":"A reference to the event listener instance object.",
    "xml":{
        "name":"EventProviderInstance"
    }
}

• endDate: string(date-time)
  The end date of a schedule.
• predecessorFlowScheduleId: integer(int64)
  The predecessor ID of the schedule
• scheduleExpression: string
  The job schedule in CRON format.
• scheduleId: integer(int64)
  The unique ID of the schedule generated by the system.
• scheduleName: string
  The name of the schedule.
• startDate: string(date-time)
  The start date of a schedule.

{
    "type":"object",
    "properties":{
        "predecessorFlowScheduleId":{
            "type":"integer",
            "format":"int64",
            "description":"The predecessor ID of the schedule"
        },
        "scheduleExpression":{
            "type":"string",
            "description":"The job schedule in CRON format."
        },
        "scheduleId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the schedule generated by the system."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The start date of a schedule."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The end date of a schedule."
        },
        "scheduleName":{
            "type":"string",
            "description":"The name of the schedule."
        }
    },
    "description":"The schedule object associated with a flow schedule. This is used for scheduling jobs.",
    "xml":{
        "name":"Schedule"
    }
}

• [0]: object InstanceConfig
  The value of the event instance configuration.

{
    "type":"array",
    "description":"A reference to the eventInstConfig object.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/EventInstanceConfig"
    }
}

• description: string
  A description of the event listener.
• flowSchedule: object FlowSchedule
  The flow schedule object associated with a flow instance.
• id: integer(int64)
  The unique ID of the event listener generated by the system.
• name: string
  The name of the event listener.
• type: string
  The type of event listener.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the event listener."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the event listener generated by the system."
        },
        "type":{
            "type":"string",
            "description":"The type of event listener."
        },
        "description":{
            "type":"string",
            "description":"A description of the event listener."
        },
        "flowSchedule":{
            "description":"The flow schedule object associated with a flow instance.",
            "$ref":"#/definitions/FlowSchedule"
        }
    },
    "description":"A reference to the event listener object.",
    "xml":{
        "name":"EventListener"
    }
}

• eventConfig: object EventProviderConfig
  A reference to the eventConfig object.
• eventListenerInstance: object EventProviderInstance
  A reference to the event listener instance object.
• id: integer(int64)
  The ID of the eventInstConfig object generated by the system.
• value: string
  The value of the event instance configuration.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The value of the event instance configuration."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the eventInstConfig object generated by the system."
        },
        "eventListenerInstance":{
            "description":"EVENTLISTENERINST",
            "$ref":"#/definitions/EventListenerInstance"
        },
        "eventConfig":{
            "description":"A reference to the eventConfig object.",
            "$ref":"#/definitions/EventConfig"
        }
    },
    "description":"The value of the event instance configuration.",
    "xml":{
        "name":"InstanceConfig"
    }
}

• id: integer(int64)
  The unique ID of the event configuration generated by the system.
• name: string
  The name of the event configuration.
• title: string
  The title of the event configuration.
• type: string
  Allowed Values: [ "String", "Integer", "Double", "Boolean", "HiddenString", "Criteria" ]

  The type of event configuration. Choices include: String, Integer, Double, Boolen, HiddenString, and Criteria.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the event configuration."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the event configuration generated by the system."
        },
        "type":{
            "type":"string",
            "description":"The type of event configuration. Choices include: String, Integer, Double, Boolen, HiddenString, and Criteria.",
            "enum":[
                "String",
                "Integer",
                "Double",
                "Boolean",
                "HiddenString",
                "Criteria"
            ]
        },
        "title":{
            "type":"string",
            "description":"The title of the event configuration."
        }
    },
    "description":"A reference to the eventConfig object.",
    "xml":{
        "name":"EventProviderConfig"
    }
}

• description: string
  A description of the flow step.
• id: integer(int64)
  The unique ID of the flow step generated by the system.
• name: string
  The name of the flow definition.
• type: string
  Allowed Values: [ "LOAD", "SAVE", "CONVERT_TO_PDI", "CONVERT_FROM_PDI", "COMPARE", "CUSTOM", "REVIEW" ]

  The category of the flow step.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flow definition."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flow step generated by the system."
        },
        "type":{
            "type":"string",
            "description":"The category of the flow step.",
            "enum":[
                "LOAD",
                "SAVE",
                "CONVERT_TO_PDI",
                "CONVERT_FROM_PDI",
                "COMPARE",
                "CUSTOM",
                "REVIEW"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the flow step."
        }
    },
    "description":"A reference to the flowStep business object.",
    "xml":{
        "name":"FlowStep"
    }
}

• [0]: object FlowStepInstanceMessage
  A reference to the flowStepInstMsg business object.

{
    "type":"array",
    "description":"A reference to the flowStepInstMsg business object.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/FlowStepInstanceMessage"
    }
}

• id: integer(int64)
  The unique ID of the flowstep instance message generated by the system.
• name: string
  The name of the flowstep instance message.
• seqNo: integer(int32)
  The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.
• stringData: string
  The input and output messages of each step in a flow.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flowstep instance message."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the flowstep instance message generated by the system."
        },
        "seqNo":{
            "type":"integer",
            "format":"int32",
            "description":"The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence."
        },
        "stringData":{
            "type":"string",
            "description":"The input and output messages of each step in a flow."
        }
    },
    "description":"A reference to the flowStepInstMsg business object.",
    "xml":{
        "name":"FlowStepInstanceMessage"
    }
}