Get /user/dashboard
Description
Returns a list of User Dashboard records matching the supplied filter owned by the currently logged on user.
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiNAC |
| Content-Type (option 1) | application/json | String | |
|
Content-Type (option 2) |
application/xml |
|
|
Request Body Parameters
|
Name |
Required |
Type |
|---|---|---|
| filter | Optional | Array[String] |
| start | Optional | Integer |
| count | Optional | Integer |
| sortKey | Optional | String |
| sortDir | Optional | String |
Sample Request
|
Request URL |
GET https://10.106.94.152:8443/api/v2/user/dashboard |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json
|
Sample Response
{
"status": "string",
"errorMessage": "string",
"results": [
{
"dbid": 0,
"rank": 0,
"version": 0,
"canDelete": true,
"label": "string",
"userDBID": 0,
"dashboard": {
"dashboardType": "DEFAULT",
"sharedName": "string",
"note": "string",
"ownerDBID": 0,
"sharedGroupIDs": [
0
],
"tiles": [
{
"componentUUID": "string",
"refreshInterval": 0,
"width": 0,
"position": 0,
"additionalSettings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"dbid": 0
}
],
"dbid": 0
},
"yamsEventTag": "string",
"auditObj": {
"user": "string",
"action": "string",
"timestamp": "2023-09-27T21:39:59.597Z",
"liveObj": {
"yamsEventTag": "string",
"auditObj": "string"
},
"auditDBID": 0,
"liveDBID": 0,
"yamsEventTag": "string",
"auditObj": "string"
}
}
],
"filtered": 0,
"total": 0
}