General Rest API request types

The following verbs are allowed:

  • GET - retrieve either an object information or a list of objects.
  • PUT - update. Will also create if the object does not currently exist. Will return the object after update.
  • POST - create when POSTed to an objecttype URL, clone when POSTed to an object URL. However, creations will update if the object already exists. Will return the object after creation.
  • DELETE - delete object. Will return a hash with response {“success”:1}

The data passed to the API is in the form of key/value pairs. The key is a string, but the value can be a string, an array or an associative hash. Examples are below.

When updating data, keys that are unexpected are silently ignored.

Values in an array are expected to be related objects in a hash format. If the related object is not in a hash format, you will get an HTTP 400 error with the message: Error when parsing data, and detail: Not a HASH: name.

An error will be raised if related objects cannot be found.