Jump to

• Request
• Response

View Business Flow Step Details (Deprecated since 24.2)

get

/api/restapi/pims/flowStepInstances/{id}

This endpoint returns Gateway business flow step details 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 step instance 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 : FlowStepInstance

Type: object

Title: FlowStepInstance

A reference to the flowStepInst business object.

Show Source

• endTime(required): string (date-time)
  The end time of the flow step instance.
• errorData(required): string
  An exception occured. The synchronization has failed.
• errorDataDesc(required): string
  A description of the error data object associated with a flow step instance.
• externalStepStatus(required): string
  Custom external step status
• flowInstance(required): object FlowInstance
  Title: FlowInstance

  A reference to the flow instance business object.
• flowStep(required): object FlowStep
  Title: FlowStep

  A reference to the flowStep business object.
• flowStepInstanceMessages(required): array flowStepInstanceMessages
  Unique Items Required: true

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

  The job status associated with the flowstep instance.
• warningData(required): 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(required): string
  A description of the error data associated with the warning data.

{
    "title":"FlowStepInstance",
    "required":[
        "endTime",
        "errorData",
        "errorDataDesc",
        "externalStepStatus",
        "flowInstance",
        "flowStep",
        "flowStepInstanceMessages",
        "id",
        "startTime",
        "status",
        "warningData",
        "warningDataDesc"
    ],
    "type":"object",
    "properties":{
        "endTime":{
            "type":"string",
            "description":"The end time of the flow step instance.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flowstep instance generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "status":{
            "type":"string",
            "description":"The job status associated with the flowstep instance.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "startTime":{
            "type":"string",
            "description":"The start time of the flow step instance.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowType":{
            "type":"string",
            "description":"Flow Type",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "errorDataDesc":{
            "type":"string",
            "description":"A description of the error data object associated with a flow step instance.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "externalStepStatus":{
            "type":"string",
            "description":"Custom external step status",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowInstance":{
            "$ref":"#/components/schemas/FlowInstance",
            "exampleSetFlag":false
        },
        "flowStep":{
            "$ref":"#/components/schemas/FlowStep",
            "exampleSetFlag":false
        },
        "flowStepInstanceMessages":{
            "uniqueItems":true,
            "type":"array",
            "description":"A reference to the flowStepInstMsg business object.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/FlowStepInstanceMessage",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "errorData":{
            "type":"string",
            "description":"An exception occured. The synchronization has failed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "warningData":{
            "type":"string",
            "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.",
            "xml":{
                "name":"WarningData"
            },
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "warningDataDesc":{
            "type":"string",
            "description":"A description of the error data associated with the warning data.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"A reference to the flowStepInst business object.",
    "xml":{
        "name":"FlowStepInstance"
    },
    "exampleSetFlag":false
}

Nested Schema : FlowInstance

Type: object

Title: FlowInstance

A reference to the flow instance business object.

Show Source

• childCount(required): integer (int64)
  Number of child for Parent Job
• childInstances(required): array childInstances
  A list of child flow instances associated with a flow instance object.
• endTime(required): string (date-time)
  The end time when a flow instance was completed.
• errorDataDesc(required): string
  A description of the error data associated with the flow instance.
• externalStepStatus(required): string
  Custom external step status
• flow(required): object Flow
  Title: Flow

  The flow object associated with a flow instance.
• flowDefName(required): string
  The name of the flow definition.
• flowSchedule(required): object FlowSchedule
  Title: FlowSchedule

  The flow schedule object associated with a flow instance.
• flowStepInstances(required): array flowStepInstances
  Unique Items Required: true

  Set of flow step instances
• getflowInstanceStatRO(required): array flowInstancetStat
  Unique Items Required: true

  Stat for child jobs
• hostName(required): string
  The host name associated with a flow instance.
• id(required): integer (int64)
  The unique ID of the flow instance generated by the system.
• messageCount: integer (int64)
• parentFlowInstanceId(required): integer (int64)
  The unique ID of the parent flow instance associated with the child flow instance.
• startTime(required): string (date-time)
  The start time of the flow instance.
• status(required): string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED", "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.

{
    "title":"FlowInstance",
    "required":[
        "childCount",
        "childInstances",
        "endTime",
        "errorDataDesc",
        "externalStepStatus",
        "flow",
        "flowDefName",
        "flowSchedule",
        "flowStepInstances",
        "getflowInstanceStatRO",
        "hostName",
        "id",
        "parentFlowInstanceId",
        "startTime",
        "status"
    ],
    "type":"object",
    "properties":{
        "endTime":{
            "type":"string",
            "description":"The end time when a flow instance was completed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flow instance generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hostName":{
            "type":"string",
            "description":"The host name associated with a flow instance.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "childCount":{
            "type":"integer",
            "description":"Number of child for Parent Job",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED",
                "New,Queued,Running,Delegated,On Hold,Rejected,Completed,Completed with Errors,Failed,Noop,Completed with Warnings"
            ]
        },
        "startTime":{
            "type":"string",
            "description":"The start time of the flow instance.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flow":{
            "$ref":"#/components/schemas/Flow",
            "exampleSetFlag":false
        },
        "flowSchedule":{
            "$ref":"#/components/schemas/FlowSchedule",
            "exampleSetFlag":false
        },
        "flowStepInstances":{
            "uniqueItems":true,
            "type":"array",
            "description":"Set of flow step instances ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/FlowStepInstance",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "parentFlowInstanceId":{
            "type":"integer",
            "description":"The unique ID of the parent flow instance associated with the child flow instance.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "childInstances":{
            "type":"array",
            "description":"A list of child flow instances associated with a flow instance object.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "description":"A list of child flow instances associated with a flow instance object.",
                "format":"int64",
                "xml":{
                    "name":"childInstances"
                },
                "exampleSetFlag":false,
                "types":[
                    "integer"
                ]
            },
            "types":[
                "array"
            ]
        },
        "errorDataDesc":{
            "type":"string",
            "description":"A description of the error data associated with the flow instance.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowDefName":{
            "type":"string",
            "description":"The name of the flow definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "externalStepStatus":{
            "type":"string",
            "description":"Custom external step status",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "getflowInstanceStatRO":{
            "uniqueItems":true,
            "type":"array",
            "description":"Stat for child jobs",
            "xml":{
                "name":"flowInstancetStat"
            },
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/FlowInstanceStat",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "messageCount":{
            "type":"integer",
            "format":"int64",
            "writeOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"A reference to the flow instance business object.",
    "xml":{
        "name":"FlowInstance"
    },
    "exampleSetFlag":false
}

Nested Schema : FlowStep

Type: object

Title: FlowStep

A reference to the flowStep business object.

Show Source

• description(required): string
  Flow Step Script
• id: integer (int64)
  The unique ID of the flow step generated by the system.
• isdisabled(required): boolean
  The indicator that determines whether the Custom step is enabled or disabled for a flow.
• name(required): string
  The name of the flow definition.
• providerName: string
  Provider Name
• script(required): string
  A description of the flow step.
• type(required): string
  Allowed Values: [ "Load", "Save", "ConvertToPDI", "ConvertFromPDI", "Compare", "Custom", "Review", "Script" ]

  The category of the flow step.

{
    "title":"FlowStep",
    "required":[
        "description",
        "isdisabled",
        "name",
        "script",
        "type"
    ],
    "type":"object",
    "properties":{
        "providerName":{
            "type":"string",
            "description":"Provider Name",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "type":"string",
            "description":"The name of the flow definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flow step generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "type":{
            "type":"string",
            "description":"The category of the flow step.",
            "xml":{
                "name":"FlowStepType"
            },
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "Load",
                "Save",
                "ConvertToPDI",
                "ConvertFromPDI",
                "Compare",
                "Custom",
                "Review",
                "Script"
            ]
        },
        "script":{
            "type":"string",
            "description":"A description of the flow step.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "type":"string",
            "description":"Flow Step Script",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isdisabled":{
            "type":"boolean",
            "description":"The indicator that determines whether the Custom step is enabled or disabled for a flow.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"A reference to the flowStep business object.",
    "xml":{
        "name":"FlowStep"
    },
    "exampleSetFlag":false
}

Nested Schema : flowStepInstanceMessages

Type: array

Unique Items Required: true

A reference to the flowStepInstMsg business object.

Show Source

• Array of: object FlowStepInstanceMessage
  Title: FlowStepInstanceMessage

  A reference to the flowStepInstMsg business object.

{
    "uniqueItems":true,
    "type":"array",
    "description":"A reference to the flowStepInstMsg business object.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/FlowStepInstanceMessage",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : childInstances

Type: array

A list of child flow instances associated with a flow instance object.

Show Source

• Array of: integer(int64)
  A list of child flow instances associated with a flow instance object.

{
    "type":"array",
    "description":"A list of child flow instances associated with a flow instance object.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "description":"A list of child flow instances associated with a flow instance object.",
        "format":"int64",
        "xml":{
            "name":"childInstances"
        },
        "exampleSetFlag":false,
        "types":[
            "integer"
        ]
    },
    "types":[
        "array"
    ]
}

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 : FlowSchedule

Type: object

Title: FlowSchedule

The flow schedule object associated with a flow instance.

Show Source

• active(required): boolean
  An indicator which determines whether the flow schedule is active.
• description(required): string
  A description of the flow schedule.
• destinationAppInstance(required): object AppInstance
  Title: AppInstance

  The list of application instances associated with a flow.
• eventListenerInstance(required): object EventListenerInstance
  Title: EventListenerInstance

  A reference to the event listener instance object.
• externalStepStatus(required): string
  Custom external step status
• flow(required): object Flow
  Title: Flow

  The flow object associated with a flow instance.
• flowDefId(required): integer (int64)
  The id of the flow definition.
• flowDefName(required): string
  The name of the flow definition.
• flowInstRuns(required): integer (int32)
  The number of flow instance runs associated with a flow schedule.
• id(required): integer (int64)
  The unique ID of the flow schedule generated by the system.
• isParent(required): boolean
  The indicator that determines whether a flow schedule is a parent object.
• lastCompletionDate(required): string (date-time)
  The last completion date of the flow schedule.
• lastJobRunStatus(required): string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED", "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(required): integer (int64)
  The unique ID of the last job run in the flow schedule generated by the system.
• lastStartDate(required): string (date-time)
  The last start date associated with the flow schedule.
• maxRuns(required): integer (int32)
  The maximum number of runs allowed for a flow schedule.
• name(required): string
  The name of the flow schedule.
• nextRunDate(required): string (date-time)
  The next run date associated with a flow schedule.
• noEndDate(required): boolean
  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(required): integer (int64)
  Previous FlowSchedule Id
• recurring(required): boolean
  The indicator that determines whether a flow schedule recurs.
• schedule(required): object Schedule
  Title: Schedule

  The schedule object associated with a flow schedule. This is used for scheduling jobs.
• sourceAppInstance(required): object AppInstance
  Title: AppInstance

  The list of application instances associated with a flow.
• status(required): string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the flow schedule.

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

Nested Schema : flowStepInstances

Type: array

Unique Items Required: true

Set of flow step instances

Show Source

• Array of: object FlowStepInstance
  Title: FlowStepInstance

  A reference to the flowStepInst business object.

{
    "uniqueItems":true,
    "type":"array",
    "description":"Set of flow step instances ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/FlowStepInstance",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : flowInstancetStat

Type: array

Unique Items Required: true

Stat for child jobs

Show Source

• Array of: object FlowInstanceStat
  Title: FlowInstanceStat

  A Reference to jobs statistic by status

{
    "uniqueItems":true,
    "type":"array",
    "description":"Stat for child jobs",
    "xml":{
        "name":"flowInstancetStat"
    },
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/FlowInstanceStat",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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
}

Nested Schema : EventListenerInstance

Type: object

Title: EventListenerInstance

A reference to the event listener instance object.

Show Source

• delayInMinutes(required): integer (int32)
  The delay in minutes before triggering a event-based synchronization job.
• eventDisabled(required): boolean
  The indicator which determines whether the event is disabled or enabled.
• eventInstanceConfigs(required): array eventInstanceConfigs
  Unique Items Required: true

  A reference to the eventInstConfig object.
• eventListener(required): object EventListener
  Title: EventListener

  A reference to the event listener object.
• flowSchedule(required): object FlowSchedule
  Title: FlowSchedule

  The flow schedule object associated with a flow instance.
• id(required): integer (int64)
  The unique ID of the event listener instance generated by the system.

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

Nested Schema : Schedule

Type: object

Title: Schedule

The schedule object associated with a flow schedule. This is used for scheduling jobs.

Show Source

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

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

Nested Schema : eventInstanceConfigs

Type: array

Unique Items Required: true

A reference to the eventInstConfig object.

Show Source

• Array of: object EventInstanceConfig
  Title: EventInstanceConfig

  The value of the event instance configuration.

{
    "uniqueItems":true,
    "type":"array",
    "description":"A reference to the eventInstConfig object.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/EventInstanceConfig",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : EventListener

Type: object

Title: EventListener

A reference to the event listener object.

Show Source

• description(required): string
  A description of the event listener.
• flowSchedule(required): object FlowSchedule
  Title: FlowSchedule

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

{
    "title":"EventListener",
    "required":[
        "description",
        "flowSchedule",
        "id",
        "name",
        "type"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the event listener.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the event listener generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "type":{
            "type":"string",
            "description":"The type of event listener.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the event listener.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowSchedule":{
            "$ref":"#/components/schemas/FlowSchedule",
            "exampleSetFlag":false
        }
    },
    "description":"A reference to the event listener object.",
    "xml":{
        "name":"EventListener"
    },
    "exampleSetFlag":false
}

Nested Schema : EventInstanceConfig

Type: object

Title: EventInstanceConfig

The value of the event instance configuration.

Show Source

• eventConfig(required): object EventConfig
  Title: EventConfig

  A reference to the eventConfig object.
• eventListenerInstance(required): object EventListenerInstance
  Title: EventListenerInstance

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

{
    "title":"EventInstanceConfig",
    "required":[
        "eventConfig",
        "eventListenerInstance",
        "id",
        "value"
    ],
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The value of the event instance configuration.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The ID of the eventInstConfig object generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "eventListenerInstance":{
            "$ref":"#/components/schemas/EventListenerInstance",
            "exampleSetFlag":false
        },
        "eventConfig":{
            "$ref":"#/components/schemas/EventConfig",
            "exampleSetFlag":false
        }
    },
    "description":"The value of the event instance configuration.",
    "xml":{
        "name":"InstanceConfig"
    },
    "exampleSetFlag":false
}

Nested Schema : EventConfig

Type: object

Title: EventConfig

A reference to the eventConfig object.

Show Source

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

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

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

Nested Schema : FlowInstanceStat

Type: object

Title: FlowInstanceStat

A Reference to jobs statistic by status

Show Source

• childJobsCount: integer (int64)
• status: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

{
    "title":"FlowInstanceStat",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "childJobsCount":{
            "type":"integer",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"A Reference to jobs statistic by status",
    "xml":{
        "name":"ObjectLogDetails"
    },
    "exampleSetFlag":false
}

Nested Schema : FlowStepInstanceMessage

Type: object

Title: FlowStepInstanceMessage

A reference to the flowStepInstMsg business object.

Show Source

• data(required): array data
  The input and output byte data of each step in a flow.
• id(required): integer (int64)
  The unique ID of the flowstep instance message generated by the system.
• messageType: string
  The type of input and output messages of each step in a flow - valid values ZIP or XML
• name(required): string
  The name of the flowstep instance message.
• requestResponseTimestamp(required): string (date-time)
  The time when a request was send or the time when a response was received.
• seqNo(required): 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(required): string
  The input and output messages of each step in a flow.

{
    "title":"FlowStepInstanceMessage",
    "required":[
        "data",
        "id",
        "name",
        "requestResponseTimestamp",
        "seqNo",
        "stringData"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flowstep instance message.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flowstep instance message generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "data":{
            "type":"array",
            "description":"The input and output byte data of each step in a flow.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "description":"The input and output byte data of each step in a flow.",
                "format":"byte",
                "xml":{
                    "name":"data"
                },
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "seqNo":{
            "type":"integer",
            "description":"The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "stringData":{
            "type":"string",
            "description":"The input and output messages of each step in a flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "messageType":{
            "type":"string",
            "description":"The type of input and output messages of each step in a flow - valid values ZIP or XML",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "requestResponseTimestamp":{
            "type":"string",
            "description":"The time when a request was send or the time when a response was received.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"A reference to the flowStepInstMsg business object.",
    "xml":{
        "name":"FlowStepInstanceMessage"
    },
    "exampleSetFlag":false
}

Nested Schema : data

Type: array

The input and output byte data of each step in a flow.

Show Source

• Array of: string(byte)
  The input and output byte data of each step in a flow.

{
    "type":"array",
    "description":"The input and output byte data of each step in a flow.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "description":"The input and output byte data of each step in a flow.",
        "format":"byte",
        "xml":{
            "name":"data"
        },
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

404 Response

The requested business flow step details do not exist, or you do not have access to them.

Back to Top