Reference for https://buildcont.tpcx.com:17143/uiserver0/ui/interactive/v1/change
Send multiple change requests to a Prophet 21 window, return the new state of the data
Url: https://buildcont.tpcx.com:17143/uiserver0/ui/interactive/v1/change
HTTP Method: PUT
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<ChangeRequests xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">
<List>
<ChangeRequest>
<DatawindowName>String content</DatawindowName>
<FieldName>String content</FieldName>
<TabName>String content</TabName>
<Value>String content</Value>
<ValueType>Display</ValueType>
</ChangeRequest>
<ChangeRequest>
<DatawindowName>String content</DatawindowName>
<FieldName>String content</FieldName>
<TabName>String content</TabName>
<Value>String content</Value>
<ValueType>Display</ValueType>
</ChangeRequest>
</List>
<WindowId>1627aea5-8e0a-4371-9022-9b504344e724</WindowId>
</ChangeRequests>
The following is an example request Json body:
{
"List":[{
"DatawindowName":"String content",
"FieldName":"String content",
"TabName":"String content",
"Value":"String content",
"ValueType":0
}],
"WindowId":"1627aea5-8e0a-4371-9022-9b504344e724"
}
The following is an example response Xml body:
<Result xmlns="http://schemas.datacontract.org/2004/07/P21.UI.Service.Model.Interactive.V2">
<Events>
<Event>
<Data>
<EventDataItem>
<Key>String content</Key>
<Value>String content</Value>
</EventDataItem>
<EventDataItem>
<Key>String content</Key>
<Value>String content</Value>
</EventDataItem>
</Data>
<Name>String content</Name>
</Event>
<Event>
<Data>
<EventDataItem>
<Key>String content</Key>
<Value>String content</Value>
</EventDataItem>
<EventDataItem>
<Key>String content</Key>
<Value>String content</Value>
</EventDataItem>
</Data>
<Name>String content</Name>
</Event>
</Events>
<Messages>
<Message>
<Text>String content</Text>
<Type>Undefined</Type>
</Message>
<Message>
<Text>String content</Text>
<Type>Undefined</Type>
</Message>
</Messages>
<Status>None</Status>
</Result>
The following is an example response Json body:
{
"Events":[{
"Data":[{
"Key":"String content",
"Value":"String content"
}],
"Name":"String content"
}],
"Messages":[{
"Text":"String content",
"Type":0
}],
"Status":0
}
The following is the request 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/" />
<xs:complexType name="ChangeRequests">
<xs:sequence>
<xs:element minOccurs="0" name="List" nillable="true" type="tns:ArrayOfChangeRequest" />
<xs:element minOccurs="0" name="WindowId" type="ser:guid" />
</xs:sequence>
</xs:complexType>
<xs:element name="ChangeRequests" nillable="true" type="tns:ChangeRequests" />
<xs:complexType name="ArrayOfChangeRequest">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ChangeRequest" nillable="true" type="tns:ChangeRequest" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfChangeRequest" nillable="true" type="tns:ArrayOfChangeRequest" />
<xs:complexType name="ChangeRequest">
<xs:sequence>
<xs:element minOccurs="0" name="DatawindowName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FieldName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TabName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ValueType" type="tns:ChangeRequestValueType" />
</xs:sequence>
</xs:complexType>
<xs:element name="ChangeRequest" nillable="true" type="tns:ChangeRequest" />
<xs:simpleType name="ChangeRequestValueType">
<xs:restriction base="xs:string">
<xs:enumeration value="Display" />
<xs:enumeration value="Data" />
</xs:restriction>
</xs:simpleType>
<xs:element name="ChangeRequestValueType" nillable="true" type="tns:ChangeRequestValueType" />
</xs:schema>
Additional request 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>
<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>
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:complexType name="Result">
<xs:sequence>
<xs:element minOccurs="0" name="Events" nillable="true" type="tns:EventList" />
<xs:element minOccurs="0" name="Messages" nillable="true" type="tns:MessageList" />
<xs:element minOccurs="0" name="Status" type="tns:ResultStatus" />
</xs:sequence>
</xs:complexType>
<xs:element name="Result" nillable="true" type="tns:Result" />
<xs:complexType name="EventList">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Event" nillable="true" type="tns:Event" />
</xs:sequence>
</xs:complexType>
<xs:element name="EventList" nillable="true" type="tns:EventList" />
<xs:complexType name="Event">
<xs:sequence>
<xs:element minOccurs="0" name="Data" nillable="true" type="tns:EventData" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Event" nillable="true" type="tns:Event" />
<xs:complexType name="EventData">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="EventDataItem" nillable="true" type="tns:EventDataItem" />
</xs:sequence>
</xs:complexType>
<xs:element name="EventData" nillable="true" type="tns:EventData" />
<xs:complexType name="EventDataItem">
<xs:sequence>
<xs:element minOccurs="0" name="Key" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="EventDataItem" nillable="true" type="tns:EventDataItem" />
<xs:complexType name="MessageList">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Message" nillable="true" type="tns:Message" />
</xs:sequence>
</xs:complexType>
<xs:element name="MessageList" nillable="true" type="tns:MessageList" />
<xs:complexType name="Message">
<xs:sequence>
<xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Type" type="tns:MessageType" />
</xs:sequence>
</xs:complexType>
<xs:element name="Message" nillable="true" type="tns:Message" />
<xs:simpleType name="MessageType">
<xs:restriction base="xs:string">
<xs:enumeration value="Undefined" />
<xs:enumeration value="Information" />
<xs:enumeration value="Warning" />
<xs:enumeration value="Error" />
</xs:restriction>
</xs:simpleType>
<xs:element name="MessageType" nillable="true" type="tns:MessageType" />
<xs:simpleType name="ResultStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Success" />
<xs:enumeration value="Failure" />
<xs:enumeration value="Blocked" />
</xs:restriction>
</xs:simpleType>
<xs:element name="ResultStatus" nillable="true" type="tns:ResultStatus" />
</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>
<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>