POST project/instructions

Sets the instructions to the specified project.

Endpoint

POST http(s)://hostname/api/project/instructions

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.
instructions	string	Required. The project instruction in textual or html format.

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": {
    "name": "The project name",
    "id": "The project id",
    "link": "The link to the project home page"
  }
}

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

Example

curl -X POST "https://hostname/api/project/instructions?id=1&instructions=these are the instruction to evaluate..." -H "X-Api-Key: {user access token}"

{
  "header": {
    "date": "Monday, 2016-05-16 11:54:17 Europe/Paris",
    "description": "Sets the instructions to the specified project.",
    "status": "200"
  },
  "result": {
    "name": "test project",
    "id": 1,
    "link": "https://mtequaldev.fbk.eu/admin?pid=1"
  }
}