REST API - Update a supplier
Last modified on 2023/01/23 11:06
Contents
PUT /suppliers/{supplier_id}
- This method allows a specified supplier to be modified.
example /suppliers/56
Notes
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 parameter 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 |
|---|---|---|
| supplier_id | integer | Supplier identifier |
Optional parameters
None
Optional fields
- You can use all the fields from the AM_EMPLOYEE table except those mentioned below in the body of the HTTP request.
- lft
- rgt
- level
- path_to_compute
- In addition to the fields provided by EasyVista, you can also assign values to the fields which you have added to the Service Manager database. These are fields with the prefix e_.
example e_field_name_xyz
HTTP status codes for the method
StatusHeader
| Code | Error | Description |
|---|
Status201
| 201 | Created | Request successfully processed and element created. |
Status400
| 400 | Bad Request | Request could not be run correctly due to malformed syntax.
example { "error": "Nothing to update (check fieldnames)" } or when the "Suspend a ticket" method is called but the ticket is already suspended. The response returned is: { "error": "The request is already suspended. Operation aborted."} or when the "Reopen a ticket" method is called but the ticket is not suspended. The response returned is: { "error": "The request is not suspended. Operation aborted."} |
Status401
| 401 | Unauthorized | Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.
example { "error": "Invalid Login / Password" } |
Examples
Example of the body of an HTTP request
{
"ADDRESS_1": "1501 Page Mill Rd - REST CREATE"
}
"ADDRESS_1": "1501 Page Mill Rd - REST CREATE"
}
Result with a status code 201 returned
{
"HREF": "https://{your_server}/api/v1/{your_account}/suppliers/56"
}
"HREF": "https://{your_server}/api/v1/{your_account}/suppliers/56"
}
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)" } } |
||