Method: Orchestrate::Client#patch_merge

Defined in:
lib/orchestrate/client.rb

#patch_merge(collection, key, body, condition = nil) ⇒ Object

Merge field/value pairs into existing key, without retrieving the key object. Patch. If a given field's value is nil, will remove field from existing key on merge.

Parameters:

  • collection (#to_s) —

    The name of the collection.

  • key (#to_s) —

    The name of the key.

  • body (#to_json) —

    The value for the key.

  • condition (String, false, nil) (defaults to: nil) —

    Conditions for setting the value. If String, value used as If-Match, value will only be updated if key's current value's ref matches. If nil (default), value is set regardless.

Returns:

  • Orchestrate::API::ItemResponse

Raises:

  • Orchestrate::API::BadRequest the body is not valid JSON.

  • Orchestrate::API::AlreadyPresent the false condition was given, but a value already exists for this collection/key combo.

[View source]

201
202
203
204
205
206
207
 
# File 'lib/orchestrate/client.rb', line 201

def patch_merge(collection, key, body, condition=nil)
  headers = {'Content-Type' => 'application/merge-patch+json'}
  if condition.is_a?(String)
    headers['If-Match'] = API::Helpers.format_ref(condition)
  end
  send_request :patch, [collection, key], { body: body, headers: headers, response: API::ItemResponse }
end