SLnet.WebExtApi

<back to all web services

DashboardMetadata

Generic API

The following routes are available for this service:
GET/api/{DomainName}/dashboards/{DashboardName}/metadataReturns metadata of the specified dashboard

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/DashboardMetadata HTTP/1.1 
Host: 5.172.198.40 
Content-Type: text/jsv
Content-Length: length

{
	IncludeDesign: False,
	DashboardName: String,
	DomainName: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Filters: 
	[
		{
			Name: String,
			Description: String,
			FieldName: String,
			LinkName: String,
			Kind: String,
			DisplayAs: String,
			Behaviour: String,
			Operators: 
			{
				From: String,
				To: String,
				Value: String
			},
			Required: False,
			Visible: False,
			Enable: False,
			Hidden: False,
			DataType: String,
			PredefinedValues: 
			{
				From: {},
				To: {},
				Value: {}
			},
			AcceptedValues: 
			{
				AcceptedValuesList: String,
				DisplayField1: String,
				DisplayField2: String,
				KeyField: String,
				IndexField: String,
				ParentField: String,
				SortFields: 
				[
					{
						Name: String,
						Direction: String
					}
				],
				LookupData: 
				[
					{
						String: {}
					}
				],
				DisplayInfo: 
				{
					AutoSizeColumns: False,
					Columns: 
					[
						{
							Name: String,
							Description: String,
							Width: 0
						}
					]
				}
			},
			AllowedOperators: 
			[
				String
			],
			UseRange: False,
			AllowNullState: False
		}
	],
	Views: 
	[
		{
			DashboardDesign: String,
			Title: String,
			Description: String,
			Name: String,
			Uri: String
		}
	],
	DashboardDesign: String,
	DataSourceName: String,
	DataSourceType: 0,
	GroupName: String,
	Category: String,
	Title: String,
	Description: String,
	Name: String,
	Uri: String
}