ZFlowCustomField | zAgile Docs

Base Type

ZFlowCustomField represents a Jira Issue custom field value. This Apex-defined type is the parent class for all supported Jira custom field types in Flows.

Field	Type	Description
fieldType	String	Custom Field Type: Indicates the data type of the field. Possible Values: MULTI_USER_FIELD SINGLE_USER_FIELD NUMBER_FIELD MULTI_CHOICE_FIELD SINGLE_CHOICE_FIELD DATE_FIELD DATETIME_FIELD TEXT_FIELD LABELS_FIELD CASCADE_FIELD

Field

Type

Description

fieldType

String

Custom Field Type: Indicates the data type of the field.

Possible Values:

MULTI_USER_FIELD
SINGLE_USER_FIELD
NUMBER_FIELD
MULTI_CHOICE_FIELD
SINGLE_CHOICE_FIELD
DATE_FIELD
DATETIME_FIELD
TEXT_FIELD
LABELS_FIELD
CASCADE_FIELD

All the following Apex-defined classes extends the ZFlowCustomField type.

ZFlowIssueFieldTextValue

Represents a Jira text custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
textValue	String	The value in plain text.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueFieldNumberValue

Represents a Jira number custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
numberValue	Decimal	Value in Apex decimal format.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueFieldDateValue

Represents a Jira date custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
dateValue	Date	Value in Apex date format.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueFieldDateTimeValue

Represents a Jira date time custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
datetimeValue	Datetime	Value in Apex datetime format.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueLabelsValue

Represents a Jira labels custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
selectedLabels	String[]	The value as a list of Jira labels.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueSingleChoiceValue

Represents a Jira single-choice list custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
selectedName	String	The chosen option name value.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueMultiChoiceValue

Represents a Jira Multiple-Choice list custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
selectedNames	String[]	The chosen options name values.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueSingleUserFieldValue

Represents a Jira User custom field value.

Field	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
userIdentifier	String	Holds the Jira user identifier. Depending on the Jira version, this could be either an Account Id (Jira Cloud) or a Username (Jira Data Center).
userDisplayName	String	Holds the display name of the Jira user.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueMultiUserFieldValue

Represents a Jira User field value, allowing multiple users.

Field	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
userIdentifiers	String[]	It holds the identifiers of the Jira users that compose the value of the field. The user identifier can be either an Account Id or a username, depending on the Jira version. This array corresponds by index with the userDisplayNames array, where each position matches the user's Id with their full name.
userDisplayNames	String[]	It holds the full display names of the Jira users that compose the value of the field. This array corresponds by index with the userIdentifiers array, where each position matches a user’s full name with their identifier.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.

ZFlowIssueCascadeValue

Represents a Jira cascading list custom field value.

	Type	Description
fieldId	String	Jira field Id, for example “customfield_10023“.
rootValue	String	The chosen root value.
childValue	String	The chosen child value.
field	ZFlowCustomField	Reference to this field value as ZFlowCustomField type.