GET, POST | /api/objects/related | Get child objects of specified type(s) for specified top node(s) | |
---|---|---|---|
GET, POST | /api/objects/{ObjectIds}/related | Obsolete |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ObjectIds | path | List<string> | No | |
Types | body | List<int> | No | |
SearchDepth | body | int? | No | |
Attributes | body | List<string> | No | |
SiteIds | body | List<int> | No | |
TurbineIds | body | List<int> | No | |
OwnerIds | body | List<int> | No | |
ClientRequestHandle | body | string | No | |
mdmids | body | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
data | form | Dictionary<string, ChildObjects> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReplyInfo | form | ReplyInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RcvTime | form | double | No | |
ReplyTime | form | double | No | |
ClientRequestHandle | form | string | No | |
Error | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
mdmobjects | form | Dictionary<int, List<DomainObject>> | No |
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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"}}