Submit a payroll flow pattern.
post
/hcmRestApi/resources/11.13.18.05/searchFlowPatterns/action/submitFlow
Submit a payroll flow pattern with specified parameters.
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
baseFlowId: number
Unique identifier from which the flow pattern is inherited.
-
crossFlowInteractionList: array
crossFlowInteractionList
List containing flow instance identifiers and flow task identifiers to create cross flow interactions.
-
flowInstanceName: string
Unique name for a flow instance within a legislation.
-
formulaId: number
Unique identifier for the formula used for scheduling the submission of the flow.
-
fromFlowTaskInstanceId: number
Flow task instance identifier used to create cross flow interactions.
-
legislativeDataGroupId: number
Unique identifier for the legislative data group used to submit the flow.
-
paramIdValues: object
paramIdValues
Additional Properties Allowed: additionalPropertiesMap containing flow parameter identifiers and their values.
-
scheduleEndTime: string
(date-time)
Timestamp that indicates the end of a recurring schedule.
-
scheduleStartTime: string
(date-time)
Timestamp that indicates the start of a recurring schedule.
-
submissionContext: string
Context which identifies from where flow has been submitted. The valid values are SRF,DE,PAYROLL.
Nested Schema : crossFlowInteractionList
Type:
array
List containing flow instance identifiers and flow task identifiers to create cross flow interactions.
Show Source
Nested Schema : paramIdValues
Type:
object
Additional Properties Allowed
Show Source
Map containing flow parameter identifiers and their values.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.