Articles in this section

See more

View List - RESTful API

Avatar
Stuart Hill
  • Updated
Follow

Summary:

List available Views or create a new View. Note, from Entuity v21.0 upwards, you can also manage View lists in config sets (see Config Sets - List and Add Views).

URL:

http(s)://{server hostname}/api/views

 

Views and Subviews

 

Methods summary

GET Method detail

POST Method detail

 

 

 

Methods summary

  • GET Method - lists available Views.
  • POST Method - create a new View.

 

 

GET Method detail

Lists available Views.

Response:

Name Description
displayName View name.
id View id unique to the server.
path View path with forward slash as a sub-view separator.
serverId Entuity server ID on which resource resides.

Example:

INPUT
curl -u admin:admin https://localhost/api/views?media=json

OUTPUT
{
  "items" : [ {
    "serverId" : "821c3e87-bcdf-4fef-a5e8-7d2524928d96",
    "id" : "1",
    "displayName" : "All Objects",
    "path" : "All Objects"
  }, {
    "serverId" : "821c3e87-bcdf-4fef-a5e8-7d2524928d96",
    "id" : "2",
    "displayName" : "My Network (admin)",
    "path" : "admin::My Network"
  } ],
  "count" : 2
}

 

INPUT
curl -u admin:admin https://localhost/api/views?media=xml


OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="2">
    <item xsi:type="viewPathItem" path="All Objects" displayName="All Objects" id="1" serverId="821c3e87-bcdf-4fef-a5e8-7d2524928d96" />
    <item xsi:type="viewPathItem" path="admin::My Network" displayName="My Network (admin)"  id="2" serverId="821c3e87-bcdf-4fef-a5e8-7d2524928d96" />
</items>

 

 

POST Method detail

Creates a new View.

Request:

Request is an object which may contain a subset of the following properties:

Name Description
accessGroups array of access objects, specifying view access permissions.
baseViewAggregation a way to aggregate base views: One of NONE (default), UNION or INTERSECTION.
baseViewPaths array of base views
domainFilterName name of the domain filter to use
eventFilterName name of the event filter to use
incidentFilterName name of the incident filter to use
name name of the View being created.
owner username of the user who will be an owner of the View. This defaults to the user making a call. Only administrators may specify a user other than themselves.
parentViewPath forward-slash separated path of the parent view. Leave out to create a top-level view.
location location of the View, which is used by the Map dashlet in Geographical Mode.

Response:

The updated list of Views, as when the 'GET Method' above is used.

Examples:

You can create different Views using the following commands. The following are examples for the createView.json file:

To create a top-level View with most information set to default:

INPUT
curl -u admin:admin -H "content-type:application/json" https://localhost/api/views -X POST -d \
'{
  "name" : "Simple View"
}'

OUTPUT
{
"items" : [ {
 "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
   "id" : "1",
  "displayName" : "My Network/All Objects",
   "path" : "admin::My Network/All Objects"
  }, {
   "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
   "id" : "2",
   "displayName" : "My Network",
   "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
   "id" : "4",
    "displayName" : "My Network/Simple View",
   "path" : "admin::My Network/Simple View"
  } ],
  "count" : 3
}

 

To create a top-level View with filter information provided:

INPUT
curl -u admin:admin -H "content-type:application/json" https://localhost/api/views -X POST -d \
'{
  "name" : "MyView",
  "domainFilterName" : "All Objects",
  "eventFilterName" : "All Events",
  "incidentFilterName" : "All Incidents"
}'

OUTPUT
{
  "items : [ {
    "serverId" : 305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "1",
    "displayName" : "My Network/All Objects",
    "path" : "admin::My Network/All Objects",
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "2",
    "displayName" : "My Network",
    "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "4",
    "displayName" : "My Network/Simple View
    "path" : "admin::My Network/Simple View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "6",
    "displayName" : "My Network/MyView",
    "path" : "admin::My Network/MyView"
  } ],
  "count" : 4
}

 

To create a Subview:

INPUT
curl -u admin:admin https://localhost/api/views -X POST -H "content-type:application/json" -d \
'{
  "name" : "SubView",
  "parentViewPath" : "MyView"
}'

