Versions Compared

Old Version 3

changes.mady.by.user Juliane Wetzel

Saved on

compared with

New Version Current

changes.mady.by.user Juliane Wetzel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

Create a Workbook v2

Request Method POST
Description

Creates a workbook based on a JSON representation for workbooks using the Git versioning plug-in.

URI Syntax


No Format
curl -u <username>:<password> -X POST -H "Content-Type:application/json" -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/api/workbooks'


Example Response


If the request is successful, there is no output.
No Format
"status": "success",
"configuration-id": 50,
"file-id": 57,
"file-uuid": "9424e496-6e1c-416c-b235-0dbe3dd80f33",
"file-path": "/Users/admin/NewWorkbook_wb"

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 X aren't supported unless properly migrated during the upgrade.


...

Section

Update a Workbook v2

Request Method PUT
Description

Updates an existing workbook using the Git versioning plug-in.

URI Syntax


No Format
curl -u <username>:<password> -X PUT -H "Content-Type:application/json" -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/api/workbooks/<file-id>'


Example Response


If the request is successful, there is no output.
No Format
"status" : "success"
"configuration-id": 43,
"file-id": 50,
"file-uuid": "7a6956d1-35c1-4be0-9fb9-f37994df8583",
"file-path": "/Users/admin/Workbook.wbk"

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 X aren't supported unless properly migrated during the upgrade.


...