Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration FieldTypes

The currently supported types for metadata fields.

Enumeration members

Boolean

Boolean: = "Boolean"

A boolean field. Rendered as a toggle in the UI.

When used together with certain ids, a field of this type will have additional logic / side-effects:

id note
"IsPrivate" If the baseTemplate is GROUP#0, the field value syncs to the O365 group visibility assigned to the workspace. Has no additional logic attached when used together with other baseTemplates.

Choice

Choice: = "Choice"

A single-value choice field. Rendered as a dropdown field.

This field type supports additional configuration options (see additionalProps):

Example:

"additionalProps": {
  "Choices": [
    {
      "value": "Choice 1",
      "label": {
        "1031": "Deutsch 1",
        "1033": "English 1"
      }
    },
    {
      "value": "Choice 2",
      "label": {
        "1031": "Deutsch 2",
        "1033": "English 2"
      }
    },
    ...
  ]
}

where label is a MuiString

Date

Date: = "Date"

A date field. Represented as a date picker in the UI.

This field type supports additional configuration options (see additionalProps) with formatOptions defined in Date.prototype.toLocaleDateString() options. It can be also specified whether the current date should be used as a default value, by passing "useNowAsDefault": true in "additionalProps".

Example:

"additionalProps": {
  "formatOptions": {
    "weekday": "long",
    "year": "numeric",
    "month": "short",
    "day": "numeric"
  },
  "useNowAsDefault": true
}

MultiChoice

MultiChoice: = "MultiChoice"

A multi-value choice field. Rendered as a dropdown field.

This field type supports additional configuration options (see additionalProps):

Example:

"additionalProps": {
  "Choices": [
    {
      "value": "Choice 1",
      "label": {
        "1031": "Deutsch 1",
        "1033": "English 1"
      }
    },
    {
      "value": "Choice 2",
      "label": {
        "1031": "Deutsch 2",
        "1033": "English 2"
      }
    },
    ...
  ]
}

where label is a MuiString

MultiPerson

MultiPerson: = "MultiPerson"

A multi person field. Represented as a people picker in the UI.

When used together with certain ids, a field of this type will have additional logic / side-effects:

id note
"Owners" Syncs to the default associated owner group of the site collection.
"Members" Syncs to the default associated member group of the site collection.
"Visitors" Syncs to the default associated visitor group of the site collection.
"GroupOwners" Syncs to the associated O365 group owners.
"GroupMembers" Syncs to the associated O365 group members.

MultiTaxonomy

MultiTaxonomy: = "MultiTaxonomy"

A multi taxonomy field connected to the taxonomy store in SharePoint. Users can select terms from the configured termSetId from a taxonomy picker in the UI.

This field type needs additional configuration (see additionalProps):

Example:

"additionalProps": {
  "termSetId": "7eba0500-b72a-4fa7-a2d6-df26611d6983"
}

Number

Number: = "Number"

A number field.

Person

Person: = "Person"

A single person field. Represented as a people picker in the UI.

String

String: = "String"

A text field.

When used together with certain ids, a field of this type will have additional logic / side-effects:

id note
"Title" Syncs to the SharePoint site collection title (and attached group).
"Description" Syncs to the SharePoint site collection description (and attached group).

This field type supports additional configuration options (see additionalProps):

Example:

"additionalProps": {
  "multiline": true,
  "prefix": {
    "value": "MP_",
    "hidden": true
  },
  "suffix": {
    "value": "_",
    "hidden": true
  }
}

If multiline is set to true, the field renders as a resizable multiline text field. Defaults to false.

Optional prefix object can be defined with a value and hidden member that represent the prefix value and if the prefix should be hidden in the UI.

Optional suffix object, same as prefix.

Taxonomy

Taxonomy: = "Taxonomy"

A taxonomy field connected to the taxonomy store in SharePoint. Users can select a term from the configured termSetId from a taxonomy picker in the UI.

This field type needs additional configuration (see additionalProps):

Example:

"additionalProps": {
  "termSetId": "7eba0500-b72a-4fa7-a2d6-df26611d6983"
}

WorkspaceRole

WorkspaceRole: = "WorkspaceRole"

This field type is deprecated.

Please use the MultiPerson field instead.