Reference for https://buildcont.tpcx.com:17143/uiserver0/extensibility/dynachange/externalobject
Add a external object
Url: https://buildcont.tpcx.com:17143/uiserver0/extensibility/dynachange/externalobject
HTTP Method: POST
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:
<ArrayOfExternalObjectModel xmlns="http://schemas.datacontract.org/2004/07/P21.Extensibility.Service.Model"> <ExternalObjectModel> <DesignUid>2147483647</DesignUid> <ExternalObjectUid>2147483647</ExternalObjectUid> <IsNew>true</IsNew> <Location>String content</Location> <Metadata>String content</Metadata> <Name>String content</Name> <Type>String content</Type> </ExternalObjectModel> <ExternalObjectModel> <DesignUid>2147483647</DesignUid> <ExternalObjectUid>2147483647</ExternalObjectUid> <IsNew>true</IsNew> <Location>String content</Location> <Metadata>String content</Metadata> <Name>String content</Name> <Type>String content</Type> </ExternalObjectModel> </ArrayOfExternalObjectModel>
The following is an example request Json body:
[{ "DesignUid":2147483647, "ExternalObjectUid":2147483647, "IsNew":true, "Location":"String content", "Metadata":"String content", "Name":"String content", "Type":"String content" }]
The following is an example response Xml body:
<ExternalObjectResponse xmlns="http://schemas.datacontract.org/2004/07/P21.Extensibility.Service.Model"> <Message>String content</Message> <Success>true</Success> <ExternalObjectCollection> <ExternalObjectModel> <DesignUid>2147483647</DesignUid> <ExternalObjectUid>2147483647</ExternalObjectUid> <IsNew>true</IsNew> <Location>String content</Location> <Metadata>String content</Metadata> <Name>String content</Name> <Type>String content</Type> </ExternalObjectModel> <ExternalObjectModel> <DesignUid>2147483647</DesignUid> <ExternalObjectUid>2147483647</ExternalObjectUid> <IsNew>true</IsNew> <Location>String content</Location> <Metadata>String content</Metadata> <Name>String content</Name> <Type>String content</Type> </ExternalObjectModel> </ExternalObjectCollection> </ExternalObjectResponse>
The following is an example response Json body:
{ "Message":"String content", "Success":true, "ExternalObjectCollection":[{ "DesignUid":2147483647, "ExternalObjectUid":2147483647, "IsNew":true, "Location":"String content", "Metadata":"String content", "Name":"String content", "Type":"String content" }] }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/P21.Extensibility.Service.Model" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/P21.Extensibility.Service.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfExternalObjectModel"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ExternalObjectModel" nillable="true" type="tns:ExternalObjectModel" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfExternalObjectModel" nillable="true" type="tns:ArrayOfExternalObjectModel" /> <xs:complexType name="ExternalObjectModel"> <xs:sequence> <xs:element minOccurs="0" name="DesignUid" type="xs:int" /> <xs:element minOccurs="0" name="ExternalObjectUid" type="xs:int" /> <xs:element minOccurs="0" name="IsNew" type="xs:boolean" /> <xs:element minOccurs="0" name="Location" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Metadata" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ExternalObjectModel" nillable="true" type="tns:ExternalObjectModel" /> </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.Extensibility.Service.Model" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/P21.Extensibility.Service.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ExternalObjectResponse"> <xs:complexContent mixed="false"> <xs:extension base="tns:GeneralResponse"> <xs:sequence> <xs:element minOccurs="0" name="ExternalObjectCollection" nillable="true" type="tns:ArrayOfExternalObjectModel" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="ExternalObjectResponse" nillable="true" type="tns:ExternalObjectResponse" /> <xs:complexType name="GeneralResponse"> <xs:sequence> <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Success" type="xs:boolean" /> </xs:sequence> </xs:complexType> <xs:element name="GeneralResponse" nillable="true" type="tns:GeneralResponse" /> <xs:complexType name="ArrayOfExternalObjectModel"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ExternalObjectModel" nillable="true" type="tns:ExternalObjectModel" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfExternalObjectModel" nillable="true" type="tns:ArrayOfExternalObjectModel" /> <xs:complexType name="ExternalObjectModel"> <xs:sequence> <xs:element minOccurs="0" name="DesignUid" type="xs:int" /> <xs:element minOccurs="0" name="ExternalObjectUid" type="xs:int" /> <xs:element minOccurs="0" name="IsNew" type="xs:boolean" /> <xs:element minOccurs="0" name="Location" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Metadata" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ExternalObjectModel" nillable="true" type="tns:ExternalObjectModel" /> </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>