Dashboard
Realm Operations
Resource path:
/realm-config/services/dashboard
Resource version: 1.0
create
Usage
am> create Dashboard --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "assignedDashboard" : { "title" : "Available Dashboard Apps", "description" : "List of application dashboard names available by default for realms with the Dashboard service configured.", "propertyOrder" : 700, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } } }
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action Dashboard --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action Dashboard --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action Dashboard --realm Realm --actionName nextdescendents
update
Usage
am> update Dashboard --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "assignedDashboard" : { "title" : "Available Dashboard Apps", "description" : "List of application dashboard names available by default for realms with the Dashboard service configured.", "propertyOrder" : 700, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/services/dashboard
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action Dashboard --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action Dashboard --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action Dashboard --global --actionName nextdescendents
update
Usage
am> update Dashboard --global --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "defaults" : { "properties" : { "assignedDashboard" : { "title" : "Available Dashboard Apps", "description" : "List of application dashboard names available by default for realms with the Dashboard service configured.", "propertyOrder" : 700, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } }