Web API for Datatables - Revision history

Ollvihe: /* Copy datatable */

2020-12-12T22:38:32Z

Copy datatable

← Older revision		Revision as of 22:38, 12 December 2020
Line 63:		Line 63:
	POST api/datatables/copy/{id}		POST api/datatables/copy/{id}
	</pre>		</pre>
	Creates a ~~copy of a~~ datatable ~~with the~~ data. Copying the data is done in the background after the ~~operation has returned~~. ~~Takes~~ the ~~copied~~ datatable ~~properties~~ in the body. Returns the created datatable id and operation id of the ~~copy operatation~~.		Creates a new datatable and copies data to it from another datatable (datatable id provided as a parameter). Copying the data is done in the background, so the operation returns after creating the datatable and continues the copying after that. Similar to creating a new datatable, takes the new datatable entity in the body. Returns the created datatable id (DataTableId) and operation id (OperationId) of the copying operation.

	[[Category: QPR ProcessAnalyzer]]		[[Category: QPR ProcessAnalyzer]]

Ollvihe: /* Methods */

2020-12-12T19:24:20Z

Methods

← Older revision		Revision as of 19:24, 12 December 2020
Line 24:		Line 24:
	The datatables API has the following methods.		The datatables API has the following methods.

			=== List datatables ===
	<pre>		<pre>
	GET api/datatables		GET api/datatables
	</pre>		</pre>
	Gets an array of all datatable entities the user has permissions. Optional query parameter is ''projectId'' (integer) which is used to get datatables only from one project.		Gets an array of all datatable entities the user has permissions. Optional query parameter is ''projectId'' (integer) which is used to get datatables only from one project.

			=== Get datatable ===

	<pre>		<pre>
Line 33:		Line 36:
	</pre>		</pre>
	Returns a datatable entity with given id. Supports optional parameter ''includeLog'' (boolean, false by default) to return also the ''Log'' property of the datatable. If datatable with given id doesn't exist, ''not found error'' is returned. If the current user has no access to the datatable, ''unauthorized error'' is returned.		Returns a datatable entity with given id. Supports optional parameter ''includeLog'' (boolean, false by default) to return also the ''Log'' property of the datatable. If datatable with given id doesn't exist, ''not found error'' is returned. If the current user has no access to the datatable, ''unauthorized error'' is returned.

			=== Create datatable ===

	<pre>		<pre>
Line 38:		Line 43:
	</pre>		</pre>
	Creates a new empty datatable. Takes the datatable entity in the body. Returns the created datatable entity. If current user has no rights to create the datatable, ''unauthorized error'' is returned.		Creates a new empty datatable. Takes the datatable entity in the body. Returns the created datatable entity. If current user has no rights to create the datatable, ''unauthorized error'' is returned.

			=== Edit datatable ===

	<pre>		<pre>
Line 43:		Line 50:
	</pre>		</pre>
	Updates information of an existing datatable with the given id. Takes the datatable properties object in the body. Id property in the datatable entity is ignored. If datatable with given id doesn't exist, ''not found error'' is returned. If current user has no rights to modify the datatable, ''unauthorized error'' is returned.		Updates information of an existing datatable with the given id. Takes the datatable properties object in the body. Id property in the datatable entity is ignored. If datatable with given id doesn't exist, ''not found error'' is returned. If current user has no rights to modify the datatable, ''unauthorized error'' is returned.

			=== Delete datatable ===

	<pre>		<pre>
Line 48:		Line 57:
	</pre>		</pre>
	Deletes a datatable with given id. If datatable with the given id doesn't exist, ''not found error'' is returned. If current user has no rights to delete the datatable, ''unauthorized error'' is returned.		Deletes a datatable with given id. If datatable with the given id doesn't exist, ''not found error'' is returned. If current user has no rights to delete the datatable, ''unauthorized error'' is returned.

			=== Copy datatable ===

			<pre>
			POST api/datatables/copy/{id}
			</pre>
			Creates a copy of a datatable with the data. Copying the data is done in the background after the operation has returned. Takes the copied datatable properties in the body. Returns the created datatable id and operation id of the copy operatation.

	[[Category: QPR ProcessAnalyzer]]		[[Category: QPR ProcessAnalyzer]]

