Module: JSS::Creatable

Included in:
AdvancedSearch, Building, Category, Department, ExtensionAttribute, Group, NetworkSegment, Package, Peripheral, PeripheralType, RemovableMacAddress, Script, Site, User
Defined in:
lib/jss-api.rb,
lib/jss-api/api_object/creatable.rb

Overview

A mix-in module that allows objects to be created in the JSS via the API.

When a JSS::APIObject subclass includes this module, that subclass can be instantiated with :id => :new, and :name => “some_new_name”.

The instance can be used to set desired values for the new object, and once everything’s good, use #create to create it in the JSS.

If a Creatable object requires more data than just a :name for creation, the subclass may want to redefine #initialize to require those data before calling super.

Some subclasses may want to redefine #create to check the data for consistency, and then call super (or they may have the individual setter methods do the checks)

Classes mixing this module must provide a #rest_xml instance method that returns the XML String to be submitted to the API for object creation.

See Also:

Constant Summary collapse

CREATABLE =

Constants

true

Instance Method Summary collapse

Instance Method Details

#create ⇒ Integer

Create a new object in the JSS.

Returns:

  • (Integer) —

    the jss ID of the newly created object

Raises:



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/jss-api/api_object/creatable.rb', line 85

def create
  raise JSS::UnsupportedError, "Creating or editing #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless CREATABLE
  raise AlreadyExistsError, "This #{self.class::RSRC_OBJECT_KEY} already exists. Use #update to make changes." if @in_jss
  JSS::API.post_rsrc( @rest_rsrc, rest_xml) =~ /><id>(\d+)<\/id></
  @id = $1.to_i
  @in_jss = true
  @need_to_update = false
  @rest_rsrc =  "#{self.class::RSRC_BASE}/id/#{@id}"
  return @id
end