The Field Plugins Object

This is an object representing a field plugin.

Properties

id
number

Numeric ID of your field plugin
name
string

Given name of your field plugin. Needs to be unique. A personal prefix is recommended (Example: my-geo-selector).
body
string

The uncompiled JavaScript code of the field plugin.
compiled_body
string

Used by the online code editor. Needs to be an empty string if using local plugin development.
space_ids
number[]

Array of space ids where the field plugin is assigned to.
options
object[]

Options added to the plugin
- name
  string
  
  Name of the option
- value
  string
  
  Default value of the option
last_versions
object[]

Array of last versions of the plugin
- id
  number
  
  ID of the version
- event
  string
  
  Event
- created_at
  string
  
  Date at which the version was created
- author_id
  number
  
  ID of the author
- author
  string
  
  Name of the author
- item_id
  number
  
  Plugin ID
- is_draft
  boolean
  
  If in draft
belongs_to_partner
boolean

If the plugin belongs to a partner portal
belongs_to_org
boolean

If the plugin belongs to an organization
user
object

The user object

Example Object

{
  "field_type": {
    "id": 124,
    "name": "my-geo-selector",
    "body": "var Fieldtype = {}",
    "compiled_body": "",
    "space_ids": [],
     "options": [
      {
        "name": "starts_with",
        "value": ""
      },
      {
        "name": "maximum",
        "value": ""
      }
     ],
     "last_versions": [],
     "belongs_to_parnter" : false,
     "belongs_to_org": "false",
     "user" : {}
  }
}

Prev Introduction

Next Retrieve a Single Field Plugin