Class: Jamf::OAPISchemas::SiteObject

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

Overview

OAPI Object Model and Enums for: SiteObject

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.

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

- '/v1/sites/{id}/objects:GET' needs permissions:
  - Read Sites

Constant Summary collapse

OBJECT_TYPE_OPTIONS =

Enums used by this class or others

[
  'Computer',
  'Peripheral',
  'Licensed Software',
  'Licensed Software Template',
  'Policy',
  'macOS Configuration Profile',
  'Restricted Software',
  'Managed Preference Profile',
  'Computer Group',
  'Mobile Device',
  'Apple TV',
  'Android Device',
  'User Group',
  'iOS Configuration Profile',
  'Mobile Device App',
  'E-book',
  'Mobile Device Group',
  'Classroom',
  'Advanced Computer Search',
  'Advanced Mobile Search',
  'Advanced User Search',
  'Advanced User Content Search',
  'Computer Invitation',
  'Mobile Device Invitation',
  'Mobile Device Enrollment Profile',
  'Device Enrollment Program Instance',
  'Mobile Device Prestage',
  'Computer DEP Prestage',
  'Enrollment Customization',
  'VPP Location',
  'VPP Subscription',
  'VPP Invitation',
  'VPP Assignment',
  'User',
  'Network Integration',
  'Mac App',
  'App Installer',
  'BYO Profile',
  'Self Service Plugin',
  'Software Title',
  'Patch Software Title Summary',
  'Patch Policy',
  'Patch Software Title Configuration',
  'Change Password',
  'Mobile Device Inventory',
  'Computer Inventory',
  'Change Management',
  'Licensed Software License',
  'Unknown'
]
OAPI_PROPERTIES = 
{

  # @!attribute siteId
  #   @return [String]
  siteId: {
    class: :string,
    required: true
  },

  # @!attribute objectType
  #   @return [String]
  objectType: {
    class: :string,
    required: true,
    enum: OBJECT_TYPE_OPTIONS
  },

  # @!attribute objectId
  #   @return [String]
  objectId: {
    class: :string,
    required: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#objectId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/site_object.rb', line 137

#objectType ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/site_object.rb', line 129

#siteId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/site_object.rb', line 122