REST API - View a supplier
GET /suppliers/{supplier_id}
- This method allows information for a specified supplier to be obtained.
example /suppliers/56
Notes
See Service Manager REST API Conventions.
- If successful, an HTTP status code 200 is returned:
- A URL link (HREF) to the resource is provided.
- All fields are provided, including e_field_name and available_field_x, except for certain sensitive fields reserved for EasyVista.
List of parameters / fields
Mandatory parameters
You must use the parameter below in the URL.
| Parameter | Type | Description / Example |
|---|---|---|
| supplier_id | integer | Supplier identifier |
Optional parameters
You can use the parameters detailed below in the HTTP request string.
| Minimum version | Parameter | Type | Description / Example | ||
|---|---|---|---|---|---|
| fields | string | Select fields to display.
|
|||
| Oxygen 1.7 - Build 2018.1.131.0 | formatDate | string | Format display of Date fields in the HTTP request result. See Description of the options.
|
Optional fields
None
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 |
|---|
Status200
| 200 | OK (Successful) | Request successfully processed. |
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" } |
Example
Result with a status code 200 returned
"HREF": "https://{your_server}/api/v1/{your_account}/suppliers/56",
"ADDRESS_1": "1501 api create supplier",
"ADDRESS_2": "",
"AVAILABLE_FIELD_1": "",
"AVAILABLE_FIELD_2": "",
"AVAILABLE_FIELD_3": "",
"AVAILABLE_FIELD_4": "",
"AVAILABLE_FIELD_5": "",
"AVAILABLE_FIELD_6": "",
"CITY": "",
"COMMENT_SUPPLIER": {
"HREF": "https://{your_server}/api/v1/{your_account}/56/comment_supplier"
},
"COUNTRY_ID": "",
"CURRENCY_ID": "",
"DISCOUNT_RATE": "",
"E_MAIL": "testapi@create.com",
"FAX": "",
"LOCATION_PATH": "",
"LOCATION_ID": "6",
"MAIN_PHONE": "",
"PHONE": "",
"SUPPLIER": "API create",
"SUPPLIER_BEGIN_OF_CONTRACT": "",
"SUPPLIER_END_OF_CONTRACT": "",
"SUPPLIER_PATH": "API create",
"SUPPLIER_ID": "56",
"SUPPLIER_TYPE_ID": "",
"WEB_SITE": "",
"ZIP_CODE": ""
}
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)" } } |
||