Salesforce

WSProviderAttachmentGet (Magic xpa 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

WsProviderAttachmentGet (Magic xpa 3.x)

Retrieves a Web Service (WS) DIME attachment received by a Web Service request.

A provider Web Service program can retrieve attachments from the SOAP request or to add attachments to the SOAP response using the WsProviderAttachmentGet and WsProviderAttachmentAdd functions.

Syntax:

WsProviderAttachmentGet (Identifier)

Parameters:

Identifier – Select an identifier type from the options below:

1. Universal Unique Identifier (UUID) – An alphanumeric value that uniquely identifies the attachment. In some cases the sender can add the UUID into the XML message, but this is not mandatory. UUID can be used only for DIME attachments.

2. Index – Numeric value. When Magic xpa receives several attachments, the function retrieves each attachment by its index number in the message, starting from 1.

Returns:

A BLOB containing the attachment.

A Null value is returned when the attachment is not found by the UUID or Index, or the function had not been activated during a provider program execution.

Examples:

WsProviderAttachmentGet (1), returns the first attachment from the message.

WsProviderAttachmentGet ('F2DA3C9C-74D3-4A46-B925-B150D62D9483'), returns the identified attachment.

Note:

  • In runtime, incoming attachments are available during the Web Service provider program by using the following syntax: WsProviderAttachmentGet (uuid) or WsProviderAttachmentGet (index). For indexes, the incoming attachments are accessed in their order of appearance in the DIME message.

  • Incoming attachments are cleared from memory after the Task Suffix operations have been executed in the Web service provider program.

Exceptions:

  • This function is not supported as a parameter in the Invoke Web Service Lite operation.

  • This function is not supported for Rich Client tasks.

Reference
Attachment 
Attachment