Output Data Format

In the Embedded Documentation article, you will find examples of Resource requests, and you have the opportunity to test them.

In this document, you learn about generic outputs of requests.

Output data is always returned in JSON format.

data: contains returned objects and data from the Bacula server. If an error occurred, this field value will contain an error message.
error: contains integer value corresponding to the exit code from REST API server side. If there is no error then value is always set to 0 (zero).
limit: contains the limit that was specified in the call or the default (50) if none was specified.
offset: contains the offset used when returning data.

Example:

{
  "abc": "def",
  "ghi": 123,
  "extra_variables": ["one", "two", "three"],
  "last": 34.124
}

As noted above, limit and offset do not apply to cmd and status output.