API Summary List

Items in bold indicate most frequently used API calls.  Items without a description and hyperlink are currently being documented and will be updated here when available.  Please contact  [email protected] for immediate assistance.

  • Schedule
  • Dashboard
  • Export
  • RegServers
  • App
  • Contact
  • AppBuilder
  • Login
  • AdHocField
  • Audit
  • Report
  • Content
  • License Manager
  • Profile
  • Embed
  • DataFile
  • Library
  • Group
  • Session
  • AppShield
  • Values
  • SMTP

Schedule

APIDescription
POST api/Schedule/GetScheduleServicesList
POST api/Schedule/GetScheduledReportsForContact
POST api/Schedule/GetScheduledGroupReportsForContact
POST api/Schedule/DeleteScheduleGroup
POST api/Schedule/DeleteScheduledReport
POST api/Schedule/GetScheduleById
POST api/Schedule/CompileScheduleGroupReport
POST api/Schedule/SaveSchedule
POST api/Schedule/GetEligibleRecipients
POST api/Schedule/NewScheduledReport
POST api/Schedule/SaveScheduleGroup
POST api/Schedule/NewScheduleGroup
POST api/Schedule/NewScheduleGroupReport

Dashboard

APIDescription
POST api/Dashboard/MoveDashboard
POST api/Dashboard/NewSavedPrompt
POST api/Dashboard/NewSavedPrompt_old
POST api/Dashboard/GetReportData
POST api/Dashboard/NewWidget
POST api/Dashboard/NewDashboard
POST api/Dashboard/DeleteWidget
POST api/Dashboard/GetDashboardById
POST api/Dashboard/SaveFavDashboardList
POST api/Dashboard/SaveWidget
POST api/Dashboard/CopyDashboard
POST api/Dashboard/ClearCellPreference
POST api/Dashboard/HasCellPreference
POST api/Dashboard/SavePromptPreference
POST api/Dashboard/SaveDashboard
POST api/Dashboard/GetFavDashboardList
POST api/Dashboard/SearchDashboardList Retrieve a list of all dashboards

Export

APIDescription
POST api/Export/NewMetaDataExport
GET api/Export/Download?sessionToken={sessionToken}&filename={filename}&type={type}
POST api/Export/ExportKPIMetadata
POST api/Export/ExportChartMetadata
POST api/Export/ExportChart
POST api/Export/ExportKPI
POST api/Export/ExportReport

RegServers

APIDescription
POST api/RegServers/GetChildReport
POST api/RegServers/GetAdvReportTree
POST api/RegServers/GetReportTypes
POST api/RegServers/GetModuleList
POST api/RegServers/GetReportTree
POST api/RegServers/RenameAnyDBModule
POST api/RegServers/NewRegServer
POST api/RegServers/GetRegisteredServers
POST api/RegServers/GetAppModuleList
POST api/RegServers/GetAppModuleByID
POST api/RegServers/GetRegServersByAppId
POST api/RegServers/TestConnection
POST api/RegServers/GetTimeZones
POST api/RegServers/InsertAnyDbModule
POST api/RegServers/SaveRegSrv
POST api/RegServers/DelRegSrv
GET api/RegServers/Save
POST api/RegServers/Remove

App

APIDescription
POST api/App/GetApplicationList
POST api/App/SaveApplication

Contact

APIDescription
POST api/Contact/NewContact Retrieve a blank Yurbi Contact object.
POST api/Contact/GetRolesList
POST api/Contact/GetContactList
POST api/Contact/GetContactById
POST api/Contact/SaveContact Save or update Yurbi Contact object.
POST api/Contact/DeleteContact

AppBuilder

APIDescription
POST api/AppBuilder/NewReportType
POST api/AppBuilder/NewReportField
POST api/AppBuilder/NewSQLTable
POST api/AppBuilder/GetAnyDbModulesList
POST api/AppBuilder/GetAnyDbModule
POST api/AppBuilder/GetTableDef
POST api/AppBuilder/GetDataTypes
POST api/AppBuilder/DeleteReportType
POST api/AppBuilder/RenameReportType
POST api/AppBuilder/SaveAnyDbModule
POST api/AppBuilder/GetReportTree

Login

APIDescription
POST api/Login/GuestCheckCheck if there are any Public view reports and if so returns true.
POST api/Login/ValidSession Validate a login session token with Yurbi.
POST api/Login/DoLogout Clear login session on Yurbi Server.
POST api/Login/DoLogin Initiate a login session with Yurbi.

AdHocField

APIDescription
POST api/AdHocField/NewAdhocField
POST api/AdHocField/GetExistingAdhocFields
POST api/AdHocField/GetAdHocFieldFromReportTree
POST api/AdHocField/GetReportFieldFromAdhoc
POST api/AdHocField/CopyField
POST api/AdHocField/CompileSQL

Audit

APIDescription
POST api/Audit/GetAuditTypes
POST api/Audit/SaveAuditTypes

Report

