REST API - Suspend a ticket


PUT  /requests/{rfc_number}

  • To reopen a ticket: PUT /requests/{rfc_number}. Open url.png See the method.

Notes

      Open url.png  See Service Manager REST API Conventions.

  • You must supply a table in JSON format in the body of the HTTP request.
  • You must use a suspended 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 / 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".

    example  "e_mail": "test@easyvista.com"

  • 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 integer Ticket identifier

Optional parameters

None

Optional fields

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

Description of the actions carried out

A suspend action for the ticket is created.

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 Service Manager account.

example

{
 "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

{
 "error": "Resource not found"
}
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

{
"suspended":  {
   "Comment": "Incident suspended via REST API",
   "done_by_id": 18665
    }
}

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 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/2019 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)"  }  }

Tags:
Last modified by Unknown User on 2020/03/30 11:47
Created by Administrator XWiki on 2017/04/07 12:03

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020