BazeField Services

ObjectStructureGetRequest

Core API

The following routes are available for this service:
GET, POST	/api/objects/structure	Get objects filtered by type

**ObjectStructureGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
type	body	int?	No	Object type as in 200 being Wind Turbine, 243 being Turbine String, etc.
attributes	body	List<string>	No	Specify attributes to be included in the response
ClientRequestHandle	body	string	No

**ObjectStructureGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
data	form	List<DomainObject>	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

**DomainObject** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	form	string	No
mdmid	form	string	No

**DomainObjectAttributes** Parameters:
Name	Parameter	Data Type	Required	Description
Attributes	form	Dictionary<string, 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/structure HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<ObjectStructureGetResponse 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.datacontract.org/2004/07/Bazefield.Core.WebService.Entity">
    <d2p1:DomainObject>
      <d2p1:Attributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Attributes>
      <d2p1:ObjectId>String</d2p1:ObjectId>
    </d2p1:DomainObject>
  </data>
</ObjectStructureGetResponse>