BazeField Services

<back to all web services

ObjectInsertRequest

Core API
Requires Authentication
The following routes are available for this service:
POST/api/objects/insertCreates a new objectPost enforced by GET request becomming too long, so implemented as POST as well
ObjectInsertRequest Parameters:
NameParameterData TypeRequiredDescription
ParentIdquerystringYesId of parent under which the new object will be inserted.
CategoryqueryintYescategory as in wind being 21, solar being 22, etc.
TypequeryintYesType as in wind turbine being 200, turbine string being 243, etc.
DomainModelquerystringNoThe name or id the domain model for this object
AttributesbodyDictionary<string, string>No
ClientRequestHandlequerystringNo
ObjectInsertResponse Parameters:
NameParameterData TypeRequiredDescription
dataformDomainObjectNo
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 .xml suffix or ?format=xml

HTTP + XML

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

<ObjectInsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Request">
  <Attributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Attributes>
  <Category>0</Category>
  <ClientRequestHandle>String</ClientRequestHandle>
  <DomainModel>String</DomainModel>
  <ParentId>String</ParentId>
  <Type>0</Type>
</ObjectInsertRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ObjectInsertResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Response">
  <ReplyInfo xmlns="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <ClientRequestHandle>String</ClientRequestHandle>
    <Error>String</Error>
    <RcvTime>0</RcvTime>
    <ReplyTime>0</ReplyTime>
  </ReplyInfo>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Entity">
    <d2p1:Attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Attributes>
    <d2p1:ObjectId>String</d2p1:ObjectId>
  </data>
</ObjectInsertResponse>