Program guide > Access data with the REST data service > Request protocols for the REST data service

Insert requests with REST data services

An InsertEntity Request can be used to insert a new eXtreme Scale entity instance, potentially with new related entities, into the eXtreme Scale REST data service.

Insert entity request

An InsertEntity Request can be used to insert a new eXtreme Scale entity instance, potentially with new related entities, into the eXtreme Scale REST data service. When inserting an entity, the client may specify if the resource or entity should be automatically linked to other existing entities in the data service.

The client must include the required binding information in the representation of the associated relation in the request payload.

In addition to supporting the insertion of a new EntityType instance (E1), the InsertEntity request also allows inserting new entities related to E1 (described by an entity relation) in a single Request. For example, when inserting a Customer('IBM'), we can insert all the orders with Customer('IBM'). This form of an InsertEntity Request is also known as a deep insert. With a deep insert, the related entities must be represented using the inline representation of the relation associated with E1 that identifies the link to the to-be-inserted related entities.

The properties of the entity to be inserted are specified in the request payload. The properties are parsed by the REST data service and then set to the correspondent property on the entity instance. For the AtomPub format, the property is specified as a <d:PROPERTY_NAME> XML element. For JSON, the property is specified as a property of a JSON object.

If a property is missing in the request payload, then the REST data service sets the entity property value to the java default value. However, the database backend might reject such a default value, for example, if the column is not nullable in the database. Then a 500 response code will be returned to indicate an Internal Server error.

If there are duplicate properties specified in the payload, the last property will be used. All the previous values for the same property name are ignored by the REST data service.

If the payload contains a non-existent property, then the REST data service returns a 400 (Bad Request) response code to indicate the request sent by the client was syntactically incorrect.

If the key properties are missing, then the REST data service returns a response code of 400 (Bad Request) to indicate a missing key property.

If the payload contains a link to a related entity with a non-existent key, then the REST data service returns a 404 (Not Found) response code to indicate the linked entity cannot be found.

If the payload contains a link to a related entity with an incorrect association name, then the REST data service returns a 400 (Bad Request) response code to indicate the link cannot be found.

If the payload contains more than one link to a to-one relation, the last link will be used. All the previous links for the same association are ignored.

For more details on the InsertEntity request, see MSDN Library: InsertEntity Request.

An InsertEntity request inserts a Customer entity with key 'IBM'.

AtomPub

• Method: POST

• Request URI: http://localhost:8080/wxsrestservice/restservice/NorthwindGrid/Customer('IBM')

• Request Header: Accept: application/atom+xml Content-Type: application/atom+xml

• Request Payload:

  <?xml version="1.0" encoding="ISO-8859-1"?>
  <entry xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
   xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
   xmlns="http://www.w3.org/2005/Atom">
  
  <category term="NorthwindGridModel.Customer"
    scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <content type="application/xml">
   
  <m:properties>
    
  <d:customerId>Rational</d:customerId>
    
  <d:city>Rochester</d:city>
    
  <d:companyName>Rational</d:companyName>
    
  <d:contactName>John Doe</d:contactName>
    
  <d:country>USA</d:country>
   
  </m:properties>
  
  </content>
  </entry>
  

• Response Header: Content-Type: application/atom+xml

