Petition Details
- Base URL: {host}/ASMSAPI/
- Uri: api/v9/task
- Type: POST
-
Required headings:
- content-type: application/json
- X-Authorization: Bearer {token}
URL Description
- {host}: It represents the domain of the environment in which the API is located.
- ASMSAPI/: Fixed API prefix.
- URI: Specific endpoint for the request.
⚐ EXAMPLE URL:
https://{host}/ASMSAPI/api/v9/task
Parameters
Name | Data type | Obligatory | Description |
---|---|---|---|
parentId | Number | Yes | Identifier of the case to which the task will be related. |
subject | Text | Yes | Task Subject |
Description | Text | Yes | HTML description of the task |
projectId | Number | Yes | Project ID |
listAdditionalField | List | No | List of additional fields |
modelId | Number | Yes | Task model ID |
consoleType | Text | Yes | Console Type - Specialist = 1, - Client = 2, - Administrator - 3 |
responsibleId | Number | No | Id of the responsible user, if it is not sent, the default Id will be taken. |
groupId | Number | No | Id of the responsible group, if it is not sent, the default Id will be taken. |
relationTypeId | Number | Yes | Type identifier of the relationship between the case and the task |
startDate | Date | No | Start date of the task. This will be calculated if the duration time is added. |
End Date | Date | Yes | End date. This will be calculated if the duration time is added. |
Duration | Number | Yes | Duration of the task. |
consoleType | Text |
Body of the petition
{
"consoleType": "specialist",
"description": "<p>Hola</p>", "endDate": 1632323155773,
"duration": 600,
"groupId": 5,
"hasPendingSurvey": false,
"instance": 1632287170697,
"isModified": true,
"itemType": 6,
"itemVersion": 0,
"listAdditionalField": [],
"modelId": 62,
"parentId": 84411,
"projectId": 19,
"reasonId": 839,
"relationTypeId": 143,
"responsibleId": 4832,
"startDate": 1632287155773, "stateId": 613,
"subject": "Hola ",
"tempId": -1
}
Answer
{
"Id": 11454,
"IdByProject": "Tarea 11454"
}
Response Parameters:
Name | Data type | Description |
---|---|---|
Id | Int | Task ID |
IdByProject | String | Task Project Identifier |
Error messages
Code | HTTP status | Error Message |
---|---|---|
400 | BadRequest | \r\nParameter Name: Request |
400 | BadRequest | \r\nParameter Name: ConsoleType |
400 | BadRequest | InvalidConsole |
400 | BadRequest | ParentIdIsRequired |
400 | BadRequest | InitialDateIsRequired |
400 | BadRequest | FinalDateIsRequired |
400 | BadRequest | DurationIsRequired |
400 | BadRequest | InvalidParentId |
400 | BadRequest | InvalidRelationTypeId |
500 | InternalServerError | FailureAddTask |