Download a Client Application File
get
/documents/api/1.2/config/clientApplications/{id}/data
Download the JSON Playload of an existing custom actions client application. You must be an administrator to perform this operation.
Note:
Range requests are not supported
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: string
Globally unique identifier (GUID) of the client application.
Response
Supported Media Types
- application/json
- application/xml
200 Response
Complete data stream of the file contents.
404 Response
Application ID is not found.
Examples
The following example downloads the JSON payload of the specified client application. If the status code indicates success (200), the response includes a data stream that contains the file contents.
GET .../config/clientApplications/427090D588695B4B4C59D868E83E27B9/data
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
Example 2
The following example returns an error, because the specified client application ID does not exist.
GET .../config/clientApplications/123456D588695A1A1C59D868E83E27B9/data
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 404
JSON Response
{
"errorCode": "-16",
"errorKey": "!csAFAppDoesNotExist,123456D588695A1A1C59D868E83E27B9",
"errorMessage": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
"title": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
"type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}