Class: Jamf::OAPISchemas::MobileDeviceSearchParams

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::MobileDeviceSearchParams

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb

Overview

OAPI Object Model and Enums for: MobileDeviceSearchParams

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

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

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

- '/v1/search-mobile-devices:POST' needs permissions:
  - Read Mobile Devices

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute pageNumber
  #   @return [Integer]
  pageNumber: {
    class: :integer
  },

  # @!attribute pageSize
  #   @return [Integer]
  pageSize: {
    class: :integer
  },

  # @!attribute isLoadToEnd
  #   @return [Boolean]
  isLoadToEnd: {
    class: :boolean
  },

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

  # @!attribute udid
  #   @return [String]
  udid: {
    class: :string
  },

  # @!attribute macAddress
  #   @return [String]
  macAddress: {
    class: :string
  },

  # @!attribute name
  #   @return [String]
  name: {
    class: :string
  },

  # @!attribute serialNumber
  #   @return [String]
  serialNumber: {
    class: :string
  },

  # @!attribute osType
  #   @return [String]
  osType: {
    class: :string
  },

  # @!attribute isManaged
  #   @return [Boolean]
  isManaged: {
    class: :boolean
  },

  # @!attribute excludedIds
  #   @return [Array<Integer>]
  excludedIds: {
    class: :integer,
    multi: true
  }

}

Instance Attribute Summary

• #excludedIds ⇒ Array<Integer>
• #isLoadToEnd ⇒ Boolean
• #isManaged ⇒ Boolean
• #macAddress ⇒ String
• #name ⇒ String
• #orderBy ⇒ Array<Jamf::OAPISchemas::OrderBy>
• #osType ⇒ String
• #pageNumber ⇒ Integer
• #pageSize ⇒ Integer
• #serialNumber ⇒ String
• #udid ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#excludedIds ⇒ Array<Integer>

Returns:

• (Array<Integer>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 131

#isLoadToEnd ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 82

#isManaged ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 125

#macAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 101

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 107

#orderBy ⇒ Array<Jamf::OAPISchemas::OrderBy>

Returns:

• (Array<Jamf::OAPISchemas::OrderBy>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 88

#osType ⇒ String

Returns:

• (String)

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

#pageNumber ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 70

#pageSize ⇒ Integer

Returns:

• (Integer)

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

#serialNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 113

#udid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_search_params.rb', line 95