ApexERPHost

<back to all web services

SaveDynamicForm

Requires Authentication
The following routes are available for this service:
PUT/Core/Dynamic/Forms
SaveDynamicForm Parameters:
NameParameterData TypeRequiredDescription
FormbodyDynamicFormNo
NamesOnlybodybool?No
DynamicForm Parameters:
NameParameterData TypeRequiredDescription
UnIdformGuidNo
NameformstringNo
DescriptionformstringNo
TypeformintNo
DataSourceIdformGuid?No
DataSourceformDynamicDataSourceNo
CategoryIdformGuid?No
ScriptformstringNo
DynamicPopupsformList<DynamicPopup>No
HCodeformstringNo
Visibilityformbool?No
ParamsformFormObjParamsNo
CopyCountformint?No
DynamicDataSource Parameters:
NameParameterData TypeRequiredDescription
DsIdformGuidNo
NameformstringNo
DescriptionformstringNo
QueryformstringNo
HasDatesformboolNo
CategoryIdformGuidNo
ParamsformList<DynamicDataSourceParam>No
HccrtformstringNo
Usedformbool?No
HasParamsformbool?No
HCodeformstringNo
DynamicDataSourceParam Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
DataSourceIdformGuidNo
DbTypeformstringNo
SizeformintNo
QueryIdformGuid?No
FormatformstringNo
IsNullableformboolNo
OrderIndexformintNo
DynamicPopup Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DataformDynamicPopupDataNo
DynamicPopupData Parameters:
NameParameterData TypeRequiredDescription
FormUnIdformGuidNo
FormLayoutIdformint?No
PriorityformintNo
HideFormParamsformboolNo
ParamsMapformDictionary<string, string>No
ShowAsDialogformbool?No
FormObjParams Parameters:
NameParameterData TypeRequiredDescription
ShowInMenuformbool?No
ImageformstringNo
LargeImageformstringNo
OrderIndexformint?No
ParentFormTypeformstringNo
SaveDynamicFormResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

PUT /Core/Dynamic/Forms HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Form: 
	{
		UnId: 00000000000000000000000000000000,
		Name: String,
		Description: String,
		Type: 0,
		DataSourceId: 00000000000000000000000000000000,
		DataSource: 
		{
			DsId: 00000000000000000000000000000000,
			Name: String,
			Description: String,
			Query: String,
			HasDates: False,
			CategoryId: 00000000000000000000000000000000,
			Params: 
			[
				{
					Id: 00000000000000000000000000000000,
					Name: String,
					Description: String,
					DataSourceId: 00000000000000000000000000000000,
					DbType: String,
					Size: 0,
					QueryId: 00000000000000000000000000000000,
					Format: String,
					IsNullable: False,
					OrderIndex: 0
				}
			],
			Hccrt: String,
			Used: False,
			HasParams: False,
			HCode: String
		},
		CategoryId: 00000000000000000000000000000000,
		Script: String,
		DynamicPopups: 
		[
			{
				Id: 0,
				Name: String,
				Data: 
				{
					FormUnId: 00000000000000000000000000000000,
					FormLayoutId: 0,
					Priority: 0,
					HideFormParams: False,
					ParamsMap: 
					{
						String: String
					},
					ShowAsDialog: False
				}
			}
		],
		HCode: String,
		Visibility: False,
		Params: 
		{
			ShowInMenu: False,
			Image: String,
			LargeImage: String,
			OrderIndex: 0,
			ParentFormType: String
		},
		CopyCount: 0
	},
	NamesOnly: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}