osapi.jive.corev3.metadata.Field
Definition of an individual field that belongs to an object type.
Properties
| Property | Type | Mode † | Description |
|---|---|---|---|
array | Boolean | read-only | ↑ Flag indicating whether this field is represented as a JSON array, as opposed to an individual value. |
availability | String | read-only | ↑ Comments regarding when this field will be present in an object representation. |
description | String | read-only | ↑ Description of this field (for profile fields, this information is localized). |
displayName | String | read-only | ↑ Display name of this field (for profile fields, this information is localized). |
editable | Boolean | read-only | ↑ Flag indicating that this field can be included on a create request, or modified on an update request. |
filterable | Boolean | read-only | ↑ Flag indicating that this field is filterable (has a defined set of options). |
name | String | read-only | ↑ The name of this field, as it will appear in a JSON representation. |
newsEnabled | Boolean | read-only | ↑ |
options | String[] | read-only | ↑ Valid options when the field is of type multilist or singlelist. Since: 3.4 |
required | Boolean | read-only | ↑ Flag indicating that this field MUST be included on a create or update request. |
since | String | read-only | ↑ Comments about the first version of the API in which this object became available. |
type | String | read-only | ↑ The data type for values in this field. |
unpublished | Boolean | read-only | ↑ Flag indicating that this field is present for internal use only, and should not be considered to be generally available or documented. |