Reference for https://buildcont.tpcx.com:17143/uiserver0/ui/interactive/v1/data?id={WINDOWID}
Get all data on the active surface of a Prophet 21 window
Url: https://buildcont.tpcx.com:17143/uiserver0/ui/interactive/v1/data?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:
<WindowData xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2"> <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> </WindowData>
The following is an example response Json body:
[{ "ActiveRow":2147483647, "Columns":["String content"], "Data":[["String content"]], "FullName":"String content", "Name":"String content", "TotalRows":2147483647 }]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2" 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: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: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: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: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>