[CeloxisAPI] element index
All elements
c
d
e
l
q
u
c
top
CeloxisAPI
CeloxisAPI
in CeloxisAPI.php
The Celoxis API class is a convenient way to access the Celoxis system using PHP. We recommend that you first take a look at the sample code which illustrates the API in action.
CeloxisAPI
CeloxisAPI::CeloxisAPI()
in CeloxisAPI.php
Constructor
CeloxisAPI.php
CeloxisAPI.php
in CeloxisAPI.php
CeloxisException
CeloxisException
in CeloxisAPI.php
An exception thrown by the Celoxis API when operation on the server is unsuccessful. Use the
CeloxisAPI::debugLastRequest()
function to debug.
create
CeloxisAPI::create()
in CeloxisAPI.php
Creates objects in the system
d
top
debugLastRequest
CeloxisAPI::debugLastRequest()
in CeloxisAPI.php
Prints out useful debugging information. Use it especially when you encounter an exception
decodeDate
CeloxisAPI::decodeDate()
in CeloxisAPI.php
Parses an API date and returns an array as per strptime
e
top
encodeDate
CeloxisAPI::encodeDate()
in CeloxisAPI.php
Useful function to encode date in the API format
l
top
$lastResponse
CeloxisAPI::$lastResponse
in CeloxisAPI.php
Details of the last response from the server. Use the PHP function var_dump for debugging information
login
CeloxisAPI::login()
in CeloxisAPI.php
Login with the API user. This user must have administrative privileges in the system.
q
top
query
CeloxisAPI::query()
in CeloxisAPI.php
Perform a query.
queryUtilization
CeloxisAPI::queryUtilization()
in CeloxisAPI.php
Query the planned, available and actual utilization of resources in a given time period.
u
top
update
CeloxisAPI::update()
in CeloxisAPI.php
Updates already existing objects in the system
c
d
e
l
q
u