Class: Jamf::OAPISchemas::Script

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Script

Defined in:

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

Overview

OAPI Object Model and Enums for: Script

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

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

Constant Summary

PRIORITY_OPTIONS =

Enums used by this class or others

[
  'BEFORE',
  'AFTER',
  'AT_REBOOT'
]

OAPI_PROPERTIES =

{

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

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

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

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

  # @!attribute priority
  #   @return [String]
  priority: {
    class: :string,
    enum: PRIORITY_OPTIONS
  },

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

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

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

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

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

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #categoryId ⇒ String
• #categoryName ⇒ String
• #id ⇒ String readonly
• #info ⇒ String
• #name ⇒ String
• #notes ⇒ String
• #osRequirements ⇒ String
• #parameter10 ⇒ String
• #parameter11 ⇒ String
• #parameter4 ⇒ String
• #parameter5 ⇒ String
• #parameter6 ⇒ String
• #parameter7 ⇒ String
• #parameter8 ⇒ String
• #parameter9 ⇒ String
• #priority ⇒ String
• #scriptContents ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#categoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 115

#categoryName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 121

#id ⇒ String (readonly)

Returns:

• (String)

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

#info ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 96

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 89

#notes ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 102

#osRequirements ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 175

#parameter10 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 163

#parameter11 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 169

#parameter4 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 127

#parameter5 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 133

#parameter6 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 139

#parameter7 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 145

#parameter8 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 151

#parameter9 ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 157

#priority ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 108

#scriptContents ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/script.rb', line 181