The REST API allows you to configure, monitor, and operate Datameer without using the web console. Instead, you can use command line tools (e.g., cURL or Wget) using HTTP protocol. The API can be used by scripts or with a monitoring tool. Requests are made using a URL and a command, and responses are returned in JSON format.

Overview Table REST Commands

• REST API Administrator Information
  • Data Volume Limit
  • Global Volume and License Information
  • Upload License File
  • Product ID
  • Metrics
  • JAMon

• REST API Connections
  • Read 
  • Create
  • Update
  • Delete
  • List All
  • Dependencies
  • How-tos

• REST API Export Jobs
  • Read
  • Create
  • Update
  • Delete
  • List All
  • Start
  • Cancel
  • Dependencies

• REST API Files
  • Read a File
  • Read the Permissions of a File
  • Read the Group Permissions of a File
  • Read the Others Permissions of a File
  • Read the Owner of a File
  • Change the Owner of a File
  • Create a Group Permission for a File
  • Change the Group Permission for a File
  • Change the Others Permissions for a File
  • Delete Group Permission of a File

• REST API Folders
  • Read the Root Folder
  • Read the Folder
  • Read the Permissions of a Folder
  • Read the Group Permissions of a Folder
  • Read the Others Permissions of a Folder
  • Read the Owner of a Folder
  • Change the Owner of a Folder
  • Create a Group Permission for a Folder
  • Change the Group Permissions for a Folder
  • Change the Others Permissions for a Folder
  • Delete the Group Permission of a Folder
  • Download a Folder as a Zip
  • Migrate/Restore a Folder from a Zip
  • Back Up File or Folder with Permissions
  • Back Up File or Folder with Group Permissions
  • Back Up File or Folder with File Sharing
  • Back Up File or Folder with Owners
  • Restore File or Folder Permissions
  • Restore Fire or Folder Group Permissions
  • Restore File or Folder with File Sharing
  • Restore File or Folder with Owners

• REST API Import Jobs, Data Links, and File Uploads
  • Read
  • Create
  • Update
  • Delete
  • Metadata
  • Download Data
  • Sheet Details
  • Dependencies
  • List All
  • Start
  • Cancel
  • How-tos

• REST API Infographics
  • Read
  • Create
  • Update
  • Delete
  • List all
  • Dependencies

• REST API Job Commands
  • Job Status
  • Job History
  • Job Details
  • List Active Jobs
  • Delete Job

• REST API User Management
  • View User Management REST API
  • List All Groups
  • List All Roles
  • List All Users
  • Logged in User Account Information
  • Create a User
  • Import a User from External Authenticator
  • Update a User
  • Update a User Imported from External Authenticator
  • Delete a User
  • Set or Update Password to Existing User
  • Send Notification When Setting or Updating a Password
  • Send Notification When Creating a User
  • Create a Role
  • Delete a Role
  • Update a Role
  • Create a Group
  • Delete a Group
  • Update a Group

• REST API Workbooks
  • Read
  • Create
  • Update
  • Delete
  • Metadata
  • Download Data
  • Sheet Details
  • List All
  • Start
  • Cancel
  • Dependencies
  • Read Using GIT
  • Create Using GIT
  • Update Using GIT
  • Roll Back

REST API and JMX

• You can also start Datameer with the following parameters, causing the internal MBean server to start with Datameer.

  <Datameer Application Folder>/bin/conductor.sh start --jmx

• Open the JConsole with the following command:

  
  

  # jconsole localhost:6789

• You should see the Datameer RestController as an MBean. You can then access the following operations:

  readJobStatus
  readJobHistory
  readJobExecution
  deleteJobExecutionData

• Status for these operations is returned as a JSON (either as a file or directly in the command line interface).

Authentication

As of Datameer 7.1.6

For enhanced security performance, users are not able authenticate a REST API call using session cookies. Datameer recommends using basic authentication when using the REST API.

Example:

curl -u <username>:<password>