This operation returns a list of Web Console applications and features that a user has access to. The list is returned for the user who is logged on.
Request
Syntax
GET <webservice>/User/Apps HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name |
Description |
---|---|
Host |
The host name of the Web Server or Web Console used in the API request. |
Accept |
The format of the response. Valid values are: application/xml or application/json. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter |
Description |
Element |
||
---|---|---|---|---|
application |
The application the user has access to. Valid values are:
|
applicationLicense |
||
isLicensed |
The option to indicate whether or not the application the user has access to is licensed. Valid values are:
|
applicationLicense |
||
IsVMEnabled |
myDataApplications |
|||
IsDriveEnabled |
The option to indicate whether or not the user has access to the Edge Drive feature. Valid values are:
|
myDataApplications |
||
IsSharePointEnabled |
The option to indicate whether or not the user has access to the SharePoint feature. Valid values are:
|
myDataApplications |
||
IsEmailEnabled |
The option to indicate whether or not the user has access to the Mail feature. Valid values are:
|
myDataApplications |
||
IsComputersEnabled |
The option to indicate whether or not the user has access to the Computers feature. Valid values are:
|
myDataApplications |
||
IsSharesEnabled |
The option to indicate whether or not the user has access to the Share feature. Valid values are:
|
myDataApplications |
||
IsSyncAllowed |
myDataApplications |
|||
IsFileAnalytics |
The option to indicate whether or not the user has access to the File Analytics feature. Valid values are:
|
analyticsApplications |
||
IsEmailAnalytics |
The option to indicate whether or not the user has access to the Email Analytics feature. Valid values are:
|
analyticsApplications |
||
IsDataConnector |
The option to indicate whether or not the user has access to the Data Cube feature. Valid values are:
|
analyticsApplications |
||
IsWebAnalytics |
The option to indicate whether or not the user has access to the Web Analytics feature. Valid values are:
|
analyticsApplications |
||
IsEventOrganizer |
The option to indicate whether or not the user has access to the Event Organizer feature. Valid values are:
|
analyticsApplications |
Examples
Sample Request
GET <webservice>/User/Apps HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
XML
<DM2ContentIndexing_ApplicationLicenseResponse>
<applicationLicense application="1" isLicensed="1" />
<applicationLicense application="2" isLicensed="1" />
<applicationLicense application="3" isLicensed="1" />
<applicationLicense application="4" isLicensed="1" />
<applicationLicense application="14" isLicensed="1" />
<applicationLicense application="18" isLicensed="1" />
<applicationLicense application="19" isLicensed="1" />
<applicationLicense application="20" isLicensed="1" />
<applicationLicense application="31" isLicensed="1" />
<applicationLicense application="32" isLicensed="1" />
<applicationLicense application="33" isLicensed="1" />
<applicationLicense application="36" isLicensed="1" />
<applicationLicense application="37" isLicensed="1" />
<applicationLicense application="49" isLicensed="1" />
<auxiliaryAppLicenses>
<myDataApplications IsVMEnabled="0" IsDriveEnabled="0" IsSharePointEnabled="0" IsEmailEnabled="0" IsComputersEnabled="1" IsSharesEnabled="1" IsSyncAllowed="0" />
<analyticsApplications IsFileAnalytics="1" IsEmailAnalytics="1" IsDataConnector="1" IsWebAnalytics="1" IsEventOrganizer="1" />
</auxiliaryAppLicenses>
</DM2ContentIndexing_ApplicationLicenseResponse>
JSON
{
"applicationLicense": [{
"application": 1,
"isLicensed": true
}, {
"application": 2,
"isLicensed": true
}, {
"application": 3,
"isLicensed": true
}, {
"application": 4,
"isLicensed": true
}, {
"application": 14,
"isLicensed": true
}, {
"application": 18,
"isLicensed": true
}, {
"application": 19,
"isLicensed": true
}, {
"application": 20,
"isLicensed": true
}, {
"application": 31,
"isLicensed": true
}, {
"application": 32,
"isLicensed": true
}, {
"application": 33,
"isLicensed": true
}, {
"application": 36,
"isLicensed": true
}, {
"application": 37,
"isLicensed": true
}, {
"application": 49,
"isLicensed": true
}],
"auxiliaryAppLicenses": {
"analyticsApplications": {
"IsFileAnalytics": true,
"IsWebAnalytics": true,
"IsDataConnector": true,
"IsEventOrganizer": true,
"IsEmailAnalytics": true
},
"myDataApplications": {
"IsVMEnabled": false,
"IsSharePointEnabled": false,
"IsSharesEnabled": true,
"IsEmailEnabled": false,
"IsDriveEnabled": false,
"IsSyncAllowed": false,
"IsComputersEnabled": true
}
}
}