Navigation:  Integration via SOAP web services > Published web services > Action plan >

getAction

Previous  Top  Next

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

 

Java class

Request

web/wwwroot/ws/java/timecontrol/GetActionRequestType.java

Return

web/wwwroot/ws/java/timecontrol/GetActionResponseType.java

 

Request

ID #

Required

Description

ActionPlanID

X

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

ActionID

X

Action ID #.

 

Request structure

<getAction>

       <ActionPlanID>?</ActionPlanID>

       <ActionID>?</ActionID>

</getAction>

 

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>

 

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?

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;

-11 - This user does not have permission for this operation;

-12 - Action plan not found;

-13 - Action not found;

Detail

SUCCESS: Method executed successfully.

FAILURE: Description of the error that occurred.