...
Overview
| Description | Set a web clip on Android devices. A web clip is used to add a bookmark to a web application. |
|---|
| Resource Path | /webclip |
|---|
| URL | /mdm-android-agent/operation/webclip |
|---|
| HTTP Method | POST |
|---|
| Request/Response Format | application/json |
|---|
|
...
Sample request
...
For information on the property value definitions, see Resource Definition to Set a Web Clip on Android Devices.
...
| cURL command | | Code Block |
|---|
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-android-agent/operation/webclip |
|
|---|
|
...
- includes the required properties to carry out the operation, as the
<JSON_PAYLOAD> value. For more information, see the Sample JSON Definition. - By default,
<EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified. - By default,
<EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
|
|
...
Example: | Code Block |
|---|
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer |
|
e56974e8bf5df15748f89c6c5da9835d" -d @' |
|
operation.json' -k -v https://localhost:9443/mdm-android-agent/operation/webclip |
| | Sample output | | Code Block |
|---|
> POST /mdm-android-agent/operation/webclip HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer ceada7ef9db110aca1e9cb1ec900a3b3
> Content-Length: 141
< HTTP/1.1 201 Created
< Date: Fri, 18 Mar 2016 12:38:20 GMT
< Content-Length: 0
< Server: WSO2 Carbon Server |
|
|---|
| Anchor |
|---|
| sampleWebClip |
|---|
| sampleWebClip |
|---|
|
Sample JSON
Definition | | Code Block |
|---|
{
"operation":{
"title":"google",
"identity":"https://google.lk",
"type":"install"
},
"deviceIDs":[
"d8:50:e6:2f:6a:8b",
"a5:60:e6:2g:6a:5b"
]
} |
Property | Description | Data Type |
|---|
operation | This specifies the operation that is to be applied on the Android device. | - | title | The name of the web application. | String | identity | The URL of the application. | String | type | The type of the operation. Following are the possible operation types: install and uninstall. If the operation type is install, the web clip is added, and if the operation type is uninstall, the existing web clip is removed. | String | deviceIDS
| ID of the Android device. Multiple device IDs can be added by using comma separated values.
For more information on retrieving the device ID, see Retrieving the ID of an Android device. | String |
|
|---|
|