BazeField Services

ObjectDomainSchemasGetRequest

Core API

The following routes are available for this service:
GET, POST	/api/objects/getschemas	Get domain points (data point definitions) for objects
GET, POST	/api/objects/{ObjectIds}/schemas	Obsolete

**ObjectDomainSchemasGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectIds	path	List<string>	Yes	List of object ids
Fields	body	List<string>	No	Specify attributes to be included in the response
ClientRequestHandle	body	string	No
mdmids	body	List<string>	No

**ObjectDomainSchemasGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
data	form	Dictionary<string, int>	No
domaininfo	form	Dictionary<int, DomainSchemaList>	No

**BazefieldResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ReplyInfo	form	ReplyInfo	No

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	No

**DomainSchemaList** Parameters:
Name	Parameter	Data Type	Required
schemas	form	List<DomainSchema>	No
domainID	form	int	No
domainName	form	string	No

**DomainSchema** Parameters:
Name	Parameter	Data Type	Required
SchemaId	form	int?	No
SchemaTemplateId	form	int?	No
SchemaTemplate	form	string	No
DomainId	form	int?	No
Schema	form	string	No
Desc	form	string	No
ParentId	form	int?	No
ParentSchema	form	string	No
ValueType	form	string	No
Multiple	form	int?	No
PointType	form	string	No
Unit	form	string	No
EuHigh	form	double?	No
EuLow	form	double?	No
Coerce	form	string	No
Deadband	form	double?	No
DeadbandType	form	int?	No
UpdateRate	form	int?	No
Required	form	bool?	No
AccessType	form	int?	No
Disabled	form	int?	No
Metadata	form	string	No
DataTemplateType	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/objects/getschemas HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ObjectDomainSchemasGetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Request">
  <ClientRequestHandle>String</ClientRequestHandle>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Fields>
  <ObjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ObjectIds>
  <mdmids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </mdmids>
</ObjectDomainSchemasGetRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ObjectDomainSchemasGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Response">
  <ReplyInfo xmlns="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <ClientRequestHandle>String</ClientRequestHandle>
    <Error>String</Error>
    <RcvTime>0</RcvTime>
    <ReplyTime>0</ReplyTime>
  </ReplyInfo>
  <data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </data>
  <domaininfo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintDomainSchemaListNdC1DOA9>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Entity">
        <d4p1:domainID>0</d4p1:domainID>
        <d4p1:domainName>String</d4p1:domainName>
        <d4p1:schemas>
          <d4p1:DomainSchema>
            <d4p1:AccessType>0</d4p1:AccessType>
            <d4p1:Coerce>String</d4p1:Coerce>
            <d4p1:DataTemplateType>String</d4p1:DataTemplateType>
            <d4p1:Deadband>0</d4p1:Deadband>
            <d4p1:DeadbandType>0</d4p1:DeadbandType>
            <d4p1:Desc>String</d4p1:Desc>
            <d4p1:Disabled>0</d4p1:Disabled>
            <d4p1:DomainId>0</d4p1:DomainId>
            <d4p1:EuHigh>0</d4p1:EuHigh>
            <d4p1:EuLow>0</d4p1:EuLow>
            <d4p1:Metadata>String</d4p1:Metadata>
            <d4p1:Multiple>0</d4p1:Multiple>
            <d4p1:ParentId>0</d4p1:ParentId>
            <d4p1:ParentSchema>String</d4p1:ParentSchema>
            <d4p1:PointType>String</d4p1:PointType>
            <d4p1:Required>false</d4p1:Required>
            <d4p1:Schema>String</d4p1:Schema>
            <d4p1:SchemaId>0</d4p1:SchemaId>
            <d4p1:SchemaTemplate>String</d4p1:SchemaTemplate>
            <d4p1:SchemaTemplateId>0</d4p1:SchemaTemplateId>
            <d4p1:Unit>String</d4p1:Unit>
            <d4p1:UpdateRate>0</d4p1:UpdateRate>
            <d4p1:ValueType>String</d4p1:ValueType>
          </d4p1:DomainSchema>
        </d4p1:schemas>
      </d2p1:Value>
    </d2p1:KeyValueOfintDomainSchemaListNdC1DOA9>
  </domaininfo>
</ObjectDomainSchemasGetResponse>