Class: Jamf::OAPISchemas::ApiError

Inherits:

Jamf::OAPIObject

Object
Jamf::OAPIObject
Jamf::OAPISchemas::ApiError

show all

Defined in:: lib/jamf/api/jamf_pro/oapi_schemas/api_error.rb

Overview

OAPI Object Model and Enums for: ApiError

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.46.0-t1681398190

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::ApiErrorCause

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

Constant Summary collapse

OAPI_PROPERTIES =

{

  # HTTP status of the response
  # @!attribute httpStatus
  #   @return [Integer]
  httpStatus: {
    class: :integer
  },

  # @!attribute errors
  #   @return [Array<Jamf::OAPISchemas::ApiErrorCause>]
  errors: {
    class: Jamf::OAPISchemas::ApiErrorCause,
    multi: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#errors ⇒ `Array<Jamf::OAPISchemas::ApiErrorCause>`

Returns:

(Array<Jamf::OAPISchemas::ApiErrorCause>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/api_error.rb', line 76

#httpStatus ⇒ `Integer`