GET, POST | /api/objects/structure | Get objects filtered by type |
---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
data | form | List<DomainObject> | 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 |
---|---|---|---|---|
ObjectId | form | string | No | |
mdmid | form | string | 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/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"}}