Show contents 

Web Service > Web Service Operations > Working with Development Environment > GetWebForm

GetWebForm

Syntax

GetWebFormResult GetWebForm(WebFormId tWebForm)

Parameters

tWebForm. Opened web form instance moniker.

Description

The GetWebForm operation gets metadata of the web form opened for execution.

Comments

To execute the operation, in the tWebForm field specify moniker of opened web form instance. The moniker can be obtained on executing the OpenWebForm operation.

The operation results in the obtained web form metadata.

Example

Below is the example of getting metadata of the web form opened for execution. The request contains moniker of opened web form. The response contains the obtained metadata.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetWebForm xmlns="http://www.fsight.ru/PP.SOM.Som">
<tWebForm xmlns="">
  <id>OLFDALNNBBFEGOAEGJFAPCEOMHPCOHIEIKADOOOFNHINOGAL!M!S!WFJAKDIPNNBBFEGOAEECJOCKDBJGKKGPMEOLCGMNKPBOEAOHAA</id>
  </tWebForm>
  </GetWebForm>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetWebFormResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<meta xmlns="">
  <items />
  <content>{"items":[{"id":"form","type":"form","props":{"text":"Input","name":"OBJ402445WebForm","modal":true,"color":{"a":255,"r":255,"g":255,"b":255},"size":{"width":234,"height":222},"coordinate":{"left":0,"top":0}},"events":{}},{"type":"label","id":"label_kLkZu0pLy__TOeiJvnl5K","props":{"text":"Initial value:","name":"Label1","alignment":"left","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":12,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{},"coordinate":{"top":15,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"input","id":"input_jLL25aWLkWL3opLvqNRJQ","props":{"text":"","name":"Input1","placeholder":"Enter value","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":14,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{"width":200,"height":32},"coordinate":{"top":35,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"label","id":"label_XngwyZ3Xgzod7NqgQXQtd","props":{"text":"End value:","name":"Label2","alignment":"left","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":12,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{},"coordinate":{"top":75,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"input","id":"input_VGaJ7DAC5T51_ggvP_bul","props":{"text":"","name":"Input2","placeholder":"Enter value","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":14,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{"width":200,"height":32},"coordinate":{"top":95,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"button","id":"button_INWdSqIoQSDkwA1rq554B","props":{"text":"Save","name":"Button1","color":{"a":255,"r":70,"g":142,"b":240},"font":{"name":"Roboto","color":{"a":255,"r":255,"g":255,"b":255},"size":16,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{"width":110,"height":32},"coordinate":{"top":171,"left":107},"variant":"primary","position":"absolute"},"parent":"form","events":{"onClick":""}}]}</content>
  </meta>
  </GetWebFormResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetWebForm" :
{
"tWebForm" :
{
"id" : "OLFDALNNBBFEGOAEGJFAPCEOMHPCOHIEIKADOOOFNHINOGAL!M!S!WFJAKDIPNNBBFEGOAEECJOCKDBJGKKGPMEOLCGMNKPBOEAOHAA"
}
}
}

JSON response:

{
"GetWebFormResult" :
{
"meta" :
{
"items" : "",
"content" : "{"items":[{"id":"form","type":"form","props":{"text":"Input","name":"OBJ402445WebForm","modal":true,"color":{"a":255,"r":255,"g":255,"b":255},"size":{"width":234,"height":222},"coordinate":{"left":0,"top":0}},"events":{}},{"type":"label","id":"label_kLkZu0pLy__TOeiJvnl5K","props":{"text":"Initial value:","name":"Label1","alignment":"left","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":12,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{},"coordinate":{"top":15,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"input","id":"input_jLL25aWLkWL3opLvqNRJQ","props":{"text":"","name":"Input1","placeholder":"Enter value","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":14,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{"width":200,"height":32},"coordinate":{"top":35,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"label","id":"label_XngwyZ3Xgzod7NqgQXQtd","props":{"text":"End value:","name":"Label2","alignment":"left","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":12,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{},"coordinate":{"top":75,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"input","id":"input_VGaJ7DAC5T51_ggvP_bul","props":{"text":"","name":"Input2","placeholder":"Enter value","color":{"a":0,"r":255,"g":255,"b":255},"font":{"name":"Roboto","color":{"a":255,"r":0,"g":0,"b":0},"size":14,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{"width":200,"height":32},"coordinate":{"top":95,"left":17},"position":"absolute"},"parent":"form","events":{}},{"type":"button","id":"button_INWdSqIoQSDkwA1rq554B","props":{"text":"Save","name":"Button1","color":{"a":255,"r":70,"g":142,"b":240},"font":{"name":"Roboto","color":{"a":255,"r":255,"g":255,"b":255},"size":16,"bold":false,"italic":false,"strikeThrough":false,"underline":false},"visible":true,"enabled":true,"hint":"","showHint":true,"size":{"width":110,"height":32},"coordinate":{"top":171,"left":107},"variant":"primary","position":"absolute"},"parent":"form","events":{"onClick":""}}]}"
}
}
}
public static GetWebFormResult GetWebForm(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetWebForm()
{
tWebForm = new WebFormId() { id = moniker }
};
// Get web form metadata
var result = somClient.GetWebForm(tGet);
return result;
}

See also:

Working with Development Environment