Config

Create Additional Field

Creates new Additional Field.

post/admin/config/additional-fields/{module}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/additional-fields/{module}
  • Auth: HTTP basic

Path parameters

modulestring required

Module name. List of modules:

  • admins: Administrators

  • partners: Partners

  • locations: Locations

  • customers: Customers

  • api: API keys

  • tariffs_internet: Internet tariffs

  • tariffs_voice: Voice tariffs

  • tariffs_custom: Recurring tariffs

  • tariffs_one_time: One-time plans

  • bundle: Bundles

  • routers: Routers

  • voice_devices: Voice devices

  • monitoring: Monitoring

  • ipv4_networks: IPv4 Networks

  • ipv6_networks: IPv6 Networks

  • services_internet: Services (Internet)

  • services_voice: Services (Voice)

  • services_custom: Services (Custom)

  • services_bundle: Services (Bundle)

  • invoices: Invoices

  • statistics: Statistics

  • ticket: Tickets

  • instant_message: Messages

  • templates: Templates

  • customer_documents: Customer documents

  • monitoring_oid: SNMP OID

  • network_sites: Network sites

  • ipv4_networks_ip: IPv4 Networks IP

  • cards_prepaid: Prepaid cards

  • cards_refill: Refill cards

  • routers_sectors: Routers sectors

  • routers_mikrotik: Routers (MikroTik)

  • cpe: CPE (MikroTik)

  • services_voice_calls: Voice Calls

  • billing_transactions: Transactions

  • payments: Payments

  • requests: Proforma invoices

  • credit_notes: Credit Notes

  • quotes: Quotes

  • inventory_items: Items (Inventory)

  • inventory_supplier_invoices: Supplier invoices (Inventory)

  • inventory_products: Products (Inventory)

  • inventory_suppliers: Suppliers (Inventory)

  • inventory_vendors: Vendors (Inventory)

  • scheduling_project: Scheduling project

  • scheduling_task: Tasks

  • acs_devices: ACS devices

  • module_name: for your modules

Request body

namestring required

Field name

titlestring required

Field title

typestring required

Type. Values: 'string' for 'String', 'integer' for 'Integer', 'decimal' for 'Decimal', 'numeric' for 'Numeric', 'date' for 'Date', 'datetime' for 'Datetime', 'boolean' for 'Boolean', 'select' for 'Select', 'select_multiple' for 'Select multiple', 'password' for 'Password', 'file' for 'File', 'relation' for 'Relation' and 'relation_multiple' for 'Relation multiple'

positionnumber

Position

default_valuestring

Default value

min_lengthstring

Min

max_lengthstring

Max

is_requirednumber required

Required. Values: 0 or 1

is_uniquenumber required

Unique. Values: 0 or 1

is_addnumber required

Add. Values: 0 or 1

show_in_listnumber required

Show in list. Values: 0 or 1

searchablenumber required

Searchable. Values: 0 or 1

readonlynumber required

Readonly. Values: 0 or 1

disablednumber required

Disabled. Values: 0 or 1

hiddennumber

Hidden. Values: 0 or 1

select_valuesstring

Select values separated by comma. Required for AF with select types

relation_modulestring

Relation module name. Can be any of modules (look in Parameters). Required for AF with select types

set_default_valuenumber

Set default value for all items. Values: 0 or 1

addonstring

Addon

addon_uristring

Addon URI

addon_input_typestring

Addon input type. Values: '', 'button', 'text', 'text_plus_button'. Default: ''

decimalsnumber

Decimals. Default: 2. Required for AF with decimal type

Example request

{
  "name": "remark",
  "title": "Remark",
  "type": "string",
  "position": 1,
  "default_value": "none",
  "min_length": "1",
  "max_length": "128",
  "is_add": 1,
  "set_default_value": 1,
  "decimals": 2
}

Response

namestring

Additional Field name

Example response

{
  "name": "remark"
}

Changes

No recorded changes to this operation across all 1 revision of this API.