REST API - Update an action

Last modified on 2022/11/08 13:22

Minimum version Service Manager: Oxygen 1.7 - Build 2018.1.131.0

PUT  /actions/{action_id}

  • This method allows a specified action to be modified.
             example   /actions/54638

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.
  • 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".
  • 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 parameters below in the URL.
  • You must use at least one of the optional fields in the body of the HTTP request. Otherwise an error is returned.
     
Parameter Type Description / Example
action_id integer Action identifier

Optional parameters

None

Optional fields

You can use all the fields from the AM_ACTION table except those mentioned below in the body of the HTTP request.

  • automatic_action 
  • delete_action 
  • old_value ; new_value 
  • wizard_guid 
  • to_trunc 
  • table_name ; field_name 
  • is_locked_progress_point 
  • net_charge_cur_id 
  • previous_sibling_id 
  • process_step_id

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

{
"ACTION_LABEL_FR": "Test REST API Patch",
"ELAPSED_TIME": "2"
}

Result with a status code 201 returned

{
  "HREF": "https://{your_server}/api/v1/{your_account}/actions/54638"
}
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)"  }  }
Tags:
Powered by XWiki © EasyVista 2022