Skip to main content

Version: 22.04

Organization Property JSON Definition

Organization properties can be used to pre-populate forms or modify their behavior. For more information about properties, see Properties Overview.

Example

An example Organization Property definition file is shown below.

property-def.json
{
"name": "Product Values",
"dataType": "CSV",
"valueFile": "product-list.csv"
}

Schema

Organization Property definitions must comply with the following schema.

Fields are optional unless otherwise indicated.

FieldDescription
namestring

Required.

dataTypestring

Required. The origanization property's data type.

Must be one of the following:

  • "Boolean"
  • "CSV"
  • "HTML"
  • "Image"
  • "JSON"
  • "List"
  • "Long" Text
  • "Number"
  • "String"
valuestring

The organization property's value.

valueFilestring

The path to a file containing data matching the dataType attribute.