MT-EQuAl REST API
GET project/import
Imports the evaluation format and/or guidelines (specifications and guidelines) from another project.
Endpoint
GET http(s)://hostname/api/project/import
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. |
Request data | Type | Value |
---|---|---|
id | string | Required. The project id. |
basedOn | string | Required. The project id from which to import the configuration. |
evalformat | {0, 1} | Optional. 1 to import the evaluation format from the other project;
0 otherwise. |
guidelines | {0, 1} | Optional. 1 to import the guidelines from the other project;
0 otherwise. |
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": {
"id": "The project id",
}
}
Example
curl -X GET "https://hostname/api/project/import?id=1&evalformat=1&guidelines=1&basedOn=5" -H "X-Api-Key: {user access token}"
{
"header": {
"date": "Thursday, 2016-06-09 16:32:40 Europe\/Paris",
"description": "Imports the evaluation format and/or guidelines (specifications and guidelines) from another project.",
"status": "200"
},
"result": {
"id": "1",
}