Difference between revisions of "GetInstance"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Get a Instance information from a Instance Id |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDe...") |
(No difference)
|
Latest revision as of 17:24, 15 July 2014
Description
Get a Instance information from a Instance Id
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- instanceId (int, required)
- The number (ID) of one instance that represent an OB registered in this environment. The same of the user has been registered.
Returns
Returns a JSON object containing a Instance.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- { Object of Instance }
}
Exceptions
Caching
This method is not cached.
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |