Reference for https://buildcont.tpcx.com:17143/uiserver0/ui/interactive/v1/window?id={WINDOWID}
Get the structure and data of a Prophet 21 window
Url: https://buildcont.tpcx.com:17143/uiserver0/ui/interactive/v1/window?id={WINDOWID}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<WindowState xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">
<Data>
<DataElement>
<ActiveRow>2147483647</ActiveRow>
<Columns>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
</Columns>
<Data>
<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>String content</string>
<string>String content</string>
</ArrayOfstring>
<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>String content</string>
<string>String content</string>
</ArrayOfstring>
</Data>
<FullName>String content</FullName>
<Name>String content</Name>
<TotalRows>2147483647</TotalRows>
</DataElement>
<DataElement>
<ActiveRow>2147483647</ActiveRow>
<Columns>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
</Columns>
<Data>
<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>String content</string>
<string>String content</string>
</ArrayOfstring>
<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>String content</string>
<string>String content</string>
</ArrayOfstring>
</Data>
<FullName>String content</FullName>
<Name>String content</Name>
<TotalRows>2147483647</TotalRows>
</DataElement>
</Data>
<Definition>
<Datawindows>
<KeyValueOfstringDatawindowDefinitionybhEbKdc xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>
<Fields xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">
<KeyValueOfstringFieldDefinitionybhEbKdc xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>
<DataType xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">Undefined</DataType>
<Enabled xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">true</Enabled>
<Label xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Label>
<Name xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Name>
</Value>
</KeyValueOfstringFieldDefinitionybhEbKdc>
<KeyValueOfstringFieldDefinitionybhEbKdc xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>
<DataType xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">Undefined</DataType>
<Enabled xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">true</Enabled>
<Label xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Label>
<Name xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Name>
</Value>
</KeyValueOfstringFieldDefinitionybhEbKdc>
</Fields>
<Name xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Name>
<ParentPage xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</ParentPage>
<Style xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">Undefined</Style>
</Value>
</KeyValueOfstringDatawindowDefinitionybhEbKdc>
<KeyValueOfstringDatawindowDefinitionybhEbKdc xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>
<Fields xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">
<KeyValueOfstringFieldDefinitionybhEbKdc xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>
<DataType xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">Undefined</DataType>
<Enabled xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">true</Enabled>
<Label xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Label>
<Name xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Name>
</Value>
</KeyValueOfstringFieldDefinitionybhEbKdc>
<KeyValueOfstringFieldDefinitionybhEbKdc xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>
<DataType xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">Undefined</DataType>
<Enabled xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">true</Enabled>
<Label xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Label>
<Name xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Name>
</Value>
</KeyValueOfstringFieldDefinitionybhEbKdc>
</Fields>
<Name xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</Name>
<ParentPage xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">String content</ParentPage>
<Style xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">Undefined</Style>
</Value>
</KeyValueOfstringDatawindowDefinitionybhEbKdc>
</Datawindows>
<Id>1627aea5-8e0a-4371-9022-9b504344e724</Id>
<Name>String content</Name>
<TabPageList>
<TabDefinition>
<Enabled>true</Enabled>
<Name>String content</Name>
<Text>String content</Text>
</TabDefinition>
<TabDefinition>
<Enabled>true</Enabled>
<Name>String content</Name>
<Text>String content</Text>
</TabDefinition>
</TabPageList>
<Title>String content</Title>
</Definition>
</WindowState>
The following is an example response Json body:
{
"Data":[{
"ActiveRow":2147483647,
"Columns":["String content"],
"Data":[["String content"]],
"FullName":"String content",
"Name":"String content",
"TotalRows":2147483647
}],
"Definition":{
"Datawindows":[{
"Key":"String content",
"Value":{
"Fields":[{
"Key":"String content",
"Value":{
"DataType":0,
"Enabled":true,
"Label":"String content",
"Name":"String content"
}
}],
"Name":"String content",
"ParentPage":"String content",
"Style":0
}
}],
"Id":"1627aea5-8e0a-4371-9022-9b504344e724",
"Name":"String content",
"TabPageList":[{
"Enabled":true,
"Name":"String content",
"Text":"String content"
}],
"Title":"String content"
}
}
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="WindowState">
<xs:sequence>
<xs:element minOccurs="0" name="Data" nillable="true" type="tns:WindowData" />
<xs:element minOccurs="0" name="Definition" nillable="true" type="tns:WindowDefinition" />
</xs:sequence>
</xs:complexType>
<xs:element name="WindowState" nillable="true" type="tns:WindowState" />
<xs:complexType name="WindowData">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DataElement" nillable="true" type="tns:DataElement" />
</xs:sequence>
</xs:complexType>
<xs:element name="WindowData" nillable="true" type="tns:WindowData" />
<xs:complexType name="DataElement">
<xs:sequence>
<xs:element minOccurs="0" name="ActiveRow" type="xs:int" />
<xs:element minOccurs="0" name="Columns" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" />
<xs:element minOccurs="0" name="Data" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfArrayOfstring" />
<xs:element minOccurs="0" name="FullName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TotalRows" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="DataElement" nillable="true" type="tns:DataElement" />
<xs:complexType name="WindowDefinition">
<xs:sequence>
<xs:element minOccurs="0" name="Datawindows" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfKeyValueOfstringDatawindowDefinitionybhEbKdc" />
<xs:element minOccurs="0" name="Id" type="ser:guid" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TabPageList" nillable="true" type="tns:ArrayOfTabDefinition" />
<xs:element minOccurs="0" name="Title" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="WindowDefinition" nillable="true" type="tns:WindowDefinition" />
<xs:complexType name="DatawindowDefinition">
<xs:sequence>
<xs:element minOccurs="0" name="Fields" nillable="true" xmlns:q4="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q4:ArrayOfKeyValueOfstringFieldDefinitionybhEbKdc" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ParentPage" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Style" type="tns:DatawindowStyle" />
</xs:sequence>
</xs:complexType>
<xs:element name="DatawindowDefinition" nillable="true" type="tns:DatawindowDefinition" />
<xs:complexType name="FieldDefinition">
<xs:sequence>
<xs:element minOccurs="0" name="DataType" type="tns:FieldDatatype" />
<xs:element minOccurs="0" name="Enabled" type="xs:boolean" />
<xs:element minOccurs="0" name="Label" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="FieldDefinition" nillable="true" type="tns:FieldDefinition" />
<xs:simpleType name="FieldDatatype">
<xs:restriction base="xs:string">
<xs:enumeration value="Undefined" />
<xs:enumeration value="Char" />
<xs:enumeration value="Long" />
<xs:enumeration value="Datetime" />
<xs:enumeration value="Decimal" />
<xs:enumeration value="Number" />
<xs:enumeration value="Time" />
</xs:restriction>
</xs:simpleType>
<xs:element name="FieldDatatype" nillable="true" type="tns:FieldDatatype" />
<xs:simpleType name="DatawindowStyle">
<xs:restriction base="xs:string">
<xs:enumeration value="Undefined" />
<xs:enumeration value="List" />
<xs:enumeration value="Form" />
</xs:restriction>
</xs:simpleType>
<xs:element name="DatawindowStyle" nillable="true" type="tns:DatawindowStyle" />
<xs:complexType name="ArrayOfTabDefinition">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="TabDefinition" nillable="true" type="tns:TabDefinition" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfTabDefinition" nillable="true" type="tns:ArrayOfTabDefinition" />
<xs:complexType name="TabDefinition">
<xs:sequence>
<xs:element minOccurs="0" name="Enabled" type="xs:boolean" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="TabDefinition" nillable="true" type="tns:TabDefinition" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2" />
<xs:complexType name="ArrayOfstring">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
<xs:complexType name="ArrayOfArrayOfstring">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfArrayOfstring" nillable="true" type="tns:ArrayOfArrayOfstring" />
<xs:complexType name="ArrayOfKeyValueOfstringDatawindowDefinitionybhEbKdc">
<xs:annotation>
<xs:appinfo>
<IsDictionary xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</IsDictionary>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="KeyValueOfstringDatawindowDefinitionybhEbKdc">
<xs:complexType>
<xs:sequence>
<xs:element name="Key" nillable="true" type="xs:string" />
<xs:element name="Value" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2" type="q1:DatawindowDefinition" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfKeyValueOfstringDatawindowDefinitionybhEbKdc" nillable="true" type="tns:ArrayOfKeyValueOfstringDatawindowDefinitionybhEbKdc" />
<xs:complexType name="ArrayOfKeyValueOfstringFieldDefinitionybhEbKdc">
<xs:annotation>
<xs:appinfo>
<IsDictionary xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</IsDictionary>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="KeyValueOfstringFieldDefinitionybhEbKdc">
<xs:complexType>
<xs:sequence>
<xs:element name="Key" nillable="true" type="xs:string" />
<xs:element name="Value" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2" type="q2:FieldDefinition" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfKeyValueOfstringFieldDefinitionybhEbKdc" nillable="true" type="tns:ArrayOfKeyValueOfstringFieldDefinitionybhEbKdc" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>