REST API Workbook
- 1 Read Workbook
- 1.1 Description
- 1.2 URI syntax
- 1.3 Example response
- 2 Read Workbook (version 2)
- 2.1 Description
- 2.2 URI syntax
- 2.3 Example response
- 3 Create Workbook
- 3.1 Description
- 3.2 URI syntax
- 3.3 Example response
- 3.4 Additional notes
- 4 Create Workbook (version 2)
- 4.1 Description
- 4.2 URI syntax
- 4.3 Response
- 4.4 Additional notes
- 5 Update Workbook
- 5.1 Description
- 5.2 URI syntax
- 5.3 Example response
- 5.4 Additional notes
- 6 Update Workbook (version 2)
- 6.1 Description
- 6.2 URI syntax
- 6.3 Response
- 6.4 Additional notes
- 7 Delete Workbook
- 7.1 Description
- 7.2 URI syntax
- 7.3 Example response
- 8 Metadata of Workbook
- 8.1 Description
- 8.2 URI syntax
- 8.3 Example response
- 9 Download Data of Workbook
- 9.1 Description
- 9.2 URI syntax
- 9.3 Example response
- 10 Sheet Details of Workbook
- 10.1 Description
- 10.2 URI syntax
- 10.3 Example response
- 11 List All Workbooks
- 11.1 Description
- 11.2 URI syntax
- 11.3 Example response
- 12 Start Workbook
- 12.1 Description
- 12.2 URI syntax
- 12.3 Example response
- 13 Workbook Dependencies
- 13.1 Description
- 13.2 URI syntax
- 13.3 Example response
- 13.4 Additional notes
- 14 View Workbook Permissions
- 14.1 Description
- 14.2 URI syntax
- 14.3 Response
- 14.4 Advanced Parameters
- 14.4.1 View the workbook's permissions for others
- 14.4.2 URI syntax
- 14.4.3 View the workbook's permissions for groups
- 14.4.4 URI syntax
- 14.4.5 View the workbook's permissions for a specific group
- 14.4.6 URI syntax
- 15 Roll Back a Workbook
- 15.1 Description
- 15.2 URI syntax
- 15.3 Response
For each call, you can add the following command:
-w"\n%{http_code}\n"
After the username and password in order to receive more meaningful HTTP errors.
This REST API call has been deprecated as of Datameer v7.0 and is scheduled to be removed before the release of Datameer v8.0. It is replaced by the call Read Workbook v2.
Request method - GET
Description
Returns information on a specified workbook within Datameer including version number, class name, file information (uuid, path, description, name), run schedule, custom properties, and sheet data.
URI syntax
curl -u <username>:<password> -X GET 'http://<Datameer-serverIP>:<port-number>/rest/workbook/<workbook-configuration-id>'
Example response
Request method - GET
Description
Reads a workbook based on a JSON representation for the workbooks using the Git versioning plug-in.
URI syntax
curl -u <username>:<password> -X GET 'http://<Datameer-serverIP>:<port-number>/api/workbooks/<file-id>'
Example response
This REST API call has been deprecated as of Datameer v7.0 and is scheduled to be removed before the release of Datameer v8.0. It is replaced by the call Create Workbook v2.
Request method - POST
Description
Adds a workbook in Datameer.
URI syntax
curl -u <username>:<password> -X POST -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/rest/workbook'
Example response
{
"configuration-id": 48,
"status": "success"
} Additional notes
<file name>.json
The workbook file is a JSON representation of all information entered during the creation process using the web interface.
An easy method of creating a workbook file is to use REST to read an import job, data link ,or workbook and change the JSON that is returned.
Injecting a workbook from a JSON file needs to match the current version of Datameer. Backup workbooks from previous versions of Datameer aren't supported unless properly migrated during the upgrade.
Request method - POST
Description
Creates a workbook based on a JSON representation for workbooks using the Git versioning plug-in.
URI syntax
curl -u <username>:<password> -X POST -H "Content-Type:application/json" -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/api/workbooks'
Response
If the request is successful, there is no output.
Additional notes
<file name>.json
The workbook file is a JSON representation of all information entered during the creation process using the web interface.
An easy method of creating a workbook file is to use REST to read an import job, data link ,or workbook and change the JSON that is returned.
Injecting a workbook from a JSON file needs to match the current version of Datameer. Backup workbooks from previous versions of Datameer aren't supported unless properly migrated during the upgrade.
This REST API call has been deprecated as of Datameer v7.0 and is scheduled to be removed before the release of Datameer v8.0. It is replaced by the call Update Workbook v2.
Request method - PUT
Description
Edits an existing workbook in Datameer.
URI syntax
curl -u <username>:<password> -X PUT -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/rest/workbook/<workbook-configuration-id>'
Example response
{"status": "success"} Additional notes
<file name>.json
The workbook file is a JSON representation of all information entered during the creation process using the web interface.
An easy method of creating a workbook file is to use REST to read an import job, data link ,or workbook and change the JSON that is returned.
Injecting a workbook from a JSON file needs to match the current version of Datameer. Backup workbooks from previous versions of Datameer aren't supported unless properly migrated during the upgrade.
Request method - PUT
Description
Updates an existing workbook using the Git versioning plug-in.
URI syntax
curl -u <username>:<password> -X PUT -H "Content-Type:application/json" -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/api/workbooks/<file-id>
Response
If the request is successful, there is no output.
Additional notes
<file name>.json