ClientSideExtensionReadAll
Extracts configuration data for multiple client side extensions.
Usage
Use the ClientSideExtenstionReadAll method to read the configuration data for multiple client side extensions.
An attachment to a client side extension can be up to a maximum of 20 megabytes (MB). To limit the size of the file that is returned by the ClientSideExtenstionReadAll method, use the pagesize and startrownum arguments to limit the number of client side extensions that are returned by the read operation.
See ClientSideExtensionUpsert for information about the client side extension data specified in apData:ClientSideExtension.
MTOM/XOP Packaging for the ClientSideExtensionRead Method
The ClientSideExtensionReadAll 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 files attached to the client side extensions. 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 ClientSideExtensionReadAll method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
|
pagesize |
The maximum number of records displayed on a page following a query. |
No |
5 |
Input |
|
startrownum |
Indicates the row from which the ClientSideExtensionReadAll method starts to return the client side extensions. For example, if pagesize=10 and you want to return the first 10 client side extensions, you set startrownum to 0. Then, if you want to return the next 10 client side extensions, you set startrownum to 10, and run the query again. You continue doing this until the last page is returned. In this way, you can return all of the client side extensions. |
Yes |
0 |
Input |
|
apData:ClientSideExtension |
The extracted data for the client side extensions. |
Not applicable |
Not applicable |
Output |
|
LastPage |
A value that indicates whether or not the last value in the query set has been returned. |
Yes |
Not applicable |
Output |
Return Value of the Call
The client side extension data is returned. The attachments to the client side extensions are returned as separate files that are referenced from the response.