executeAction
This method enables executing an action from an action plan. To use it, it is necessary to follow the standard documented below:
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 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:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
<soapenv:Header/>
<soapenv:Body>
<urn:executeAction>
<!--You may enter the following 9 items in any order-->
<urn:ActionPlanID>?</urn:ActionPlanID>
<urn:ActionID>?</urn:ActionID>
<urn:UserID>?</urn:UserID>
<urn:ExecStartDt>?</urn:ExecStartDt>
<urn:ExecStartTm>?</urn:ExecStartTm>
<urn:ExecEndDt>?</urn:ExecEndDt>
<urn:ExecEndTm>?</urn:ExecEndTm>
<urn:ExecCostVl>?</urn:ExecCostVl>
<urn:ResultDs>?</urn:ResultDs>
</urn:executeAction>
</soapenv:Body>
</soapenv:Envelope>
Return:
ID # | Required | Description |
---|---|---|
ActionPlanID | X | ID # of the action plan to which the action belongs. |
ActionID | X | Action ID #. |
UserID | X | ID 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 |
Return structure:
<executeActionResponse>
<Status>?</Status>
<Code>?</Code>
<Detail>?</Detail>
</executeActionResponse>