Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

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

The following are the REST APIs that are implemented in WSO2 DAS 3.1.0.

FunctionREST API
Checking if a table existsGET /analytics/table_exists?table={tableName}
Listing all tablesGET /analytics/tables
Retrieving records of a tableGET /analytics/tables/{tableName}/{from}/{to}/{start}/{count}?columns={columns}
Getting the record count of a tableGET /analytics/tables/{tableName}/recordcount
Searching records of a tablePOST /analytics/search
Defining/updating the schema of a tablePOST /analytics/tables/{tableName}/schema
Getting the search record count of a tablePOST /analytics/search_count
Timing out the indexing process completion GET/analytics/indexing_done?timeout=<long-value>
Getting the schema of a tableGET /analytics/tables/{tableName}/schema
Drilling down through hierarchical categories POST /analytics/facets
Retrieving matching records through a drill down search POST /analytics/drilldown
Retrieving the count of matching records through a drill down search POST/analytics/drillDownScoreCount
Retrieving records using given primary key value pairs POST/analytics/tables/{tableName}/keyed_records
Retrieving All Record StoresGET /analytics/recordstores
Retrieving the Record Store of a Given TableGET /analytics/recordstore?table={tableName}
Checking if the Given Records Store Supports PaginationGET /analytics/pagination/<recordstore-name>
Tracking the Indexing Process Completion of a TableGET /analytics/indexing_done?maxWait=10&table={tableName}
Retrieving Aggregated Values of Given RecordsPOST /analytics/aggregates
Retrieving the Event Count of Range FacetsPOST /analytics/rangecount
Re-indexing the Records of a Given TablePOST /analytics/tables/{tableName}/{from}/{to}
Clear Index Information of a Given Table via REST APIDELETE /analytics/tables/{tableName}/indexData
Retrieving the Persisted Name of a TableGET /analytics/tables/<Table_Name>/persistName
Retrieving the Actual Name of a TableGET /analytics/tables/<ENCODED_NAME>/actualName
Info

Anchor
AuthHeader
AuthHeader
The REST APIs are secured with basic authentication. Therefore, follow the steps below to add a basic auth header when calling these methods.

  1. Build a string of the form username:password.
  2. Encode the string you created above using Base64. For encoding the above string using Base64, see Encode to Base64 format.
  3. Define an authorization header with the term "Basic_", followed by the encoded string. For example, the basic auth authorization header using "admin" as both username and password is as follows: 
    Authorization: Basic YWRtaW46YWRtaW4=

...