Class: Jamf::OAPISchemas::ReturnToServiceConfiguration

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

Overview

OAPI Object Model and Enums for: ReturnToServiceConfiguration

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.

- Jamf::OAPISchemas::ReturnToServiceConfigurationSearchResults

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/return-to-service/{id}:GET' needs permissions:
  - View Return To Service Configurations
- '/v1/return-to-service/{id}:PUT' needs permissions:
  - Edit Return To Service Configurations

Constant Summary collapse

OAPI_PROPERTIES = 
{

  # Id of the Return to Service Configuration.
  # @!attribute id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    minimum: 1
  },

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

  # Id of the wifi profile that is associated with the return to service configuration.
  # @!attribute wifiProfileId
  #   @return [String]
  wifiProfileId: {
    class: :string
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#displayName ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/return_to_service_configuration.rb', line 81

#id ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/return_to_service_configuration.rb', line 72

#wifiProfileId ⇒ String

Returns:




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