The purpose of this guide is to provide programmers, developers, and technical managers with the knowledge of the DataCloud Application Programming Interface (API).
Not all users have full access to the Actian DataCloud API. To have full access a user must own the Actian DataCloud Development Package that includes the Management Console, access to the Designer, and access to the API. Contact your account executive to verify that your account has access to the API.
The DataCloud API supports both SOAP and RESTful services for asynchronous transactions.
Entity API Service Used to perform CRUD operations (create, read, update, delete) on a DataCloud API entity.
CloudRest API Used to perform CRUD operations (i.e. create, read, update, delete) on a DataCloud API entity using HTTP methods GET, POST, PUT and DELETE.
ACL Service API Used to retrieve the access control list (ACL) permissions associated with a DataCloud API entity.
The PostGet API Web Service is deprecated. The CloudRest API web service supports all operations from the PostGet service.
API Client for Java
The API Client .jar file contains the necessary classes for interacting easily with the SOAP-based services.
Creating Unique Service Requests
The configuration tasks can be performed from a GUI interface called the DataCloud Management Console (DMC) or programmatically via the API.
A single integration/product may be associated with many different sets of configurations, which allows each instance of the service to run as a new and unique service based on the contents of those parameters. One of the parameters is normally linked to the specific service requestor. Although not required, this method allows the owner of the service to track who has requested a service and how often, as well as retrieve results on their behalf.
Once an integration/product has been designed and deployed, then the provisioning can be configured and executed. Execution can be accomplished from the DMC or the API. The DMC is typically used when in the initial design and testing phases of an integration/product project, and the API is used once the service is placed into production for general consumption.
Results and log files related to the integration/product are also retrieved via the DMC or API. Subsequent services can be executed that can leverage these results.