Class: Jamf::OAPISchemas::ExportParameters

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ExportParameters

Defined in:

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

Overview

OAPI Object Model and Enums for: ExportParameters

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

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

- '/v1/buildings/export:POST' needs permissions:
  - Read Buildings
- '/v1/buildings/{id}/history/export:POST' needs permissions:
  - Read Buildings
- '/v1/cloud-idp/export:POST' needs permissions:
  - Read LDAP Servers
- '/v1/reenrollment/history/export:POST' needs permissions:
  - Read Re-enrollment
- '/v2/enrollment/history/export:POST' needs permissions:
  - Read User-Initiated Enrollment
- '/v2/inventory-preload/export:POST' needs permissions:
  - Read Inventory Preload Records

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute page
  #   @return [Integer]
  page: {
    class: :integer,
    nil_ok: true
  },

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

  # Sorting criteria in the format: [<property>[:asc/desc]. Default direction when not stated is ascending.
  # @!attribute sort
  #   @return [Array<String>]
  sort: {
    class: :string,
    nil_ok: true,
    multi: true
  },

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

  # Used to change default order or ignore some of the fields. When null or empty array, all fields will be exported.
  # @!attribute fields
  #   @return [Array<Jamf::OAPISchemas::ExportField>]
  fields: {
    class: Jamf::OAPISchemas::ExportField,
    nil_ok: true,
    multi: true
  }

}

Instance Attribute Summary

• #fields ⇒ Array<Jamf::OAPISchemas::ExportField>
• #filter ⇒ String
• #page ⇒ Integer
• #pageSize ⇒ Integer
• #sort ⇒ Array<String>

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#fields ⇒ Array<Jamf::OAPISchemas::ExportField>

Returns:

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

# File 'lib/jamf/api/jamf_pro/oapi_schemas/export_parameters.rb', line 110

#filter ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/export_parameters.rb', line 103

#page ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/export_parameters.rb', line 80

#pageSize ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/export_parameters.rb', line 87

#sort ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/export_parameters.rb', line 94