REST API - Reopen a ticket


PUT  /requests/{rfc_number}

Notes

      Open url.png  see Product name - ev itsm.png REST API Conventions 

  • You must supply a table in JSON format in the body of the HTTP request.
  • You must use a restarted object whose value is a set of JSON objects (name/value pairs).
  • If successful, an HTTP status code 201 is returned and a URL link (HREF) to the updated resource is provided.
CommonNotes_JSONandFields
  • JSON Format and Field Format:
    • The field names are those of the Product name - ev itsm.png.data model.
              Example documentation icon EN.png  available_field_1
    • To update a field, respect the following JSON format: "field_name":"value".
               Example documentation icon EN.png  "e_mail": "test@easyvista.com"
    • JSON object names, including those representing Product name - ev itsm.png database fields, are not case sensitive.
               Example documentation icon EN.png  field_name, Field_Name and FIELD_NAME are equivalent 

List of parameters / objects

Mandatory parameters

You must use the parameter below in the URL.
 

Parameter Type Description / Example
rfc_number integer Ticket identifier: /requests/{rfc_number}

Optional parameters

None

Optional fields

OptionalFields_IncidentRequest
Parameter Type Description / Example
comment string Comment
done_by_id integer Done by: Identifier

Description of the actions carried out

  • Create a restart action for the ticket.

HTTP status codes for the method

StatusHeader
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 Product name - ev itsm.png account.
Example documentation icon EN.png
{
 "error": "Invalid Login / Password"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.
Example documentation icon EN.png
{
 "error": "Resource not found"
}
Status405
405 Method not allowed Request method not authorized: not supported or not appropriate for the resource.
Example documentation icon EN.png
{
 "error": "Invalid input parameter"
}

Examples

Example of the body of an HTTP request

{
 "restarted": {
   "comment": "string (required)"
  }
}

Result with a status code 201 returned

{
 "HREF": "https://{your_server}/api/v1/{your_account}/requests/I161019_000003"
}


ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string (URL) which do not correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields; they allow the value of a database field to be assigned or modified.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }

Tags:
Last modified by Unknown User on 2018/11/14 12:31
Created by Administrator XWiki on 2017/04/07 12:03

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018