POST | /api/objects/insert | Creates a new object | Post enforced by GET request becomming too long, so implemented as POST as well |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ParentId | query | string | Yes | Id of parent under which the new object will be inserted. |
Category | query | int | Yes | category as in wind being 21, solar being 22, etc. |
Type | query | int | Yes | Type as in wind turbine being 200, turbine string being 243, etc. |
DomainModel | query | string | No | The name or id the domain model for this object |
Attributes | body | Dictionary<string, string> | No | |
ClientRequestHandle | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
data | form | 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objects/insert HTTP/1.1
Host: mdn.bazefield.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
parentId: String,
category: 0,
type: 0,
domainModel: String,
attributes:
{
String: String
},
clientRequestHandle: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { data: { objectId: String, mdmid: String, attributes: { String: String } }, replyInfo: { rcvTime: 0, replyTime: 0, clientRequestHandle: String, error: String } }