Cycle Parameters
The following table describes the cycle parameters and their possible values.
For more information on Payload Parameters refer to Cycle Service documentation.
Parameter Name | Mandatory | Description | Possible Values |
---|---|---|---|
cycleLevel | Yes | Cycle Level or sequence name for submission of Task to the Cycle Server. |
|
activityId | No | Activity Guid for submission of task. In case if only one activity is to be submitted for processing. | |
companyId | No | Company Guid of the parent Company for submission of task. In case of activities from only one parent company is to be submitted for processing in case of multi country support. | |
processAll | No | Flag to instruct the cycle server to process all the pending activities in the ActivityScreen sequentially till system date, when ActivityGUID is passed. | Yes, No |
cycleAction | No | Cycle Actions to be taken on an ongoing process eg pause, resume and abort. | P, R, A |
Note:
For submitting a Single Activity for processing, the parameters ActivityGUID and CycleLevel should Not be Null.Note:
For processing all Pending Activities under the Cycle level, ActivityGUID should be 'NULL' and CycleLevel should NOT be NULL.