Versions Compared

Version Old Version 2 New Version Current
Changes made by

Juliane Wetzel

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

If the request is successful, there is no output.
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
-H "Content-Type:application/json" -d @<file name>.json 'http://<Datameer-serverIP>:<port-number>/api/workbooks/<file-id>'


Example Response


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.


...

Section

Workbook Dependencies

Request Method GET
Description

Returns the hierarchy of up- and downstream dependencies for a given workbook.

PrerequisitesThis API requires enabling /wiki/spaces/DASSB100/pages/32569527063Datameer's Advanced Governance plug-in.
URI Syntax


No Format
curl -u <username>:<password> -X GET 'http://<server>:<port>/api/workbook/[configurationID]/dependencies[?direction=<upstream | downstream>][&level=<number>]'


Example Response


No Format
{
  "dependencies": [
    {
      "id": 22,
      "file": {
        "path": "/Users/admin/ImportJobTest",
        "name": "ImportJobTest",
        "type": "imp",
        "description": "",
        "uuid": "b8f258f5-90c9-451d-9058-9d3a8c9b2c5d"
      }
    },
    {
      "id": 2,
      "file": {
        "path": "/Data/Connections/Datameer X server filesystem",
        "name": "Datameer X server filesystem",
        "type": "dst",
        "description": "A data store for the local filesystem where Datameer X is running.  Note, this works ONLY for Datameer X Personal, Workgroup, and Trial editions.\n",
        "uuid": "78a2fb59-375e-4eae-b338-956ef806f7b1"
      }
    }
  ],
  "fileCountWithNoReadPermission": 0,
  "_links": {
    "self": {
      "href": "http://localhost:8088/api/workbook/23/dependencies"
    }
  }


Additional Notes

Path parameters:

  • configurationId:
    • Data type must be a number
    • Use the configuration ID

Query parameters:

  • Direction:
    • Data type must be a string
    • Optional
    • Shows either upstream or downstream
    • If left blank, shows both
  • Level:
    • Data type must be a number
    • Optional

    • If left blank, shows all levels


...