Web API for Dashboards - Revision history

Ollvihe: /* Modify dashboard */

2026-06-08T21:03:38Z

Modify dashboard

← Older revision		Revision as of 21:03, 8 June 2026
Line 38:		Line 38:
	Modifies an existing dashboard in the database. The request body is a Dashboard object. The method does not return content.		Modifies an existing dashboard in the database. The request body is a Dashboard object. The method does not return content.

	When a dashboard is saved, the relevant ~~UiElement~~ is the first ~~View UiElement~~ in the ~~Dashboard~~ object's ''Views'' property. For an existing element, the saved properties include ''Name'', ''Description'', ''Identifier''~~, and custom or optional parameters, and the element's update metadata is refreshed~~.		When a dashboard is saved, the relevant dashboard is the first item in the dashboard object's ''Views'' property. For an existing element, the saved properties include ''Name'', ''Description'', and ''Identifier''.

Ollvihe: /* Get dashboard by identifier */

2026-06-08T21:02:28Z

Get dashboard by identifier

← Older revision		Revision as of 21:02, 8 June 2026
Line 12:		Line 12:
	Gets a list of dashboard objects accessible to the current user matching the specified ''identifierPath''.		Gets a list of dashboard objects accessible to the current user matching the specified ''identifierPath''.

	The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', the ~~returned View UiElement includes the ''ProjectPath'' property, containing the part of the absolute identifier~~ path ~~without~~ the ~~UiElement identifier~~.		The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', returns also the project path where the dashboard is located.

	The ''projectId'' query parameter is optional. If it is specified and ''identifierPath'' is a relative path, only dashboards belonging to that project are returned.		The ''projectId'' query parameter is optional. If it is specified and ''identifierPath'' is a relative path, only dashboards belonging to that project are returned.

Ollvihe: /* Get dashboard by ID */

2026-06-08T21:01:32Z

Get dashboard by ID

← Older revision		Revision as of 21:01, 8 June 2026
Line 22:		Line 22:
	Gets a dashboard object by ID. The ''dashboardId'' is the database IDof the dashboard.		Gets a dashboard object by ID. The ''dashboardId'' is the database IDof the dashboard.

	The returned Dashboard object's ''Views'' property contains only ~~the UiElement~~ identified by ''dashboardId''. That UiElement includes a ''Permissions'' property containing the current user's permissions for the project the UiElement belongs to. If the UiElement's ''ProjectId'' is 0 or null, the ''Permissions'' property contains the user's global permissions.		The returned Dashboard object's ''Views'' property contains only dashboards identified by ''dashboardId''.

	=== Get dashboards in project ===		=== Get dashboards in project ===

Ollvihe: /* Get dashboards in project */

2026-06-08T21:01:02Z

Get dashboards in project

← Older revision		Revision as of 21:01, 8 June 2026
Line 28:		Line 28:
	POST api/dashboards/?projectId={projectId}		POST api/dashboards/?projectId={projectId}
	</pre>		</pre>
	Creates a new dashboard in the database. The request body is a Dashboard object. The ''projectId'' query parameter specifies the project into which the dashboard is created~~. If ''projectId'' is omitted, the dashboard is created at the root level~~.		Creates a new dashboard in the database. The request body is a Dashboard object. The ''projectId'' query parameter specifies the project into which the dashboard is created.

	Returns a dashboard creation result object, not the created Dashboard object. The result contains the saved dashboard's ''Id'' and''Name''.		Returns a dashboard creation result object, not the created Dashboard object. The result contains the saved dashboard's ''Id'' and''Name''.

Ollvihe: /* Get dashboards in project */

2026-06-08T21:00:45Z

Get dashboards in project

