- Welcome to the EasyVista Wiki
- Integrations
- Web Services REST
- REST API - View a list of manufacturers
REST API - View a list of manufacturers
GET /manufacturers
- This method allows a list of manufacturers to be obtained.
- To obtain detailed information about a specified manufacturer: GET /manufacturers/{manufacturer_id} -
method View a manufacturer
Notes
- If successful, an HTTP status code 200 is returned.
- Only an extract of the most useful fields selected by
is displayed for each record provided.
- A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained if required.
- Only an extract of the most useful fields selected by
List of parameters / objects
Mandatory parameters
None
Optional parameters
You can use the parameters detailed below in the HTTP request string.
Objet | Type | Description / Example |
---|---|---|
max_rows | integer | Maximum number of records to display.
|
sort | string | Sort in ascending or descending order.
|
fields | string | Select fields to display.
|
search | string | Search/filter the specified fields. ![]()
|
Fields that could be used in filters
You can use all the JSON fields from the AM_MANUFACTURER table.
HTTP status codes for the method
StatusHeader
Code | Error | Description |
---|
Status200
200 | OK (Success) | Request processed successfully. |
Status401
401 | Unauthorized | Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect ![]() |
![]() { "error": "Invalid Login / Password" } |
Example
Result for 2 manufacturers (status code 200)
"HREF": "https://{your_server}/api/v1/{your_account}/manufacturers?search=manufacturer~%22%2Alat%2A%22",
"record_count": "2",
"total_record_count": "2",
"records": [
{
"HREF": "https://{your_server}/api/v1/{your_account}/manufacturers/401",
"DISCOVERY_NAME": "",
"MANUFACTURER": "Platinum Technology "
},
{
"HREF": "https://{your_server}/api/v1/{your_account}/manufacturers/786",
"DISCOVERY_NAME": "",
"MANUFACTURER": "Kalatel"
}
]
}
ConventionsAPI
REST API Conventions
Convention | Meaning |
---|---|
Orange | Parameters used in an HTTP request string (URL) which do not correspond to ![]() |
![]() 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 ![]() |
Green | Parameters used in the body of an HTTP request which represent JSON object names corresponding to ![]() |
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to ![]() |
|