BazeField Services

<back to all web services

ObjectStructureGetRequest

Core API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/structureGet objects filtered by type
ObjectStructureGetRequest Parameters:
NameParameterData TypeRequiredDescription
typebodyint?NoObject type as in 200 being Wind Turbine, 243 being Turbine String, etc.
attributesbodyList<string>NoSpecify attributes to be included in the response
ClientRequestHandlebodystringNo
ObjectStructureGetResponse Parameters:
NameParameterData TypeRequiredDescription
dataformList<DomainObject>No
BazefieldResponse Parameters:
NameParameterData TypeRequiredDescription
ReplyInfoformReplyInfoNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo
DomainObject Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
mdmidformstringNo
DomainObjectAttributes Parameters:
NameParameterData TypeRequiredDescription
AttributesformDictionary<string, string>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"type":0,"attributes":["String"],"clientRequestHandle":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":[{"objectId":"String","mdmid":"String","attributes":{"String":"String"}}],"replyInfo":{"rcvTime":0,"replyTime":0,"clientRequestHandle":"String","error":"String"}}