Returns the list of projects in which the authenticated users is involved.

Endpoint

GET http(s)://hostname/api/project/list

Request Parameters

Header field
Type Value
X-Api-Key
string Required. A valid access token from a registered MT-EQuAl account. The access token must have been issued on behalf of the current user.

Response

On success, the HTTP status code in the response header is 200 (OK) and the response is structured in JSON as follow:

{
  "header": {
    "date": "Date and time of the response generation process",
    "description": "Description of the invoked method or error message",
    "status": "status/error code"
  },
  "result": {
		"size": "Number of projects in the MT-EQuAl release installed on the specified hostname",
		"projects": [{
			"id": "The project id",
			"name": "The project name"
		}]
	}
}

On error, the header status and description fields contain the error code and message, respectively.

Example

curl -X GET "https://hostname/api/project/list" -H "X-Api-Key: {user access token}"
{
	"header": {
		"date": "Wednesday, 2016-06-08 12:00:44 Europe\/Paris",
		"description": "Returns the list of projects in which the authenticated users is involved.",
		"status": "200"
	},
	"result": {
		"size": 1,
		"projects": [{
			"id": 1,
			"name": "test project"
		}]
	}
}