eQuipAPI

GetFormDesignerData

The following routes are available for this service:
All Verbs	/GetFormDesignerData/{UserID}/{CategoryID}/{FormName}/{ObjectID}/{Mode}/{ForSaveEditor}

**GetFormDesignerData** Parameters:
Name	Parameter	Data Type	Required
UserID	path	string	No
CategoryID	path	int	No
FormName	path	string	No
ObjectID	path	int	No
Mode	path	string	No
ForSaveEditor	path	string	No

**FormDesignerDataResponse** Parameters:
Name	Parameter	Data Type	Required
TabCollection	body	List<Tab>	No
IsLocked	body	bool	No
isEditInActiveAsset	body	bool	No

**Tab** Parameters:
Name	Parameter	Data Type	Required
ID	body	int	No
Name	body	string	No
Content	body	string	No
FieldCollection	body	List<Field>	No

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/GetFormDesignerData HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	CategoryID: 0,
	FormName: String,
	ObjectID: 0,
	Mode: String,
	ForSaveEditor: String
}

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

{
	TabCollection: 
	[
		{
			ID: 0,
			Name: String,
			Content: String,
			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
				}
			]
		}
	],
	IsLocked: False,
	isEditInActiveAsset: False
}