_InclusionsLibrary-REST

Owned by Charles Bishop (Deactivated)

Jan 30, 2018

The children of this page contain information which is included in other pages. This is a library of reusable information chunks.

If you want to change any of these pages, be aware that:

Changing page names is problematic – you will need to change all the {include} and {excerpt-include} macros manually.
The content is used in many places – make sure your change is generic enough to fit the contexts in which the pages are used.

To include an excerpt from a page:

{excerpt-include:_page name|nopanel=true}

Note that the page titled '_page name' must contain the {excerpt} macro, otherwise the {excerpt-include} will not work.

{excerpt}Blah, blah, blah.{excerpt}

To include the entire contents of a page:

{include:page name}

Children of this page:

_workbookUpdate — {"status": "success"}
_workbookStart — {
_workbookSheetDetails — {
_workbookRead — {
_workbookMetadata — {
_workbookListAll — [
_workbookDownloadData — "ID","NAME","Email","Status","Check"
_workbookDelete — {"status": "success"}
_workbookCreate — {
_workbookCancel — This command does not return a response.
_UpdateUsersImportedExternalAuth — {
_UpdateAUser — {
_SetOrUpdatePasswordForExistingUser — No confirmation / Response
_SendNotificationWhenUpdatingAPassword — No confirmation / Response
_SendNotificationWhenCreatingAUser — {
_ProductID — Returns the product ID and version.4b4038ba-3550-4844-b432-4c6f64d80807das-test:Datameer-2.1.3-1.0.3
_ListAUser — {
_ListAllUsers — {
_ListAllRoles — {
_ListAllGroups — {
_listActiveJobs — [
_LicenseFileUpload — If the license is accepted.VALID
_jobStatusRead — For a running job:{
_jobPayload — <job-payload>.json
_jobHistoryRead — [
_jobDetailsRead — {
_jobDataDelete — No job or data available:{
_infographicsUpdate — {
_infographicsRead — {
_infographicsListAll — [{
_infographicsDelete — No Response for a successful action{
_infographicsCreate — {
_ImportUsersExternalAuth — {
_importUpdate — {"status": "success"}
_importStart — {
_importSheetDetails — {
_importRead — {
_importMetadata — {
_importListAll — [
_ImportJob_FileExtensions — We have three import job extensions:
_importDownloadData — "ID","NAME","Email","Status","Check"
_importDelete — {"status": "success"}
_importCreate — {
_importCancel — This command does not return a response.
_global_volume_&_license_info — {
_ExResponse-ReadWorkbook — {
_ExResponse-ReadImportJob — {
_ExResponse-ReadDashboard — {
_exportUpdate — {"status": "success"}
_exportStart — {
_exportRead — {
_exportListAll — [
_exportDelete — {"status": "success"}
_exportCreate — {
_exportCancel — This command does not return a response.
_DeleteAUser — No confirmation / Response
_dataVolumeLimitRead — [
_dashboardsRead — {
_dashboardsListAll — [
_CreateAUser — {
_connectionsUpdate — {"status": "success"}
_connectionsRead — {
_connectionsListAll — [
_connectionsDelete — Connection has successfully been deleted.
_connectionsCreate — {
_AllUserManagmentREST — {