DashboardInstance
Global Operations
Resource path:
/global-config/services/dashboard/instances
Resource version: 1.0
create
Usage
am> create DashboardInstance --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "displayName" : { "title" : "Dashboard Display Name", "description" : "The application name that displays on the dashboard client.", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "login" : { "title" : "Dashboard Login", "description" : "The URL that takes the user to the application.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "icfIdentifier" : { "title" : "ICF Identifier", "description" : "", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "className" : { "title" : "Dashboard Class Name", "description" : "Identifies how to access the application, for example <code>SAML2ApplicationClass</code> for a SAML v2.0 application.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "name" : { "title" : "Dashboard Name", "description" : "The application name as it will appear to the administrator for configuring the dashboard.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "icon" : { "title" : "Dashboard Icon", "description" : "The icon name that will be displayed on the dashboard client identifying the application.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete DashboardInstance --global --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action DashboardInstance --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action DashboardInstance --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action DashboardInstance --global --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query DashboardInstance --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read DashboardInstance --global --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update DashboardInstance --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "displayName" : { "title" : "Dashboard Display Name", "description" : "The application name that displays on the dashboard client.", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "login" : { "title" : "Dashboard Login", "description" : "The URL that takes the user to the application.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "icfIdentifier" : { "title" : "ICF Identifier", "description" : "", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "className" : { "title" : "Dashboard Class Name", "description" : "Identifies how to access the application, for example <code>SAML2ApplicationClass</code> for a SAML v2.0 application.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "name" : { "title" : "Dashboard Name", "description" : "The application name as it will appear to the administrator for configuring the dashboard.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "icon" : { "title" : "Dashboard Icon", "description" : "The icon name that will be displayed on the dashboard client identifying the application.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" } } }