eQuipAPI

<back to all web services

GetGridFieldData

The following routes are available for this service:
All Verbs/GetGridFieldData/{UserID}/{AssetID}/{FieldID}
GetGridFieldData Parameters:
NameParameterData TypeRequiredDescription
UserIDpathstringNo
AssetIDpathintNo
FieldIDpathstringNo
GridFieldDataResponse Parameters:
NameParameterData TypeRequiredDescription
FieldCollectionbodyList<Field>No
Field Parameters:
NameParameterData TypeRequiredDescription
IDbodyintNo
NamebodystringNo
DisplaybodystringNo
ValuebodyObjectNo
TextbodystringNo
TypebodyshortNo
XbodyshortNo
YbodyshortNo
WbodyshortNo
HbodyshortNo
LXbodyshortNo
LYbodyshortNo
FieldDataSourcebodyList<Dictionary>No
MappingTablebodystringNo
MappingTableDisplayReadOnlybodyboolNo
IsEditFormbodyboolNo
MappingPKFieldbodystringNo
MappingFieldValidationbodyList<Dictionary>No
MappingFieldbodyList<Column>No
MandatorybodystringNo
ReadOnlybodystringNo
HiddenbodystringNo
MaxLengthbodyintNo
FormatbodystringNo
ValueListbodyboolNo
TabIndexbodyintNo
TableTypebodyint?No
UseMultiSelectbodybyteNo
IsMaskbodyboolNo
DisplayMaskbodystringNo
MaskStartbodyintNo
MaskEndbodyintNo
IsAliasbodyboolNo
ParentFieldDefinitionIDbodyintNo
IsParentAliasFieldbodyboolNo
IsLockedbodyboolNo

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.

POST /jsv/reply/GetGridFieldData HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	AssetID: 0,
	FieldID: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FieldCollection: 
	[
		{
			ID: 0,
			Name: String,
			Display: String,
			Value: {},
			Text: String,
			Type: 0,
			X: 0,
			Y: 0,
			W: 0,
			H: 0,
			LX: 0,
			LY: 0,
			FieldDataSource: 
			[
				{
					String: {}
				}
			],
			MappingTable: String,
			MappingTableDisplayReadOnly: False,
			IsEditForm: False,
			MappingPKField: String,
			MappingFieldValidation: 
			[
				{
					String: {}
				}
			],
			MappingField: 
			[
				{
					field: String,
					command: String,
					selectable: False,
					title: String,
					template: String,
					format: String,
					decimals: 0,
					headerTemplate: String,
					locked: False,
					lockable: False,
					sortable: False,
					IsInlineEditWF: False,
					filterable: False,
					valueList: False,
					UseMultiSelect: False,
					Disable: False,
					Required: False,
					editor: String,
					type: String,
					TableType: String,
					width: 200,
					FieldDataSource: 
					[
						{
							String: {}
						}
					],
					expandable: False,
					FieldId: 0,
					ValueListType: 0,
					IsEditable: False,
					AssetMappedFieldID: 0,
					IsMaxLength: False,
					MaxLengthCount: 0,
					TextLength: 0
				}
			],
			Mandatory: String,
			ReadOnly: String,
			Hidden: String,
			MaxLength: 0,
			Format: String,
			ValueList: False,
			TabIndex: 0,
			TableType: 0,
			UseMultiSelect: 0,
			IsMask: False,
			DisplayMask: String,
			MaskStart: 0,
			MaskEnd: 0,
			IsAlias: False,
			ParentFieldDefinitionID: 0,
			IsParentAliasField: False,
			IsLocked: False
		}
	]
}