Ollvihe at 16:31, 1 November 2020

2020-11-01T16:31:35Z

← Older revision		Revision as of 16:31, 1 November 2020
Line 48:		Line 48:
	</pre>		</pre>
	Deletes a datatable with given id. If datatable with the given id doesn't exist, ''not found error'' is returned. If current user has no rights to delete the datatable, ''unauthorized error'' is returned.		Deletes a datatable with given id. If datatable with the given id doesn't exist, ''not found error'' is returned. If current user has no rights to delete the datatable, ''unauthorized error'' is returned.

			[[Category: QPR ProcessAnalyzer]]

Ollvihe at 16:31, 1 November 2020

2020-11-01T16:31:22Z

← Older revision		Revision as of 16:31, 1 November 2020
Line 1:		Line 1:
	Datatables API is used to create, delete and edit datatable properties. To import data to datatables, use the [[Web_API:_Importfile\|importfile method]].		Datatables API is used to create, delete and edit datatable properties. To import data to datatables, use the [[Web_API:_Importfile\|importfile method]].

	Note ~~also~~ that the [[Web API for Workspace Elements\|Workspace Elements API]] supports datatables.		Note that the [[Web API for Workspace Elements\|Workspace Elements API]] supports also datatables.

	==Datatable Entity==		==Datatable Entity==

Ollvihe at 16:24, 1 November 2020

2020-11-01T16:24:19Z

← Older revision		Revision as of 16:24, 1 November 2020
Line 1:		Line 1:
	Datatables API is used to create, delete and edit datatable properties. To import data to datatables, use the [[Web_API:_Importfile\|importfile method]].		Datatables API is used to create, delete and edit datatable properties. To import data to datatables, use the [[Web_API:_Importfile\|importfile method]].

			Note also that the [[Web API for Workspace Elements\|Workspace Elements API]] supports datatables.

	==Datatable Entity==		==Datatable Entity==

Ollvihe: /* UI Elements API */

2020-11-01T16:23:48Z

UI Elements API

← Older revision		Revision as of 16:23, 1 November 2020
Line 46:		Line 46:
	</pre>		</pre>
	Deletes a datatable with given id. If datatable with the given id doesn't exist, ''not found error'' is returned. If current user has no rights to delete the datatable, ''unauthorized error'' is returned.		Deletes a datatable with given id. If datatable with the given id doesn't exist, ''not found error'' is returned. If current user has no rights to delete the datatable, ''unauthorized error'' is returned.

	~~== UI Elements API ==~~

	~~The following UI elements API operations support datatables:~~

	~~<pre>~~
	~~POST /api/uielements/setproject/{projectid}~~
	~~</pre>~~
	Used to move dashboards and datatables to another project. Takes as a body an array of objects, with ''id'' and ''type'' (''view'', ''datatable'') properties. Useful when multiple datatables (and also other objects) are moved between projects.

	~~<pre>~~
	~~DELETE /api/uielements~~
	~~</pre>~~
	Used to delete dashboards, models and datatables. Takes as a body an array of objects, with ''id'' and ''type'' (''view'', ''datatable'') properties. Useful when multiple datatables (and also other objects) are deleted.

Ollvihe: /* UI Elements API */

2020-11-01T16:20:13Z

UI Elements API

← Older revision		Revision as of 16:20, 1 November 2020
Line 59:		Line 59:
	DELETE /api/uielements		DELETE /api/uielements
	</pre>		</pre>
	Used to delete dashboards and datatables. Takes as a body an array of objects, with ''id'' and ''type'' (''view'', ''datatable'') properties. Useful when multiple datatables (and also other objects) are deleted.		Used to delete dashboards, models and datatables. Takes as a body an array of objects, with ''id'' and ''type'' (''view'', ''datatable'') properties. Useful when multiple datatables (and also other objects) are deleted.

Ollvihe: /* Datatable Entity */

2020-10-14T10:09:22Z

Datatable Entity

Ollvihe: /* UI Elements API */

2020-09-08T17:34:41Z

