REST API - Create a task for a ticket
Last modified on 2022/11/08 13:22
Contents
POST /requests/{rfc_number}/tasks
- This method allows a new task for a specified ticket to be created (a ticket includes incident, service request, change request, investment request, problem and event).
example /requests/S161123_000034/tasks
- The method supports the creation of a single task per call.
Notes
See Service Manager REST API Conventions.
- You must supply a table in JSON format in the body of the HTTP request.
- To define the type of action for the task to be created, you can use the name of the action_type_id (preferably) or the action_type_name object. In the latter case, you must enter the value of the object in the language of the user logged in to the REST API.
- To define the group assigned to the task, you can use the name of the group_id, the group_name or the group_mail object.
- If successful, an HTTP status code 201 is returned and a URL link (HREF) to the created resource is provided.
CommonNotes_JSONandFields
JSON Format / Field Format:
- The field names are those of the Service Manager.data model.
example available_field_1
- To update a field, respect the following JSON format: "field_name":"value".
- JSON object names, including those representing Service Manager database fields, are not case sensitive.
example field_name, Field_Name and FIELD_NAME are equivalent
List of parameters / fields
Mandatory parameters
You must use the parameter below in the URL.
| Parameter | Type | Description / Example |
|---|---|---|
| rfc_number | string | Ticket identifier |
You must use the JSON objects below in the body of the HTTP request.
| Parameter | Type | Description / Example |
|---|---|---|
| action_type_id, action_type_name | integer / string | Identifier / Name for the action type to be created |
| group_id / group_mail / group_name | integer / string | Identifier / E-mail address / Name of the group who must perform the task |
Optional parameters
None
Description of the actions carried out
A task associated with the ticket is created.
- status Ended
- creation date (creation_date_ut) = now if not specified
- calculation of the task's duration if not specified (elapsed_time) = real end date - date dealt with, with application of the schedule and holidays of the SLA
HTTP status codes for the method
StatusHeader
Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).
| Code | Error | Description |
|---|
Status201
| 201 | Created | Request processed successfully and an item created. |
Status401
| 401 | Unauthorized | Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect Service Manager account.
example { "error": "Invalid Login / Password" } |
Status405
| 405 | Method not allowed | Request method not authorized: not supported or not appropriate for the resource.
example { "error": "Invalid input parameter" } |
Examples
Example of the body of an HTTP request
{
"action_type_id": "19",
"group_mail": "hotline@itassetservices.fr",
"Elapsed_Time": "12",
"time_cost": "99",
"contractual_cost": "129",
"description": "Task comment",
"creation_date_ut": "",
"start_date_ut": "",
"end_date_ut": "",
"available_field_1": "aaa",
"available_field_6": "fff"
}
"action_type_id": "19",
"group_mail": "hotline@itassetservices.fr",
"Elapsed_Time": "12",
"time_cost": "99",
"contractual_cost": "129",
"description": "Task comment",
"creation_date_ut": "",
"start_date_ut": "",
"end_date_ut": "",
"available_field_1": "aaa",
"available_field_6": "fff"
}
Result with a status code 201 returned
{
"HREF": "https://{your_server}/api/v1/{your_account}/requests/I161107_000004"
}
"HREF": "https://{your_server}/api/v1/{your_account}/requests/I161107_000004"
}
ConventionsAPI
REST API Conventions
| Convention | Meaning | |
|---|---|---|
| Orange | Parameters used in an HTTP request string which do not correspond to Service Manager database fields.
example Method View a list of assets https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag |
|
| Black and Bold | Parameters used in the URL of an HTTP request which correspond to Service Manager database fields.
example Method View an asset https://{your_server}/api/v1/{your_account}/assets/{asset_id} |
|
| Green | Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified.
example Method Close an incident/request { "closed": { "end_date": "11/20/2016 12:12:12", } } |
|
| Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.
example Method Reopen an incident/request { "restarted": { "comment": "string (required)" } } |
||