eQuipAPI

<back to all web services

GetFormDesignerData

The following routes are available for this service:
All Verbs/GetFormDesignerData/{UserID}/{CategoryID}/{FormName}/{ObjectID}/{Mode}/{ForSaveEditor}
GetFormDesignerData Parameters:
NameParameterData TypeRequiredDescription
UserIDpathstringNo
CategoryIDpathintNo
FormNamepathstringNo
ObjectIDpathintNo
ModepathstringNo
ForSaveEditorpathstringNo
FormDesignerDataResponse Parameters:
NameParameterData TypeRequiredDescription
TabCollectionbodyList<Tab>No
IsLockedbodyboolNo
isEditInActiveAssetbodyboolNo
Tab Parameters:
NameParameterData TypeRequiredDescription
IDbodyintNo
NamebodystringNo
ContentbodystringNo
FieldCollectionbodyList<Field>No

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

HTTP + CSV

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

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

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

HTTP/1.1 200 OK
Content-Type: text/csv
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}