REST API - View Service Manager License Key Information
Last modified on 2023/01/20 12:13
Contents
GET /license
- This method allows the information of the Service Manager license key to be obtained.
Notes
See Service Manager REST API Conventions
- If successful, an HTTP status code 200 is returned.
List of parameters / fields
Mandatory parameters
None
Optional parameters
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. |
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": "http://{your_server}/api/v1/{your_account}/license",
"License": {
"Account": "40000",
"Connected": "1",
"DateTime": "2022-02-07T16:14:06+0000",
"MaxConnexions": "9999"
}
}
"HREF": "http://{your_server}/api/v1/{your_account}/license",
"License": {
"Account": "40000",
"Connected": "1",
"DateTime": "2022-02-07T16:14:06+0000",
"MaxConnexions": "9999"
}
}
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)" } } |
||