ImesI

<back to all web services

MetadataRequest

The following routes are available for this service:
GET/mdactions/{ObjType}
MetadataRequest Parameters:
NameParameterData TypeRequiredDescription
ObjTypepathstringNo
MetadataResponse Parameters:
NameParameterData TypeRequiredDescription
activeformboolNo
keyTypeformstringNo
titleformstringNo
nameformstringNo
qinfoformstringNo
orderByformstringNo
columnsformList<MetadataColumn>No
statesformDictionary<string, MetadataState>No
actionsformDictionary<string, MetadataAction>No
querysformDictionary<string, string>No
MetadataColumn Parameters:
NameParameterData TypeRequiredDescription
orderformintNo
activeformboolNo
extformboolNo
nameformstringNo
titleformstringNo
actionformstringNo
isnumformboolNo
orderByformstringNo
filterformstringNo
htmlformstringNo
classformstringNo
MetadataState Parameters:
NameParameterData TypeRequiredDescription
routeformstringNo
titleformstringNo
getformstringNo
exportformstringNo
getelemformstringNo
extrainfoformstringNo
columnsformList<string>No
querysformList<string>No
elemsformList<ElemToLoad>No
getparamsformstringNo
templateformstringNo
filterformstringNo
controllerformstringNo
consumerformstringNo
stateformStateNo
elemActionsformList<string>No
multiElemActionsformList<string>No
actionsformList<string>No
numactformintNo
ElemToLoad Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
urlformstringNo
State Parameters:
NameParameterData TypeRequiredDescription
viewingformboolNo
editingformboolNo
columnsToRemoveformList<string>No
MetadataAction Parameters:
NameParameterData TypeRequiredDescription
hotkeyformstringNo
hotkeyTitleformstringNo
classNameformstringNo
parentformstringNo
rolesformList<string>No
enablePolicyformEnablePolicyNo
nameformstringNo
iconformstringNo
routeformstringNo
internalActionformstringNo
confirmMessageformstringNo
actionformList<Dictionary<String,String>>No
actionsformList<ActionInfo>No
EnablePolicy Enum:
never
allways
perItem
ActionInfo Parameters:
NameParameterData TypeRequiredDescription
nameformActionNameNo
urlformstringNo
ActionName Enum:
get
put
post
postUpload
postNoData
delete
back
refresh
route
open_url
message
HTMLmessage
prompt

To override the Content-type in your clients, use the 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.

GET /mdactions/{ObjType} HTTP/1.1 
Host: gpv.ocellot.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	active: False,
	keyType: String,
	title: String,
	name: String,
	qinfo: String,
	orderBy: String,
	columns: 
	[
		{
			order: 0,
			active: False,
			ext: False,
			name: String,
			title: String,
			action: String,
			isnum: False,
			orderBy: String,
			filter: String,
			html: String,
			class: String
		}
	],
	states: 
	{
		String: 
		{
			route: String,
			title: String,
			get: String,
			export: String,
			getelem: String,
			extrainfo: String,
			columns: 
			[
				String
			],
			querys: 
			[
				String
			],
			elems: 
			[
				{
					name: String,
					url: String
				}
			],
			getparams: String,
			template: String,
			filter: String,
			controller: String,
			consumer: String,
			state: 
			{
				viewing: False,
				editing: False,
				columnsToRemove: 
				[
					String
				]
			},
			elemActions: 
			[
				String
			],
			multiElemActions: 
			[
				String
			],
			actions: 
			[
				String
			],
			numact: 0
		}
	},
	actions: 
	{
		String: 
		{
			hotkey: String,
			hotkeyTitle: String,
			className: String,
			parent: String,
			roles: 
			[
				String
			],
			enablePolicy: never,
			name: String,
			icon: String,
			route: String,
			internalAction: String,
			confirmMessage: String,
			action: 
			[
				{
					String: String
				}
			],
			actions: 
			[
				{
					name: get,
					url: String
				}
			]
		}
	},
	querys: 
	{
		String: String
	}
}