Summary:
Inspect, update or delete a View. Note, from Entuity v21.0 upwards, you can also manage View details in config sets (see Config Sets - Update, Rename and Delete Views).
URL:
http(s)://{server hostname}/api/views/{id}
Methods summary
- GET Method - inspect a View.
- PUT Method - update a View.
- DELETE Method - delete a View.
GET Method detail
Inspect details of a View.
Response:
Response is the entity with the following attributes:
| Name | Description |
|---|---|
| accessGroups | group access permissions. |
| baseViewAggregation | one of NONE, UNION, INTERSECTION. |
| baseViewPaths | array of base View paths. |
| displayName | View name. |
| domainFilterName | domain filter name. |
| eventFilterName | event filter name. |
| id | View id unique to the server. |
| implicitAccessGroups | groups having implicit access by virtue of inheriting access through other group permissions, such as having access to the parent View. This may be indirect, e.g. access to the grandparent or great-grandparent. |
| implicitAccessUsers | users having implicit access by virtue of inheriting access through other user permissions, such as having access to the parent View. This may be indirect, e.g. access to the grandparent or great-grandparent. |
| incidentFilterName | incident filter name. |
| manuallyPopulated | if contents of the View are populated manually (true) or automatically (false). |
| owner | user owning a View. |
| path | View path. |
| serverId | Entuity Server Id on which resource resides. |
| location | geographical location of the View, used by the map dashlet in Geographical Mode. If the string is left empty, the location value will be removed from the View. |
| lat | latitude of the location. If latitude is specified, then a location must be specified. |
| lng | longitude of the location. If longitude is specified, then a location must be specified. |
Examples:
INPUT
curl -u admin:admin https://localhost/api/views/5?media=json
OUTPUT
{
"serverId" : "5bc28880-465b-4228-9f0c-45ab88487f83",
"id" : "5",
"path" : "admin::My Network/Servers",
"displayName" : "My Network/Servers",
"baseViewAggregation" : "NONE",
"baseViewPaths" : [ ],
"domainFilterName" : "All Objects",
"manuallyPopulated" : true,
"eventFilterName" : "All Events",
"incidentFilterName" : "All Incidents",
"owner" : "admin",
"accessGroups" : [ {
"userGroupName" : "Administrators",
"editable" : true
} ],
"implicitAccessGroups" : [ ],
"implicitAccessUsers" : [ ]
"location" : "",
"lat" : 0.0,
"lng" : 0.0
}
INPUT
curl -u admin:admin https://localhost/api/views/48?media=xml
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<viewPathDetails owner="admin" incidentFilterName="All Incidents" eventFilterName="All Events" manuallyPopulated="true" domainFilterName="All Objects" baseViewAggregation="NONE" displayName="Simple View" path="Simple View" id="48" serverId="821c3e87-bcdf-4fef-a5e8-7d2524928d96">
<accessGroup editable="true" userGroupName="Administrators"/>
</viewPathDetails>
PUT Method detail
Update existing View.
Request:
Request has the same structure as the POST Method for adding a new view, except the following property must be absent: parentViewPath. You need to specify only properties you want to be changed.
Response:
Response has the same structure as the 'GET Method' response above - shows View details after the update.
Example:
INPUT
curl -u admin:admin https://localhost/api/views/5 -X PUT -H "content-type:application/json" -d \
'{
"owner" : "user"
}'
OUTPUT
{
"serverId" : "5bc28880-465b-4228-9f0c-45ab88487f83",
"id" : "5",
"path" : "admin::My Network/Servers",
"displayName" : "My Network/Servers",
"baseViewAggregation" : "NONE",
"baseViewPaths" : [ ],
"domainFilterName" : "All Objects",
"manuallyPopulated" : true,
"eventFilterName" : "All Events",
"incidentFilterName" : "All Incidents",
"owner" : "user",
"accessGroups" : [ {
"userGroupName" : "Administrators",
"editable" : true
} ],
"implicitAccessGroups" : [ ],
"implicitAccessUsers" : [ ]
"lat" : 0.0,
"lng" : 0.0
}
DELETE Method detail
Delete existing View.
Response:
Empty response.
Example:
INPUT
curl -u admin:admin https://localhost/api/views/48 -X DELETE
OUTPUT
[ ]
Comments
0 comments
Please sign in to leave a comment.