REST API
This weekend we released the initial version of the Rollbase REST API. Documentation is available here:
http://www.rollbase.com/rest/docs/REST_API.pdf
The Rollbase REST API is designed to enable integration between the Rollbase platform and
external systems via REST calls. In order to use this API the client must have a valid Rollbase
user account with login credentials: username and password. These credentials must be supplied
as parameters to the login method, the first REST call to Rollbase, which is required to establish
an API session. This call will return a session id, which must be used as the first parameter in all
subsequent API calls. To end an API session, the logout method should always be used.
The Rollbase REST API uses the same permissions mechanism as the standard Rollbase user
interface. API users must have permission to view, create, update, or delete records in order to
perform these actions via API calls. Permissions cannot bet set via the API. They can only be set
by an Administrator using the Rollbase user interface in the Setup area.
Each REST method can be accessed through URLs of the form:
https://www.rollbase.com/rest/api/{method_name}
Parameters to methods can be supplied as URL parameters for GET calls or in the HTTP request
for POST calls. The Rollbase REST API will respond with an XML document containing the result
of the call or an error message.
Example of a GET call:
https://www.rollbase.com/rest/api/login?loginName=JohnSmith&password=welcome
Response with success:
<?xml version="1.0" encoding="utf-8" ?>
<resp status="ok">
<sessionId>rest-433533393144236162</sessionId>
</resp>
Response with error:
<?xml version="1.0" encoding="utf-8" ?>
<resp status="fail">
<err>Login session is not found</err>
</resp>
REST API Methods:
login
Performs a user login and initiates an API session. This method must be called prior to any other
API call to retrieve a session id.
logout
Terminates the specified API session. This method should be called to explicitly end each API session.
getObjectDef
Retrieves the full description of a Rollbase Object Definition as an XML document (the
XML Schema Definition for the object definition document format can be
found here: http://www.rollbase.com/webapi/wsdl/objectDescription.xsd
search
Performs a full-text search in the Rollbase database. The search query has the same syntax as
that used in the standard Rollbase interface. (For more information on search syntax, see the
Rollbase User Guide or the online Help system.)
getUpdated
Retrieves an array of record ids of a specified object type, which were either created or updated
within the given date/time interval.
getDataObj
Retrieves all field data for a given record.
getDataField
Retrieves the value of a single field from a specific record.
getBinaryData
Retrieves the binary data (file attachment) associated with a particular file field from a specific
record.
getRelationships
Retrieves an array of related record ids for a given object and one of its relationships.
create
Creates a new record via a POST request containing an XML document with object name and fields for
the new record.
update
Updates an existing record via a POST request containing an XML document with valid record id and data fields to be updated. You only need to include the fields that should be changed, all fields not included will remain unchanged.
delete
Moves the specified record to the Recycle Bin.
SOAP API Updates
Several updates have been made to the SOAP API since its initial release in March including fixes for setBinaryData and working with createdBy and updatedBy fields
SOAP API documentation is available here:
http://www.rollbase.com/webapi/wsdl/WebServicesAPI.pdf
WSDL available here:
http://www.rollbase.com/webapi/wsdl/rollbase.wsdl
Stay tuned for live examples and tutorials using the REST and SOAP APIs with PHP, Java and Excel.






