Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Type

Datamodel example

Text Field

Code Block
languagejson
{
      "type": "text",
      "value": ""
}

Text Area
(since Version 1.1.0)

Code Block
languagejson
{
      "type": "textarea",
      "value": ""
}

Single Select

Code Block
languagejson
{
      "type": "select-single",
      "allowedValues": [
        {
          "id": "High",
          "name": "High",
          "lozenge": {
            "appearance": "removed",
            "bold": true
          }
        },
        {
          "id": "Medium",
          "name": "Medium",
          "lozenge": {
            "appearance": "moved",
            "bold": true
          }
        },
        {
          "id": "Low",
          "name": "Low",
          "lozenge": {
            "appearance": "success",
            "bold": true
          }
        }
      ],
      "value": {
        "id": "medium",
        "name": "Medium",
        "lozenge": {
          "appearance": "moved",
          "bold": true
        }
      }
    }

Single Select
(with number value)
(since Version 2.8.0)

Code Block
languagejson
{
      "type": "select-single-number",
      "allowedValues": [
        {
          "name": "High",
          "value": 10,
          "lozenge": {
            "appearance": "removed",
            "bold": true
          }
        },
        {
          "name": "Medium",
          "value": 5,
          "lozenge": {
            "appearance": "moved",
            "bold": true
          }
        },
        {
          "name": "Low",
          "value": 1,
          "lozenge": {
            "appearance": "success",
            "bold": true
          }
        }
      ],
      "value": {
        "name": "Medium",
        "value": 5,
        "lozenge": {
          "appearance": "moved",
          "bold": true
        }
      }
    }

Multi Select

Code Block
languagejson
{
      "type": "select-multi",
      "allowedValues": [
        {
          "id": "Red",
          "name": "Red",
          "lozenge": {
            "appearance": "removed",
            "bold": true
          }
        },
        {
          "id": "Yellow",
          "name": "Yellow",
          "lozenge": {
            "appearance": "moved",
            "bold": true
          }
        },
        {
          "id": "Green",
          "name": "Green",
          "lozenge": {
            "appearance": "success",
            "bold": true
          }
        }
      ],
      "value": []
    }

Markdown Field

Code Block
languagejson
{
      "type": "markdown",
      "value": "Hello, **World**!"
}

Date Field

Code Block
languagejson
{
      "type": "date",
      "value": "2020-11-02"
}

Datetime Field

Code Block
languagejson
{
      "type": "datetime",
      "value": "2021-04-22T00:20+0200"
}

Number Field

Code Block
languagejson
{
      "type": "number",
      "value": 3
}

URL Field

Code Block
languagejson
{
      "type": "url",
      "value": "http://www.evolu.software"
}

Single User

Code Block
languagejson
{
      "type": "user-single",
      "value": {
        "id": "ff659e015eec6c08bb0003",
        "name": "jose"
      }
}

Multi User

Code Block
languagejson
{
      "type": "user-multi",
      "value": [{
        "id": "ff659e015eec6c08bb0003",
        "name": "jose"
      },
      {
        "id": "ff65dsljfk93b0003",
        "name": "alana"
      }]
}

Boolean

Code Block
languagejson
{
      "type": "boolean",
      "allowedValues": [
        {
          "id": "true",
          "name": "Approved"
        },
        {
          "id": "false",
          "name": "Rejected"
        }
      ],
      "value": true
    }
}

Rating
(since Version 1.1.0)

Code Block
languagejson
{
      "type": "rating",
      "allowedValues": [
        {
          "name": "Really negative",
          "value": 1, 
          "icon": "star"
        },
​​​        {
          "name": "Negative",
          "value": 2, 
          "icon": "star"
        },
        {
          "name": "Alright",
          "value": 3,
          "icon": "star"
        },
        {
          "name": "Positive",
          "value": 4,
          "icon": "star"
        },
        {
          "name": "Really positive",
          "value": 5,
          "icon": "star"
        }
      ],
      "value": 
        {
          "name": "Positive",
          "value": 4,
          "icon": "star"
        }
}

Radio Button
(since Version 2.4.0)

Code Block
languagejson
{
     "type": "radiobutton",
          "value": {
          "name": "approved" 
          },
          "allowedValues": [
          { 
          "name": "in review" 
          },
          { 
          "name": "on hold" 
          },
          {
          "name": "approved" 
          }, 
          {
          "name": "rejected"
          }, 
        ]
}

Checkbox Field
(since Version 2.7.0)

Code Block
languagejson
{
     "type": "checkbox",
          "value": [
          { 
          "name": "Java" 
          },
          {
          "name": "Python" 
          } 
        ],
          "allowedValues": [
          { 
          "name": "Java" 
          },
          { 
          "name": "C++" 
          },
          {
          "name": "Python" 
          }, 
          {
          "name": "JS"
          }, 
        ]
}

Calculated Field
(since Version 2.9.0)
(calcFormat since 2.9.2)

For more information check out:

How to configure Calculated Fields
Operators for Calculated Fields

Code Block
languagejson
{
     "type": "calculated",
          "value": "",
          "config": {
            "calc": "risk-id impact-id + effort-id /",
            "calcFormat": [
              { "start": undefined, "end": 50, "color": "#FF494D" },
              { "start": 50, "end": 100, "color": "#6fa8dc" },
              { "start": 100, "end": undefined, "color": "#b6d7a8" }
            ]
          }
}

Link Field
(since Version 2.9.0)

Code Block
{
     "type": "link",
     "config": {
       "ctype": "page"
     }
}