ClientSideExtensionRead
Extracts client side extension configuration data.
Usage
Use the ClientSideExtension method to extract client side extension configuration data matching the input criteria. The Upload Client Side Extensions and Manage Custom HTML Head Tag privilege is required.
The client side extension is specified with the <Name> child element of apQuery:ClientSideExtension element.
See ClientSideExtensionUpsert for information about the client side extension data specified in apData:ClientSideExtension.
For more information about client side extensions, see Oracle CRM On Demand Online Help.
MTOM/XOP Packaging for the ClientSideExtensionRead Method
The ClientSideExtensionRead method uses the Message Transmission Optimized Mechanism (MTOM) specification with the XML-binary Optimized Packaging (XOP) convention and the Multipurpose Internet Mail Extensions (MIME) standard to extract and return the client side extension configuration data and the file attached to the client side extension. Therefore, the SOAP request must be packaged as an MTOM/XOP request, as shown in the following code sample:
MIME-Version: 1.0
Content-Type:
Multipart/Related;boundary=MIME_boundary;type="application/xop+xml";start="<mymessage.xml@example.org>"
--MIME_boundary
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml
Content-ID: <mymessage.xml@example.org>
...The SOAP Message goes here...
--MIME_boundary--
The request must conform with the specification for the XOP convention, as described in http://www.w3.org/TR/xop10/. For examples of XOP requests, see https://www.w3.org/TR/xop10/#example.
Arguments
The following table describes the arguments taken by the ClientSideExtensionRead method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
|
apQuery:ClientSideExtension |
The client side extension query criteria. |
Yes |
Not applicable |
Input |
|
apData:ClientSideExtension |
The extracted client side extension data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The client side extension data is returned. The attachment to the client side extension is returned as a separate file that is referenced from the response.