Web API for Projects - Revision history

Ollvihe: /* Methods */

2022-04-29T09:02:58Z

Methods

2022-04-29T08:57:07Z

Methods

← Older revision		Revision as of 08:57, 29 April 2022
Line 18:		Line 18:
	<pre>		<pre>
	POST api/projects		POST api/projects
			Body:
			{
			"identifier": "New project name"
			}
	</pre>		</pre>
	Creates a new empty project. Takes the project entity in the body (read-only properties are ignored). Returns the created project entity. If current user has no rights to create project, unauthorized error is returned.		Creates a new empty project. Takes the project entity in the body (read-only properties are ignored). Returns the created project entity. If current user has no rights to create project, unauthorized error is returned.
Line 23:		Line 27:
	<pre>		<pre>
	PUT api/projects/{id}		PUT api/projects/{id}
			Body:
			{
			"typeName": "Folder",
			"identifier":"Project name",
			"name":"Project name"
			}
	</pre>		</pre>
	Updates properties of an existing project with the given id. If project doesn't exist, not found error is returned. If current user has no rights to modify the project, unauthorized error is returned.		Updates properties of an existing project with the given id. If project doesn't exist, not found error is returned. If current user has no rights to modify the project, unauthorized error is returned.

2021-09-27T16:56:09Z

← Older revision	Revision as of 16:56, 27 September 2021
Line 1:	Line 1:
		Projects API is used to create projects, delete projects and edit project properties.

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

		==Methods==
		The projects API has the following methods.

		<pre>
		GET api/projects GET
		</pre>
		Gets a list of all projects in the system (if no parameter is provided). Supports optional query parameter ''projectId'' which is project id where to get projects from.

		<pre>
		GET api/projects/{id}
		</pre>
		Gets a project entity by the project id. If project doesn't exist, not found error is returned. If current user has no access to the project, unauthorized error is returned.

		<pre>
		POST api/projects
		</pre>
		Creates a new empty project. Takes the project entity in the body (read-only properties are ignored). Returns the created project entity. If current user has no rights to create project, unauthorized error is returned.

		<pre>
		PUT api/projects/{id}
		</pre>
		Updates properties of an existing project with the given id. If project doesn't exist, not found error is returned. If current user has no rights to modify the project, unauthorized error is returned.

		<pre>
		DELETE api/projects/{id}
		</pre>
		Deletes a project with given id. If the project doesn't exist, not found error is returned. If current user has no rights to delete the project, unauthorized error is returned.

		[[Category: QPR ProcessAnalyzer]]

2021-09-26T22:45:55Z

Created blank page

New page