ProjectTeam
Represents a project team. To access a project team in a workflow, use the team property of a Project object, such as ctx.issue.project.team, or the teams property of a User object. In rule requirements, reference a project team as a UserGroup by name.
Extends UserGroup.
Properties
Name | Type | Description |
|---|---|---|
static allUsersGroup | Read-only. The All Users group. | |
static fieldType | String | Read-only. Field type. Used when defining rule requirements. |
becomesRemoved | Boolean | Read-only. When Available since 2017.4.37915 runOn: {removal: true} |
customerGroupProjects | Read-only. The set of helpdesk projects where this group is configured as a customer group. For groups that are not customer groups, this property is an empty set. Available since 2026.2 | |
description | String | Read-only. The description of the group. |
extensionProperties | Object | The object containing extension properties for this entity and their values. Extension properties are custom properties that might be added to core YouTrack entities by an app. For details about extension properties, see Extension Properties. Available since 2024.3 const entities = require('@jetbrains/youtrack-scripting-api/entities');
exports.rule = entities.Issue.action({
command: 'test',
action: function (ctx) {
const printValues = () => {
return 'stringProp:' + ctx.issue.extensionProperties.stringProp + ';'
+ 'integerProp:' + ctx.issue.extensionProperties.integerProp + ';'
+ 'booleanProp:' + ctx.issue.extensionProperties.booleanProp + ';'
+ 'issueProp:' + ctx.issue.extensionProperties.issueProp?.id + ';'
+ 'issuesProp:' + ctx.issue.extensionProperties.issuesProp?.first()?.id + ';'
}
ctx.issue.addComment(printValues());
}
}); |
isAllUsersGroup | Boolean | Read-only. If the group is the All Users group, this property is |
isAutoJoin | Boolean | Read-only. If the auto-join option is enabled for the group, this property is |
isCustomerGroup | Boolean | Read-only. If this group is a helpdesk customer group, this property is Available since 2026.2 |
isNew | Boolean | Read-only. When Available since 2018.2.42351 |
name | String | Read-only. The name of the group. |
project | Read-only. The project that the team belongs to. Available since 2025.3 | |
users | Read-only. A list of users who are members of the group. |
Methods
findByExtensionProperties
Searches for ProjectTeam entities with extension properties that match the specified query.
Available since 2024.3.43260
- Parameters
Name
Type
Description
extensionPropertiesQuery
Object
The extension properties query, defined as a set of key-value pairs representing properties and their corresponding values.
- Return Value
Type
Description
Set .< ProjectTeam >
The set of ProjectTeam entities that contain the specified extension properties.
- Example
- { property1: "value1", property2: "value2" }
findByName
Finds a group by name.
- Parameters
Name
Type
Description
name
String
The name of the group to search for.
- Return Value
Type
Description
The specified user group, or
nullwhen a group with the specified name is not found.
becomes
Checks whether a field is set to an expected value in the current transaction.
- Parameters
Name
Type
Description
fieldName
string
The name of the field to check.
expected
string
The expected value.
- Return Value
Type
Description
boolean
If the field is set to the expected value, returns
true.
canBeReadBy
Checks whether a user has permission to read the field.
- Parameters
Name
Type
Description
fieldName
string
The name of the field.
user
The user for whom the permission to read the field is checked.
- Return Value
Type
Description
boolean
If the user can read the field, returns
true.
canBeWrittenBy
Checks whether a user has permission to update the field.
- Parameters
Name
Type
Description
fieldName
string
The name of the field.
user
The user for whom the permission to update the field is checked.
- Return Value
Type
Description
boolean
If the user can update the field, returns
true.
is
Checks whether a field is equal to an expected value.
Available since 2019.2.55603
- Parameters
Name
Type
Description
fieldName
string
The name of the field to check.
expected
string
The expected value.
- Return Value
Type
Description
boolean
If the field is equal to the expected value, returns
true.
isChanged
Checks whether the value of a field is changed in the current transaction.
- Parameters
Name
Type
Description
fieldName
string
The name of the field to check.
- Return Value
Type
Description
boolean
If the value of the field is changed in the current transaction, returns
true.
notifyAllUsers
Sends an email notification to all of the users who are members of the group.
- Parameters
Name
Type
Description
subject
String
The subject line of the email notification.
body
String
The message text of the email notification.
- Example
- issue.oldValue('permittedGroup').notifyAllUsers('Visibility has been changed', 'The visibility group for the issue ' + issue.getId() + ' has been changed to ' + permittedGroup.name);
oldValue
Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, returns null.
- Parameters
Name
Type
Description
fieldName
string
The name of the field.
- Return Value
Type
Description
Object
If the field is changed in the current transaction, the previous value of the field. Otherwise,
null.
required
Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.
- Parameters
Name
Type
Description
fieldName
string
The name of the field to check.
message
string
The message that is displayed to the user that describes the field requirement.
was
Checks whether a field was equal to an expected value prior to the current transaction.
Available since 2019.2.55603
- Parameters
Name
Type
Description
fieldName
string
The name of the field to check.
expected
string
The expected value.
- Return Value
Type
Description
boolean
If the field was equal to the expected value, returns
true.