← Older revision		Revision as of 21:00, 8 June 2026
Line 30:		Line 30:
	Creates a new dashboard in the database. The request body is a Dashboard object. The ''projectId'' query parameter specifies the project into which the dashboard is created. If ''projectId'' is omitted, the dashboard is created at the root level.		Creates a new dashboard in the database. The request body is a Dashboard object. The ''projectId'' query parameter specifies the project into which the dashboard is created. If ''projectId'' is omitted, the dashboard is created at the root level.

	Returns a dashboard creation result object, not the created Dashboard object. The result contains the saved dashboard ~~View UiElement~~'s ''Id'', ''Name''~~, and ''IdMappings'' from input object ids to database ids~~.		Returns a dashboard creation result object, not the created Dashboard object. The result contains the saved dashboard's ''Id'' and''Name''.

	=== Modify dashboard ===		=== Modify dashboard ===

Ollvihe: /* Get dashboard by identifier */

2026-06-08T20:59:45Z

Get dashboard by identifier

← Older revision		Revision as of 20:59, 8 June 2026
Line 10:		Line 10:
	GET api/dashboards?identifierPath={identifierPath}&includeProjectPath={includeProjectPath}&projectId={projectId}		GET api/dashboards?identifierPath={identifierPath}&includeProjectPath={includeProjectPath}&projectId={projectId}
	</pre>		</pre>
	Gets a list of dashboard objects accessible to the current user ~~whose UiElements match~~ the specified ''identifierPath''.		Gets a list of dashboard objects accessible to the current user matching the specified ''identifierPath''.

	The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', the returned View UiElement includes the ''ProjectPath'' property, containing the part of the absolute identifier path without the UiElement identifier.		The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', the returned View UiElement includes the ''ProjectPath'' property, containing the part of the absolute identifier path without the UiElement identifier.

Ollvihe: /* Get dashboard by identifier */

2026-06-08T20:58:47Z

Get dashboard by identifier

← Older revision		Revision as of 20:58, 8 June 2026
Line 12:		Line 12:
	Gets a list of dashboard objects accessible to the current user whose UiElements match the specified ''identifierPath''.		Gets a list of dashboard objects accessible to the current user whose UiElements match the specified ''identifierPath''.

	The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', the returned View UiElement includes the ''ProjectPath'' property, containing the part of the absolute identifier path without the UiElement identifier~~. If the current user does not have access to all projects in the path, ''ProjectPath'' is ''null''~~.		The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', the returned View UiElement includes the ''ProjectPath'' property, containing the part of the absolute identifier path without the UiElement identifier.

	The ''projectId'' query parameter is optional. If it is specified and ''identifierPath'' is a relative path, only dashboards belonging to that project are returned.		The ''projectId'' query parameter is optional. If it is specified and ''identifierPath'' is a relative path, only dashboards belonging to that project are returned.

Ollvihe: /* Methods */

2026-06-08T20:58:04Z

Methods

← Older revision		Revision as of 20:58, 8 June 2026
Line 6:		Line 6:
	The dashboards API has the following methods.		The dashboards API has the following methods.

			=== Get dashboard by identifier===
	<pre>		<pre>
	GET api/dashboards?identifierPath={identifierPath}&includeProjectPath={includeProjectPath}&projectId={projectId}		GET api/dashboards?identifierPath={identifierPath}&includeProjectPath={includeProjectPath}&projectId={projectId}
Line 15:		Line 16:
	The ''projectId'' query parameter is optional. If it is specified and ''identifierPath'' is a relative path, only dashboards belonging to that project are returned.		The ''projectId'' query parameter is optional. If it is specified and ''identifierPath'' is a relative path, only dashboards belonging to that project are returned.

			=== Get dashboard by ID ===
	<pre>		<pre>
	GET api/dashboards/{dashboardId~~}?includeProjectPath={includeProjectPath~~}		GET api/dashboards/{dashboardId}
	</pre>		</pre>
	Gets a dashboard object by id. The ''dashboardId'' is the database ~~id of~~ the dashboard~~'s UiElement~~.		Gets a dashboard object by ID. The ''dashboardId'' is the database IDof the dashboard.

	The returned Dashboard object's ''Views'' property contains only the UiElement identified by ''dashboardId''. That UiElement includes a ''Permissions'' property containing the current user's permissions for the project the UiElement belongs to. If the UiElement's ''ProjectId'' is 0 or null, the ''Permissions'' property contains the user's global permissions.		The returned Dashboard object's ''Views'' property contains only the UiElement identified by ''dashboardId''. That UiElement includes a ''Permissions'' property containing the current user's permissions for the project the UiElement belongs to. If the UiElement's ''ProjectId'' is 0 or null, the ''Permissions'' property contains the user's global permissions.

	The ''includeProjectPath'' query parameter is optional and defaults to ''true''. When it is ''true'', the returned View UiElement includes the ''ProjectPath'' property. If the current user does not have access to all projects in ~~the path, ''ProjectPath'' is ''null''.~~		=== Get dashboards in project ===

	<pre>		<pre>
	POST api/dashboards/?projectId={projectId}		POST api/dashboards/?projectId={projectId}
