Class: Jamf::APIError

Inherits:

JSONObject

Object
JSONObject
Jamf::APIError

show all

Defined in:: lib/jamf/api/connection/api_error_styleguide.rb

Overview

When the API returns an HTTP status other than 2xx or 3xx, the document body contains one of these.

Constant Summary collapse

OBJECT_MODEL =

{

  # @!attribute [r] traceId
  #   @return [String]
  traceId: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] errors
  #   @return [Array<Jamf::APIErrorDetail>]
  errors: {
    class: Jamf::APIErrorDetail,
    readonly: true,
    multi: true
  }

}.freeze

Instance Attribute Summary collapse

#errors ⇒ Array<Jamf::APIErrorDetail> readonly
#traceId ⇒ String readonly

Constructor Details

This class inherits a constructor from Jamf::JSONObject

Instance Attribute Details

#errors ⇒ `Array<Jamf::APIErrorDetail>` (readonly)

Returns:

(Array<Jamf::APIErrorDetail>)

# File 'lib/jamf/api/connection/api_error_styleguide.rb', line 43

#traceId ⇒ `String` (readonly)