eQuipAPI

<back to all web services

GetFormWorkflowData

The following routes are available for this service:
All Verbs/GetFormWorkflowData
GetFormWorkflowData Parameters:
NameParameterData TypeRequiredDescription
UserIDquerystringNo
WorkflowIDquerystringNo
AssetIDqueryintNo
CallingAssetIDqueryintNo
CallingWorkflowIDquerystringNo
HoldingTableNamequerystringNo
HoldingTableIDqueryintNo
TransactionTableIDqueryintNo
TransactionIDqueryintNo
IsNewTheamequeryboolNo
WorkflowEditorDataResponse Parameters:
NameParameterData TypeRequiredDescription
AssetIDbodyintNo
TabCollectionbodyList<workflowTab>No
IsOpenAuditbodyboolNo
IsEditablebodyboolNo
IsVisiblebodyboolNo
IsLockedbodyboolNo
isEditInActiveAssetbodyboolNo
MfgbodystringNo
ModelbodystringNo
ReadingRangebodystringNo
workflowTab Parameters:
NameParameterData TypeRequiredDescription
IDbodyintNo
NamebodystringNo
ContentbodystringNo
FieldCollectionbodyList<workflowField>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/GetFormWorkflowData HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	WorkflowID: String,
	AssetID: 0,
	CallingAssetID: 0,
	CallingWorkflowID: String,
	HoldingTableName: String,
	HoldingTableID: 0,
	TransactionTableID: 0,
	TransactionID: 0,
	IsNewTheame: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AssetID: 0,
	TabCollection: 
	[
		{
			ID: 0,
			Name: String,
			Content: String,
			FieldCollection: 
			[
				{
					ID: 0,
					Name: String,
					Display: String,
					Value: {},
					Text: String,
					Type: 0,
					valuelistType: 0,
					FieldDataSource: 
					[
						{
							String: {}
						}
					],
					HolidingFieldName: String,
					HolidingFieldEdit: String,
					FieldValueQuery: String,
					MappingTable: String,
					ReadOnly: String,
					MappingPKField: String,
					MappingTableDisplayReadOnly: False,
					IsEditForm: False,
					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,
					BulkUpdateField: False,
					MaxLength: 0,
					ValueList: False,
					hidden: String,
					RealName: String,
					AssetMappedFDID: 0,
					Disable: String,
					Required: String,
					UseMultiSelect: 0,
					IsMask: False,
					DisplayMask: String,
					MaskStart: 0,
					MaskEnd: 0,
					Format: String
				}
			]
		}
	],
	IsOpenAudit: False,
	IsEditable: False,
	IsVisible: False,
	IsLocked: False,
	isEditInActiveAsset: False,
	Mfg: String,
	Model: String,
	ReadingRange: String
}