Line 31:		Line 32:
	Returns a dashboard creation result object, not the created Dashboard object. The result contains the saved dashboard View UiElement's ''Id'', ''Name'', and ''IdMappings'' from input object ids to database ids.		Returns a dashboard creation result object, not the created Dashboard object. The result contains the saved dashboard View UiElement's ''Id'', ''Name'', and ''IdMappings'' from input object ids to database ids.

			=== Modify dashboard ===
	<pre>		<pre>
	PUT api/dashboards/{dashboardId}		PUT api/dashboards/{dashboardId}

Ollvihe at 09:56, 5 June 2026

2026-06-05T09:56:43Z

← Older revision		Revision as of 09:56, 5 June 2026
Line 37:		Line 37:

	When a dashboard is saved, the relevant UiElement is the first View UiElement in the Dashboard object's ''Views'' property. For an existing element, the saved properties include ''Name'', ''Description'', ''Identifier'', and custom or optional parameters, and the element's update metadata is refreshed.		When a dashboard is saved, the relevant UiElement is the first View UiElement in the Dashboard object's ''Views'' property. For an existing element, the saved properties include ''Name'', ''Description'', ''Identifier'', and custom or optional parameters, and the element's update metadata is refreshed.

	~~==Permissions==~~
	~~Viewing a dashboard requires ''GenericRead'' permission for all projects containing the dashboard's underlying UiElements.~~

	~~Creating, modifying, and deleting a dashboard requires ''EditDashboards'' permission for all projects containing the dashboard's underlying UiElements.~~

	~~==Deleting dashboards==~~
	~~There is no documented~~

	~~<pre>~~
	~~DELETE api/dashboards/{id}~~
	~~</pre>~~

	~~method in the dashboard API requirements. To delete a dashboard view, use the Workspace Elements API for the underlying UiElement of type ''View'', for example:~~

	~~<pre>~~
	~~DELETE api/uielements/{elementId}~~
	~~</pre>~~

	~~or the bulk Workspace Elements delete method:~~

	~~<pre>~~
	~~DELETE api/uielements/~~
	~~</pre>~~

Ollvihe at 09:55, 5 June 2026

2026-06-05T09:55:54Z

← Older revision		Revision as of 09:55, 5 June 2026
Line 1:		Line 1:
	Dashboards API provides functions for accessing ~~Dashboard~~ objects: finding dashboards by identifier path, getting a dashboard by id, creating dashboards, and modifying existing dashboards.		Dashboards API provides functions for accessing dashboard objects: finding dashboards by identifier path, getting a dashboard by id, creating dashboards, and modifying existing dashboards.

	~~A Dashboard object represents a dashboard created in the PA UI. Its ''Views'' property is a JSON array of UiElements and should contain one UiElement of type ''View''.~~		Note that the [[Web API for Workspace Elements\|Workspace Elements API]] also operates on dashboards as UiElements of type ''View''. Dashboard deletion is handled through the Workspace Elements API.

	Note that the [[Web API for Workspace Elements\|Workspace Elements API]] also operates on ~~dashboard views~~ as UiElements of type ''View''. Dashboard deletion is handled through the Workspace Elements API~~, not through a documented DELETE method under ''api/dashboards''~~.

	==Methods==		==Methods==