Charts

Chart Definition

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

MainTitle is an nvarchar field within the Chart table with a maximum length of 128 characters. The MainTitle field contains the name of the Chart as used in a variety of applications. It is used as the primary identifier for a Chart when retrieved from the database.

string | null

The SecondaryTitle field in the Chart table stores a supplemental title of a chart or graph, if applicable. It is of data type nvarchar and can hold up to 128 characters.

string
required
length between 1 and 450

The ChartTypeId field in the Chart table is an nvarchar field that stores a unique-identifying string of alphabetical characters, numbers, and possibly special characters of up to 450 characters in length. It is used to store the chart type for each chart in the system.

string | null

XLabel is an nvarchar data type field in the Chart table which is used to store the labels for the x-axis of the chart. These labels will be used to identify the x-axis values when a chart is generated. The length of XLabel should be long enough to support the name of the x-axis data points.

string | null

YLabel is a nvarchar field in the Chart table that stores text labels for the Y-Axis of a chart. This field will appear as the subtitle on the Y-Axis of a chart when it is displayed.

string | null

The field XUnitId is an nvarchar data type in the Chart table designed to store up to 450 characters that uniquely identify each data point within the Chart.

string | null

The YUnitId field in the Chart table contains the unique identifier (nvarchar data type with a maximum length of 450 characters) of the chart item. This field is used to help locate, identify, and manage chart items.

int32

RefreshFrequency is an integer data type within the Chart table that stores the frequency of refreshing a chart. The frequency is expressed in hours. For example, setting RefreshFrequency to 24 will cause the chart to be refreshed every 24 hours.

boolean

The Legend field in the Chart table is a bit data type, which is used to indicate whether a row is considered a legend item — setting it to TRUE meaning that the row is a legend tag, and FALSE indicating it is not.

string | null

The Tooltip string field is part of the Chart table and is used to store a brief message associated with a chart item, allowing user to view additional information about the item when they hover the mouse over it. This field has a maximum length of 512 nvarchar characters.

boolean

The Cumulative field in the Chart table is a bit data type that indicates whether a chart value is cumulative or not. When Cumulative is set to true, the value represented by the chart is a cumulative total; when Cumulative is set to false, the value represented by the chart is a non-cumulative total.

boolean

The Chart table contains a field called ShowChartTotal, which is a bit dataype and is used to indicate whether the total for a chart should be displayed or not. This field is featured in the Chart table to help conditionally display the total for charts as needed.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!