Skip to main content
Version: 2.2.0

getAction

This method enables viewing actions associated with an action plan. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/timecontrol/GetActionRequestType.java
Returnweb/wwwroot/ws/java/timecontrol/GetActionResponseType.java

Request:

ID #RequiredDescription
ActionPlanIDXID # of the action plan to which the action belongs.
ActionIDXAction ID #.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
<soapenv:Header/>
<soapenv:Body>
<urn:getAction>
<!--You may enter the following 2 items in any order-->
<urn:ActionplanID>?</urn:ActionplanID>
<urn:ActionID>?</urn:ActionID>
</urn:getAction>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
Returnâ–ª ActionplanID - ID # of the action plan to which the action belongs
â–ª ActionID - Action ID #
â–ª ActionTitle - Action title (What?)
â–ª CatID - Action category ID #
â–ª FgStatus - Action status: 1 - Planning; 2 - Planning approval; 3 - To be started/In progress; 4 - Action verification; 5 - Finished; 6 - Cancelled.
â–ª FgTypeAction - Action execution type: 1 - Immediate; 2 - Planned
â–ª TeamID - Action team ID #.
â–ª RespID - User ID of the Responsible for execution (Who?)
â–ª DtPlanStart - Planning start date (When)
â–ª TmPlanStart - Planning start time (When?)
â–ª DtPlanEnd - Planning end date (When?)
â–ª TmPlanEnd - Planning end time (When?)
â–ª VlPlanCost - Planned cost (How much?)
â–ª DtExecStart - Execution start date (When?)
â–ª TmExecStart - Execution start time (When?)
â–ª DtExecEnd - Execution end date (When?)
â–ª TmExecEnd - Execution end time (When?)
â–ª VlPercent - Actual %
â–ª VlExecCost - Executed cost (How much?)
â–ª DsResult - Result
â–ª DsWhy - Why?
â–ª DsWhere - Where?
â–ª DsHow - How?
StatusReturns the status of the execution. SUCCESS on success and FAILURE on failure.
CodeReturns 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;
â–ª -11 - This user does not have permission for this operation;
â–ª -12 - Action plan not found;
â–ª -13 - Action not found;
DetailSUCCESS: Method executed successfully.
FAILURE: Description of the error that was found.

Return structure:

<getActionResponse>
<Return>
<ActionplanID>?</ActionplanID>
<ActionID>?</ActionID>
<ActionTitle>?</ActionTitle>
<CatID>?</CatID>
<FgStatus>?</FgStatus>
<FgTypeAction>?</FgTypeAction>
<TeamID>?</TeamID>
<RespID>?</RespID>
<DtPlanStart>?</DtPlanStart>
<TmPlanStart>?</TmPlanStart>
<DtPlanEnd>?</DtPlanEnd>
<TmPlanEnd>?</TmPlanEnd>
<VlPlanCost>?</VlPlanCost>
<DtExecStart>?</DtExecStart>
<TmExecStart>?</TmExecStart>
<DtExecEnd>?</DtExecEnd>
<TmExecEnd>?</TmExecEnd>
<VlPercent>?</VlPercent>
<VlExecCost>?</VlExecCost>
<DsResult>?</DsResult>
<DsWhy>?</DsWhy>
<DsWhere>?</DsWhere>
<DsHow>?</DsHow>
</Return>
<Status>?</Status>
<Code>?</Code>
<Detail>?</Detail>
</getActionResponse>