Share via

Deleting an Entity Using REST (Ruby)

  • Article

[This document supports a preliminary release of a software product that may be changed substantially prior to final commercial release. This document is provided for informational purposes only.]

As described in Deleting an Entity Using REST, this topic provides a Ruby sample to delete an entity. You will need to update the code and do the following:

  • Provide your own credentials.
  • Provide your existing authority id and container id.
  • Provide entity id to delete.
  • Set proxy information.
require 'base64' 
require 'bigdecimal'
require 'net/https'
require 'openssl'
require 'rexml/document'
require 'uri'

# Provide your own credentials, your existing authority id, container id and Entity id(to delete).
USER_NAME = '<UserName>'
PASSWORD = '<Password>'
AUTHORITY_ID = '<YourExistingAuthorityId>'
CONTAINER_ID = '<YourExistingContainerId>'
ENTITY_ID = '<EntityIdToDelete>'

# provide your proxy information
PROXY_ADDRESS = nil 
PROXY_PORT = nil 
PROXY_USER = nil 
PROXY_PASSWORD = nil 
SVC_ENDPOINT = 'data.database.windows.net'
SVC_VERSION = 'v1'
  

# setup credentials
Credentials = Struct.new("Credentials", :un, :pw)
myCred = Credentials.new(USER_NAME, PASSWORD)

#setup proxy information -- if you don't have to use a proxy you can set everything to nil
Proxy_info = Struct.new("Proxy_info", :addr, :port, :user, :pw)
myProxy = Proxy_info.new(PROXY_ADDRESS, 80, nil, nil)

authorityUri  = AUTHORITY_ID +  '.' + SVC_ENDPOINT

reqPath= '/' + SVC_VERSION + '/' + CONTAINER_ID + '/' + ENTITY_ID
SSDS = Net::HTTP::Proxy(myProxy.addr, myProxy.port, myProxy.user, myProxy.pw).new(authorityUri, 443)
SSDS.use_ssl=true
SSDS.verify_mode=OpenSSL::SSL::VERIFY_NONE
SSDS.start()

myReq = Net::HTTP::Delete.new(reqPath)       
myReq['Content-Type'] = 'application/x-ssds+xml'
myReq.basic_auth(myCred.un,  myCred.pw)
response = SSDS.request(myReq)
method = 'DELETE'
case response
  when Net::HTTPSuccess     then 
    puts ENTITY_ID + ' deleted'
    error = false
  when Net::HTTPNotFound then 
    puts "Entity does not exist"
    error = true
  when Net::HTTPForbidden then
    puts "SSDS Access denied"
    error = true
  when Net::HTTPBadRequest then
    puts "Request is not valid"
    error = true
  else
    puts "Unexpected Error"
    error = true
  end
  
  if (error)
    xml = REXML::Document.new(response.body)
    puts "SSDS #{method} Error: #{xml.root().elements[1].name} =>  #{xml.root().elements[1].text}"
    puts "SSDS #{method} Error: #{xml.root().elements[2].name} =>  #{xml.root().elements[2].text}"
  end

See Also

Concepts

Deleting an Entity Using REST
Examples of Using SOAP and REST Interfaces with the SQL Data Services