APIDescription
POST api/Report/CopyReport
POST api/Report/MoveReport
POST api/Report/NewReport
POST api/Report/NewTotals
POST api/Report/NewPermission
POST api/Report/NewCriteria
POST api/Report/GetValues
POST api/Report/NewField
POST api/Report/GetReport Retrieve a report from the library that matches the provided report id and that the logged in user has permissions to view
POST api/Report/GetSQLFunctions
POST api/Report/ReportProcUI
POST api/Report/SaveReport
POST api/Report/GetReportMetadataById Retrieve a report from the library that matches the provided report id and that the logged in user has permissions too view.
POST api/Report/ExecuteScheduledReport
POST api/Report/GetReportMetadataByReport
POST api/Report/ReplacePromptCollection
POST api/Report/ReplacePrompt
POST api/Report/GetFLK
GET api/Report/Download?sessionToken={sessionToken}&filename={filename}
POST api/Report/GetReportData
GET api/Report/GetReportData?sessionToken={sessionToken}&IsDrillDown={IsDrillDown}&DrillDownCriteria={DrillDownCriteria}&isScheduledOutput={isScheduledOutput}&recipientId={recipientId}
POST api/Report/GetFieldValues
POST api/Report/ExportReport
POST api/Report/PrepareReportData?sessionToken={sessionToken}&ReportID={ReportID}
POST api/Report/EmailReportData?SessionToken={SessionToken}

Content

APIDescription
POST api/Content/UninstallContent
POST api/Content/InstallContent
POST api/Content/SampleAppInstallationStatus
POST api/Content/InstallSampleAppData
POST api/Content/SampleAppStatus
POST api/Content/SampleAppEligible
POST api/Content/RemoveSampleApp
POST api/Content/BuildSampleApp
POST api/Content/GetContentList

LicenseManager

APIDescription
POST api/LicenseManager/GetManualActivationLink
POST api/LicenseManager/GetInstallationIdString
POST api/LicenseManager/DeleteLicenseKeys
POST api/LicenseManager/InstallLicenseKeys
POST api/LicenseManager/CheckLicenseServiceStatus
POST api/LicenseManager/GetTermsAndConditions
POST api/LicenseManager/GetLicenseServiceUser
POST api/LicenseManager/ActivateYurbiFromFile
POST api/LicenseManager/GetInstallationID
POST api/LicenseManager/RequestTrialLicense
POST api/LicenseManager/RefreshInstalledLicenses
POST api/LicenseManager/GetLicenseProfiles
POST api/LicenseManager/ActivateYurbi

Profile

APIDescription
POST api/Profile/SaveNextGen
POST api/Profile/SaveBasics
POST api/Profile/GetProfile

Embed

APIDescription
POST api/Embed/NewEmbedAction
POST api/Embed/InitializeEmbedAction

DataFile

APIDescription
POST api/DataFile/RemoveDataFile
POST api/DataFile/ProcessUpdateDataFile
POST api/DataFile/ProcessDataFile
POST api/DataFile/ExcelStartProcess
POST api/DataFile/ExcelGetStatus
POST api/DataFile/checkdata?value={value}&datatype={datatype}&failOption={failOption}
POST api/DataFile/ValidateCol
POST api/DataFile/ExcelPreviewData
POST api/DataFile/ProcessAdvExcelDataFile

Library

APIDescription
POST api/Library/DeleteLibraryItems
POST api/Library/MoveLibraryItems
POST api/Library/FavReport
POST api/Library/UnFavReport
POST api/Library/FavDash
POST api/Library/UnFavDash
POST api/Library/NewLibraryFolder
POST api/Library/GetFolderById
POST api/Library/DelFolder
POST api/Library/SaveLibraryFolder
POST api/Library/DelReport
POST api/Library/DelDashboard
POST api/Library/GetAllLibraryTree
POST api/Library/GetListByFolderIDRetrieve a list of all reports and dashboards in the Yurbi library that belongs to the provided Folder ID.
POST api/Library/SearchReports Retrieve a list of all reports and dashboards

Group

APIDescription
POST api/Group/NewSecurityGroup
POST api/Group/GetSecurityGroupById
POST api/Group/GetAllSecurityGroups
POST api/Group/SaveSecurityGroup
POST api/Group/DeleteSecurityGroup

Session

APIDescription
POST api/Session/RefreshSession
POST api/Session/CheckSession
POST api/Session/ResetPassport
POST api/Session/GetModuleProfile

AppShield

APIDescription
POST api/AppShield/NewPolicy Retrieve a blank Yurbi AppShield Policy object.
POST api/AppShield/GetAllAppshieldPolicies
POST api/AppShield/DeletePolicy
POST api/AppShield/GetPolicyById
POST api/AppShield/TogglePolicyState
POST api/AppShield/BuildConstraints
POST api/AppShield/SaveAppShieldPolicy Save or update Yurbi AppShield object
POST api/AppShield/NewConstraint

Values

APIDescription
GET api/Values/Get
GET api/Values/Get/{id}
POST api/Values/Post
PUT api/Values/Put/{id}
DELETE api/Values/Delete/{id}

SMTP

APIDescription
POST api/SMTP/NewSMTP
POST api/SMTP/GetSMTP
POST api/SMTP/SaveSMTP
POST api/SMTP/DeleteSMTP

Was this article helpful?

ValidSession