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

getAttachmentAction

Previous  Top  Next

This method enables downloading the attachments from the action of an action plan. To use it, it is necessary to follow the standard documented below:

 

Java class

Request

web/wwwroot/ws/java/timecontrol/GetAttachmentActionRequestType.java

Return

web/wwwroot/ws/java/timecontrol/GetAttachmentActionResponseType.java

 

Request

ID #

Required

Description

ActionPlanID

X

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

ActionID

X

Action ID #.

FileName

 

File name (including the extension)

Note: If no name is entered, every attachment in the action will be searched.

 

Request structure

<getAttachmentAction>

       <ActionPlanID>?</ActionPlanID>

       <ActionID>?</ActionID>

       <FileName>?</FileName>

</getAttachmentAction >

 

Return structure

<getAttachmentActionResponse>

       <Return>

               <AttachmentList>

                       <Attachment>

                               <FileName>?</FileName>

                               <FileContent>?</FileContent>

                       </Attachment>

                       <Attachment>

                               <FileName>?</FileName>

                               <FileContent>?</FileContent>

                       </Attachment>

               </AttachmentList>

       </Return>

       <Status>?</Status>

       <Code>?</Code>

       <Detail>?</Detail>

</getAttachemntActionResponse>

 

Return

ID #

Description

Return

SUCCESS: Array with attachments:

FileName - File name

FileContent - Binary content of the file

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 - The authentication user does not have the necessary permission;

-13 - No results found;

Detail

SUCCESS: Method executed successfully

FAILURE: Description of the error that occurred.