OUTPUT
{
  "items" : [ {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "1",
    "displayName" : "My Network/All Objects",
    "path" : "admin::My Network/All Objects"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "2",
    "displayName" : "My Network",
    "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "4",
    "displayName" : "My Network/Simple View",
    "path" : "admin::My Network/Simple View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "6",
    "displayName" : "My Network/MyView",
    "path" : "admin::My Network/MyView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "7",
    "displayName" : "My Network/MyView/SubView",
    "path" : "admin::My Network/MyView/SubView"
  }, {
  "count" : 5
}

 

To create a View that unions content from the base Views:

INPUT
curl -u admin:admin https://localhost/api/views -X POST -H "content-type:application/json" -d \
'{
  "name" : "Union View",
  "baseViewAggregation" : "UNION",
  "baseViewPaths" : [ "MyView", "My Top View/Second-Level View/SubView" ]
}'

OUTPUT
{
  "items" : [ {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "1",
    "displayName" : "My Network/All Objects",
    "path" : "admin::My Network/All Objects"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "2",
    "displayName" : "My Network",
    "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "4",
    "displayName" : "My Network/Simple View",
    "path" : "admin::My Network/Simple View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "6",
    "displayName" : "My Network/MyView",
    "path" : "admin::My Network/MyView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "7",
    "displayName" : "My Network/MyView/SubView",
    "path" : "admin::My Network/MyView/SubView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "8",
    "displayName" : "My Network/Union View",
    "path" : "admin::My Network/Union View"
  }, {
  "count" : 6
}

 

To create a View that intersects contents from the base Views:

INPUT
curl -u admin:admin https://localhost/api/views -X POST -H "content-type:application/json" -d \
'{
  "name" : "Intersection View",
  "baseViewAggregation" : "INTERSECTION",
  "baseViewPaths" : [ "MyView", "MyView/SubView" ]
}'

OUTPUT
{
  "items" : [ {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "1",
    "displayName" : "My Network/All Objects",
    "path" : "admin::My Network/All Objects"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "2",
    "displayName" : "My Network",
    "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "4",
    "displayName" : "My Network/Simple View",
    "path" : "admin::My Network/Simple View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "6",
    "displayName" : "My Network/MyView",
    "path" : "admin::My Network/MyView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "7",
    "displayName" : "My Network/MyView/SubView",
    "path" : "admin::My Network/MyView/SubView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "8",
    "displayName" : "My Network/Union View",
    "path" : "admin::My Network/Union View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "9",
    "displayName" : "My Network/Intersection View",
    "path" : "admin::My Network/Intersection View"
  }, {
  "count" : 7
}

 

To create a View with a specific owner and access rights:

INPUT
curl -u admin:admin https://localhost/api/views -X POST -H "content-type:application/json" -d \
'{
  "name" : "John's View",
  "owner" : "John",
  "accessGroups" : [ {
    "userGroupName" : "Support",
    "editable" : "true"
  }, {
    "userGroupName" : "All Users",
    "editable" : "false"
  } ]
}'

OUTPUT
{
  "items" : [, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "1",
    "displayName" : "My Network/All Objects",
    "path" : "admin::My Network/All Objects"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "2",
    "displayName" : "My Network",
    "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "4",
    "displayName" : "My Network/Simple View",
    "path" : "admin::My Network/Simple View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "6",
    "displayName" : "My Network/MyView",
    "path" : "admin::My Network/MyView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "7",
    "displayName" : "My Network/MyView/SubView",
    "path" : "admin::My Network/MyView/SubView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "8",
    "displayName" : "My Network/Union View",
    "path" : "admin::My Network/Union View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "9",
    "displayName" : "My Network/Intersection View",
    "path" : "admin::My Network/Intersection View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "11",
    "displayName" : "My Network/Johns View",
    "path" : "admin::My Network/Johns View"
  }, {
  "count" : 8
}

 

To create a top-level View with a specified location:

INPUT
curl -u admin:admin https://localhost/api/views -X POST -H "content-type:application/json" -d \
'{
  "name" : "London Branch",
  "owner" : "admin",
  "accessGroups" : [ {
  "userGroupName" : "All Users",
  "editable" : "true"
  } ],
  "location" : "london, uk"
}'

OUTPUT
{
  "items" : [, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "1",
    "displayName" : "My Network/All Objects",
    "path" : "admin::My Network/All Objects"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "2",
    "displayName" : "My Network",
    "path" : "admin::My Network"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "4",
    "displayName" : "My Network/Simple View",
    "path" : "admin::My Network/Simple View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "6",
    "displayName" : "My Network/MyView",
    "path" : "admin::My Network/MyView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "7",
    "displayName" : "My Network/MyView/SubView",
    "path" : "admin::My Network/MyView/SubView"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "8",
    "displayName" : "My Network/Union View",
    "path" : "admin::My Network/Union View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "9",
    "displayName" : "My Network/Intersection View",
    "path" : "admin::My Network/Intersection View"
  }, {
    "serverId" : "305df7e4-408d-4db5-a05e-b2d847ca78f0",
    "id" : "11",
    "displayName" : "My Network/Johns View",
    "path" : "admin::My Network/Johns View"
  },{
   "serverId": "293bd62c-413f-4f79-a529-0a0c836bec84",
   "id": "12",
   "displayName": "My Network/London Branch",
   "path": "admin::My Network/London Branch"
 }], 
  "count" : 9
}

Related articles

Comments

0 comments

Please sign in to leave a comment.