UI Elements API

← Older revision		Revision as of 17:34, 8 September 2020
Line 57:		Line 57:

	<pre>		<pre>
	DELETE ~~/qprpa~~/api/uielements		DELETE /api/uielements
	</pre>		</pre>
	Used to delete dashboards and datatables. Takes as a body an array of objects, with ''id'' and ''type'' (''view'', ''datatable'') properties. Useful when multiple datatables (and also other objects) are deleted.		Used to delete dashboards and datatables. Takes as a body an array of objects, with ''id'' and ''type'' (''view'', ''datatable'') properties. Useful when multiple datatables (and also other objects) are deleted.

Ollvihe: /* Datatable Entity */

2020-08-27T22:16:08Z

Datatable Entity

← Older revision		Revision as of 22:16, 27 August 2020
Line 7:		Line 7:
	* Name (string): Datatable name.		* Name (string): Datatable name.
	* Description (string): Datatable description.		* Description (string): Datatable description.
			* NColumns (integer): Number of columns in the datatable.
			* NRows (integer): Number of rows in the datatable.
	* CreatedDate (datetime): Datatable creation date.		* CreatedDate (datetime): Datatable creation date.
	* CreatorId (integer): Id of the user who created the datatable.		* CreatorId (integer): Id of the user who created the datatable.
Line 13:		Line 15:
	* LastImportedDate (datetime): Date when data was last imported to the datatable.		* LastImportedDate (datetime): Date when data was last imported to the datatable.
	* LastImporterId (integer): Id of the user who last time imported data to the datatable.		* LastImporterId (integer): Id of the user who last time imported data to the datatable.
	* NColumns (integer): Number of columns in the datatable.
	* NRows (integer): Number of rows in the datatable.
	* Log (string): Modification and import log. Returned only when a separate parameter is specified, otherwise empty.		* Log (string): Modification and import log. Returned only when a separate parameter is specified, otherwise empty.

← Older revision		Revision as of 10:09, 14 October 2020
Line 3:		Line 3:
	==Datatable Entity==		==Datatable Entity==
	The datatables API is based on the '''datatable''' entity, which has the following properties:		The datatables API is based on the '''datatable''' entity, which has the following properties:
	* Id (integer): Datatable id.		* id (integer): Datatable id.
	* ~~ProjectId~~ (integer): Id of the project where the datatable is located. The datatable is moved to another project by changing this property.		* projectId (integer): Id of the project where the datatable is located. The datatable is moved to another project by changing this property.
	* ~~Name~~ (string): Datatable name.		* name (string): Datatable name.
	* ~~Description~~ (string): Datatable description.		* description (string): Datatable description.
	* ~~NColumns~~ (integer): Number of columns in the datatable.		* nColumns (integer): Number of columns in the datatable.
	* ~~NRows~~ (integer): Number of rows in the datatable.		* nRows (integer): Number of rows in the datatable.
	* ~~CreatedDate~~ (datetime): Datatable creation date.		* createdDate (datetime): Datatable creation date.
	* ~~CreatorId~~ (integer): Id of the user who created the datatable.		* creatorId (integer): Id of the user who created the datatable.
	* ~~LastModifiedDate~~ (datetime): Date when the datatable properties where last modified.		* lastModifiedDate (datetime): Date when the datatable properties where last modified.
	* ~~LastModifierId~~ (integer): Id of the user who last modified the datatable properties.		* lastModifierId (integer): Id of the user who last modified the datatable properties.
	* ~~LastImportedDate~~ (datetime): Date when data was last imported to the datatable.		* lastImportedDate (datetime): Date when data was last imported to the datatable.
	* ~~LastImporterId~~ (integer): Id of the user who last time imported data to the datatable.		* lastImporterId (integer): Id of the user who last time imported data to the datatable.
	* ~~Log~~ (string): Modification and import log. Returned only when a separate parameter is specified, otherwise empty.		* log (string): Modification and import log. Returned only when a separate parameter is specified, otherwise empty.

	Only the following properties in datatable objects can be modified: Name, Description and ProjectId.		Only the following properties in datatable objects can be modified: Name, Description and ProjectId.