API Operations
There are over 30 operations provided in the API to allow developers to extend and explore their apps and data. This level of flexibility allows for countless applications.
Content Services
Content API Services provide features related to application development and the discovery of those applications.
| Operation | Description |
|---|---|
| ListApps | Lists the apps |
| GetApp | Gets the properties, views, and entities of an app |
| GetAppsMap | Gets map of the relationships between all apps |
| GetWorkbook | Gets the raw xml of an app |
| ListMedia | Lists the media files |
| GetMedia | Gets a media file |
| PutMedia | Creates or updates a media file |
| DeleteMedia | Deletes a media file |
| ListPblPages | Lists the PBL pages |
| GetPblPage | Gets a PBL page |
| PutPblPage | Creates or updates a PBL page |
| ListPblPageVersions | Lists the versions of a PBL page |
| GetPblPageVersion | Gets a specific version of a PBL page |
| Build | Requests a build all apps or an individual app and returns the task id |
| GetTask | Gets the status of a task |
Data Services
Data API Services provide features related to application execution and data.
| Operation | Description |
|---|---|
| ListTransactions | Lists the transactions of a store |
| GetTransaction | Gets a transaction of a store |
| PutTransaction | Creates a transaction of a store |
| DeleteTransaction | Deletes a transaction of a store |
| RebuildStore | Rebuilds a store by replaying all of its transactions |
| GetStore | Gets a store |
| PutStore | Creates or updates a store |
| DeleteStore | Deletes a store and its transactions and entities. This operation is permanent. |
| GetArtifact | Gets an artifact |
| PutArtifact | Creates or updates an artifact |
| GetStoreProperty | Gets the property of a store |
| SetStoreProperty | Sets the property of a store |
| QueryStore | Gets the result of an xpath query against a store |
| SelectEntities | Selects entities of an app |
| Publish | Executes various publishing operations on a store |
For a full API Reference, please view the metadata page of your site by browsing to:
https://<site>/rql/api