module Orchestrate::API::Procedural

Procedural interface methods (optional).¶ ↑

This file serves as useful documentation for the Orchestrate.io REST API. Each method illustrates an example for the corresponding HTTP request, and documents the required keys for the send_request argument hash.

Public Instance Methods

delete_collection(args) click to toggle source

required: { collection }

# File api/lib/orchestrate_api/procedural.rb, line 29
def delete_collection(args)
  send_request :delete, args.merge(path: "?force=true")
end

delete_graph(args) click to toggle source

required: { collection, key, kind, to_collection, to_key }

# File api/lib/orchestrate_api/procedural.rb, line 115
def delete_graph(args)
  send_request :delete, args.merge(path: "?purge=true")
end

delete_key(args) click to toggle source

required: { collection, key }

# File api/lib/orchestrate_api/procedural.rb, line 50
def delete_key(args)
  send_request :delete, args
end

get_by_ref(args) click to toggle source

required: { collection, key, ref }

# File api/lib/orchestrate_api/procedural.rb, line 65
def get_by_ref(args)
  send_request :get, args
end

get_events(args) click to toggle source

required: { collection, key, event_type }
optional: { timestamp }, where timestamp = { :start => start, :end => end }

# File api/lib/orchestrate_api/procedural.rb, line 87
def get_events(args)
  send_request :get, args
end

get_graph(args) click to toggle source

required: { collection, key, kind }

# File api/lib/orchestrate_api/procedural.rb, line 103
def get_graph(args)
  send_request :get, args
end

get_key(args) click to toggle source

required: { collection, key }

# File api/lib/orchestrate_api/procedural.rb, line 38
def get_key(args)
  send_request :get, args
end

list(args) click to toggle source

required: { collection }
optional: { path }, which should have been called params

# File api/lib/orchestrate_api/procedural.rb, line 17
def list(args)
  send_request :get, args
end

purge_key(args) click to toggle source

required: { collection, key }

# File api/lib/orchestrate_api/procedural.rb, line 56
def purge_key(args)
  send_request :delete, args.merge(path: "?purge=true")
end

put_event(args) click to toggle source

required: { collection, key, event_type, json }
optional: { timestamp }, where timestamp is a scalar value

# File api/lib/orchestrate_api/procedural.rb, line 94
def put_event(args)
  send_request :put, args
end

put_graph(args) click to toggle source

required: { collection, key, kind, to_collection, to_key }

# File api/lib/orchestrate_api/procedural.rb, line 109
def put_graph(args)
  send_request :put, args
end

put_key(args) click to toggle source

required: { collection, key, json }

# File api/lib/orchestrate_api/procedural.rb, line 44
def put_key(args)
  send_request :put, args
end

put_key_if_match(args) click to toggle source

required: { collection, key, json, ref }

# File api/lib/orchestrate_api/procedural.rb, line 71
def put_key_if_match(args)
  send_request :put, args
end

put_key_if_none_match(args) click to toggle source

required: { collection, key, json }

# File api/lib/orchestrate_api/procedural.rb, line 77
def put_key_if_none_match(args)
  send_request :put, args.merge(ref: '"*"')
end

search(args) click to toggle source

required: { collection }

# File api/lib/orchestrate_api/procedural.rb, line 23
def search(args)
  send_request :get, args.merge(path: "?query=#{args[:query].gsub(/\s/, '%20')}")
end