SLnet.WebExtApi

<back to all web services

AdvancedCustomViewUserMetadata

Generic API

The following routes are available for this service:
GET/api/{DomainName}/advancedcustomviews/{AcvName}/{TableName}/custom/{Kind}/{CustomViewName}/metadataReturns a description of the specified view

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/AdvancedCustomViewUserMetadata HTTP/1.1 
Host: 5.172.198.40 
Content-Type: text/jsv
Content-Length: length

{
	Kind: String,
	TableName: String,
	CustomViewName: String,
	AcvName: String,
	MasterDetailTree: False,
	DomainName: String
}

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

{
	OutputType: String,
	Relations: 
	[
		{
			Name: String,
			MasterTable: String,
			DetailTable: String,
			RelationFields: 
			[
				{
					MasterField: String,
					DetailField: String
				}
			]
		}
	],
	Tables: 
	[
		{
			Name: String,
			Description: String,
			Fields: 
			[
				{
					UnboundColumnType: String,
					PivotArea: String,
					Summaries: 
					[
						{
							SummaryType: String,
							DisplayFormat: String
						}
					],
					DisplayFormat: 
					{
						FormatString: String,
						FormatType: String
					},
					Name: String,
					DataType: String,
					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
								}
							]
						}
					},
					Description: String,
					Width: 0,
					Editor: String,
					Visible: False
				}
			],
			CurrentView: String,
			CustomViews: 
			[
				{
					kind: String,
					Name: String,
					Uri: String
				}
			]
		}
	],
	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
		}
	],
	Title: String,
	Description: String,
	Name: String,
	Uri: String
}