executeAction

Java class

Request

web/wwwroot/ws/java/timecontrol/ExecuteActionRequestType.java

Return

web/wwwroot/ws/java/timecontrol/ExecuteActionResponseType.java

Request

ID #

Required

Description

ActionPlanID

X

ID # of the action plan to which the action belongs.

ActionID

X

Action ID #.

UserID

X

ID #s of the user that will be used to execute the action.

ExecStartDt

Actual start date (When?) in the YYYY-MM-DD format.

ExecStartTm

Actual start time (When?) in the HH:MM format.

ExecEndDt

Actual end date (When?) in the YYYY-MM-DD format.

ExecEndTm

Actual end time (When?) in the HH:MM format.

ExecCostVl

Executed cost (How much?), in the 10000.00 format, where the "." is the decimal separator. Thousandth separator is not used.

ResultDs

Result. Note: The Result field may be mandatory depending on the configuration of the action plan category

Request structure

<executeAction>

       <ActionPlanID>?</ActionPlanID>

       <ActionID>?</ActionID>

       <UserID>?</UserID>

       <ExecStartDt>?</ExecStartDt>

       <ExecStartTm>?</ExecStartTm>

       <ExecEndDt>?</ExecEndDt>

       <ExecEndTm>?</ExecEndTm>

       <ExecCostVl >?</ExecCostVl>

       <ResultDs>?</ResultDs>

</executeAction>

Return structure

<executeActionResponse>

       <Status>?</Status>

       <Code>?</Code>

       <Detail>?</Detail>

</executeActionResponse>

Return

ID #

Description

Status

Returns the status of the execution. SUCCESS on success and FAILURE on failure.

Code

Returns the execution code:

▪1 - Method executed successfully;

▪-1 - Error in the configuration of the input parameters;

▪-2 - ID # of the plan or action is duplicated in the database;

▪-3 - The authentication user does not have the necessary permission to execute this method. Check if the user has access to the PL025 menu.

▪-10 - Action plan not found;

▪-11 - Action not found;

▪-12 - Execution user (UserID) not found or disabled;

▪-13 - The authentication user does not have permission for this operation;

▪-14 - Invalid date/time;

▪-15 - The execution user does not have permission for this operation;

▪-16 - The action plan is not under execution;

▪-17 - The action has already been finished;

▪-18 - The action has been cancelled;

▪-19 - The action is not under execution;

▪-20 - Filling out attachments is required in the execution;

▪-21 - Filling out the cost is required in the execution;

▪-22 - Filling out the result is required in the execution;

▪-23 - There is at least one pending answer in the checklist;

▪-24 - There is at least one required attribute to be filled out;

▪-25 - No user responsible for the verification was associated with the action.

▪-26 - The action plan had the maximum value of the How much? field exceeded.

Detail

SUCCESS: Method executed successfully

FAILURE: Description of the error that occurred.