• Response Payload:

  <?xml version="1.0" encoding="ISO-8859-1"?>
  <entry xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
   xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
   xmlns="http://www.w3.org/2005/Atom">
  
  <category term="NorthwindGridModel.Customer"
    scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <content type="application/xml">
   
  <m:properties>
    
  <d:customerId>Rational</d:customerId>
    
  <d:city>Rochester</d:city>
    
  <d:companyName>Rational</d:companyName>
    
  <d:contactName>John Doe</d:contactName>
    
  <d:country>USA</d:country>
   
  </m:properties>
  
  </content>
  </entry>
  Response Header:                                
  Content-Type: application/atom+xml
  Response Payload:
  <?xml version="1.0" encoding="utf-8"?>
  <entry xml:base = "http://localhost:8080/wxsrestservice/restservice" xmlns:d =
              "http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m =
                      "http://schemas.microsoft.com/
              ado/2007/08/dataservices/metadata" xmlns = "http://www.w3.org/2005/Atom">
     
  <category term = "NorthwindGridModel.Customer" scheme = "http://schemas.
                      microsoft.com/ado/2007/08/dataservices/scheme"/>
     
  <id>http://localhost:8080/wxsrestservice/restservice/NorthwindGrid/
                      Customer('Rational')</id>
     
  <title type = "text"/>
     
  <updated>2009-12-16T23:25:50.875Z</updated>
     
  <author>
         
  <name/>
     
  </author>
     
  <link rel = "edit" title = "Customer" href = "Customer('Rational')"/>
     
  <link rel = "http://schemas.microsoft.com/ado/2007/08/dataservices/related/
                  orders" type = "application/atom+xml;type=feed"
                  title = "orders" href = "Customer('Rational')/orders"/>
     
  <content type = "application/xml">
         
  <m:properties>
             
  <d:customerId>Rational</d:customerId>
             
  <d:city>Rochester</d:city>
             
  <d:companyName>Rational</d:companyName>
             
  <d:contactName>John Doe</d:contactName>
             
  <d:country>USA</d:country>
             
  <d:version m:type = "Edm.Int32">0</d:version>
         
  </m:properties>
     
  </content>
  </entry>
  

• Response Code: 201 Created

JSON

• Method: POST

• Request URI: http://localhost:8080/wxsrestservice/restservice/NorthwindGrid/Customer

• Request Header: Accept: application/json Content-Type: application/json

• Request Payload:

  {"customerId":"Rational",
  "city":null,
  "companyName":"Rational",
  "contactName":"John Doe",
  "country": "USA",}
  

• Response Header: Content-Type: application/json

• Response Payload:

  {"d":{"__metadata":{"uri":"http://localhost:8080/wxsrestservice/restservice/
              NorthwindGrid/Customer('Rational')",
  "type":"NorthwindGridModel.Customer"},
  "customerId":"Rational",
  "city":null,
  "companyName":"Rational",
  "contactName":"John Doe",
  "country":"USA",
  "version":0,
  "orders":{"__deferred":{"uri":"http://localhost:8080/wxsrestservice/restservice/
              NorthwindGrid/Customer('Rational')/orders"}}}}
  

• Response Code: 201 Created

Insert link request

An InsertLink Request can be used to create a new Link between two eXtreme Scale entity instances. The URI of the request must resolve to an eXtreme Scale to-many association. The payload of the request contains a single link which points to the to-many association target entity.

If the URI of the InsertLink request represents a to-one association, the REST data service returns a 400 (Bad request) response.

If the URI of the InsertLink request points to an association which does not exist, the REST data service returns a 404 (Not Found) response to indicate the link cannot be found.

If the payload contains a link with a key which does not exist, the REST data service returns a 404 (Not Found) response to indicate the linked entity cannot be found.

If the payload contains more than one link, the eXtreme Scale Rest Data Service will parse the first link. The remaining links are ignored.

For more details on InsertLink request, refer to: MSDN Library: InsertLink Request.

The following InsertLink request example creates a link from Customer('IBM') to Order(orderId=5000,customer_customerId='IBM').

AtomPub

• Method: POST

• Request URI: http://localhost:8080/wxsrestservice/restservice/NorthwindGrid/Customer('IBM')/$link/orders

• Request Header: Content-Type: application/xml

• Request Payload:

  <?xml version="1.0" encoding="ISO-8859-1"?>
  <uri>http://host:1000/wxsrestservice/restservice/NorthwindGrid/Order(orderId=
              5000,customer_customerId='IBM')</uri>
  

• Response Payload: None

• Response Code: 204 No Content

JSON

• Method: POST

• Request URI: http://localhost:8080/wxsrestservice/restservice/NorthwindGrid/Customer('IBM')/$links/orders

• Request Header: Content-Type: application/json

• Request Payload:

  {"uri": "http://host:1000/wxsrestservice/restservice/NorthwindGrid/Order(orderId
                  =5000,customer_customerId='IBM')"}
  

• Response Payload: None

• Response Code: 204 No Content

Parent topic:

Request protocols for the REST data service

Related reference

Retrieve requests with the REST data service

Retrive non-entities with REST data services

Update requests with REST data services

Delete requests with REST data services

+

Search Tips   |   Advanced Search