BazeField Services

<back to all web services

ObjectsGetRequest

Core API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/relatedGet child objects of specified type(s) for specified top node(s)
GET, POST/api/objects/{ObjectIds}/relatedObsolete
ObjectsGetRequest Parameters:
NameParameterData TypeRequiredDescription
ObjectIdspathList<string>No
TypesbodyList<int>No
SearchDepthbodyint?No
AttributesbodyList<string>No
SiteIdsbodyList<int>No
TurbineIdsbodyList<int>No
OwnerIdsbodyList<int>No
ClientRequestHandlebodystringNo
mdmidsbodyList<string>No
ObjectsGetResponse Parameters:
NameParameterData TypeRequiredDescription
dataformDictionary<string, ChildObjects>No
BazefieldResponse Parameters:
NameParameterData TypeRequiredDescription
ReplyInfoformReplyInfoNo
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo
ChildObjects Parameters:
NameParameterData TypeRequiredDescription
mdmobjectsformDictionary<int, List<DomainObject>>No
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/related HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"objectIds":["String"],"types":[0],"searchDepth":0,"attributes":["String"],"siteIds":[0],"turbineIds":[0],"ownerIds":[0],"clientRequestHandle":"String","mdmids":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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