MashZone NextGen Platform Services

Service

Description

ConfigService

Contains methods to get and set configuration properties for the MashZone NextGen Server. Includes both methods for specific properties and generic methods to get and set properties by name.

DashboardFeedService

Contains methods to search and to delete dashboards and data feeds. The seachDashboards and seachFeeds methods deliver a list of dashboards which fits to the specified search criteria. The deleteDashboards and deleteFeeds methods delete all dashboards or data feeds which fits to specific GUIDs.

Search parameter:

  • keyword - The search term. If the parameter is empty, all dashboards matching the other criteria are returned, otherwise, only dashboards that additionally match the search term are returned.
  • timestamp - If this parameter is > 0, only dashboards are listed that have been changed after the specified timestamp.
  • searchFields - The list of fields that are relevant for the search by search term. Possible fields are NAME, DESCRIPTION, TAGS, AUTHOR.
  • permissions - The list of required permissions. The EDIT value lists dashboards the user has an edit permission for. The EXECUTE value lists dashboards the user has an execute or view permission for.

Example

{ "keyword" : "mydashboard", "timestamp" : 1421135782252, "searchFields" : [ "NAME", "DESCRIPTION", "TAGS", "AUTHOR" ], "permissions" : [ "EDIT", "EXECUTE" ], "rating" : 3 }

MailService

Contains methods used to manage and send email notifications for sharing.

ManagementService

Contains methods to find license and statistics information for the Admin Console.

PolicyService

Contains methods to find and manage permission sets for run permissions, other artifact actions and access to specific features (entitlements) in MashZone NextGen Hub and the AppDepot.

Also contains methods to create and manage dynamic groups for custom policies and manage policy configuration.

UserManagerService

Contains methods to find and manage users, groups and MashZone NextGen users attributes.

AliasService

Contains methods to manage MashZone NextGen alias definitions including create, delete, and assign alias definitions.

ACLService

Contains methods to manage permissions for dashboards, data feeds and aliases. It is possible store, delete, or assign permissions for mentioned definitions.