Class: Jamf::OAPISchemas::Department

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Department

Defined in:

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

Overview

OAPI Object Model and Enums for: Department

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

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

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/departments:POST' needs permissions:
  - Create Departments
- '/v1/departments/{id}:GET' needs permissions:
  - Read Departments
- '/v1/departments/{id}:PUT' needs permissions:
  - Update Departments

Constant Summary

OAPI_PROPERTIES =

{

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

  # @!attribute name
  #   @return [String]
  name: {
    class: :string,
    required: true,
    min_length: 1,
    max_length: 225
  }

}

Instance Attribute Summary

• #id ⇒ String readonly
• #name ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/department.rb', line 75

#name ⇒ String

Returns:

• (String)

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