Class: Jamf::OAPISchemas::DashboardItem

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb

Overview

OAPI Object Model and Enums for: DashboardItem

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

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::DashboardApiError

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 = 
{

  # @!attribute id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary
  },

  # @!attribute title
  #   @return [String]
  title: {
    class: :string,
    nil_ok: true
  },

  # @!attribute subtitle
  #   @return [String]
  subtitle: {
    class: :string,
    nil_ok: true
  },

  # Additional information such as identifiers for a specific policy within a software patch
  # @!attribute info
  #   @return [String]
  info: {
    class: :string,
    nil_ok: true
  },

  # Logical to decide whether widget should be enabled or disabled; i.e. Policy
  # @!attribute enabled
  #   @return [Boolean]
  enabled: {
    class: :boolean
  },

  # @!attribute metrics
  #   @return [Array<Hash{Symbol: Object}>]
  metrics: {
    class: :hash,
    multi: true
  },

  # @!attribute details
  #   @return [Array<Hash{Symbol: Object}>]
  details: {
    class: :hash,
    multi: true
  },

  # @!attribute error
  #   @return [Jamf::OAPISchemas::DashboardApiError]
  error: {
    class: Jamf::OAPISchemas::DashboardApiError
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#details ⇒ Array<Hash{Symbol: Object}>

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 112

#enabled ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 98

#error ⇒ Jamf::OAPISchemas::DashboardApiError

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 119

#id ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 69

#info ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 90

#metrics ⇒ Array<Hash{Symbol: Object}>

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 105

#subtitle ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/dashboard_item.rb', line 83

#title ⇒ String

Returns:




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