Jira.js - Jira Cloud API library
    Preparing search index...

    Interface ComponentWithIssueCount

    Details about a component with a count of the issues it contains.

    interface ComponentWithIssueCount {
        assignee?: Version3Models.User;
        assigneeType?: string;
        description?: string;
        id?: string;
        isAssigneeTypeValid?: boolean;
        issueCount?: number;
        lead?: Version3Models.User;
        name?: string;
        project?: string;
        projectId?: number;
        realAssignee?: Version3Models.User;
        realAssigneeType?: string;
        self?: string;
    }
    Index

    Properties

    assignee? assigneeType? description? id? isAssigneeTypeValid? issueCount? lead? name? project? projectId? realAssignee? realAssigneeType? self?

    Properties

    assignee?: Version3Models.User
    assigneeType?: string

    The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:

    PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in. COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component. UNASSIGNED an assignee is not set for issues created with this component. PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.

    description?: string

    The description for the component.

    id?: string

    The unique identifier for the component.

    isAssigneeTypeValid?: boolean

    Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.

    issueCount?: number

    Count of issues for the component.

    lead?: Version3Models.User
    name?: string

    The name for the component.

    project?: string

    The key of the project to which the component is assigned.

    projectId?: number

    Not used.

    realAssignee?: Version3Models.User
    realAssigneeType?: string

    The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:

    PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in. COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in. UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues. PROJECT_DEFAULT when none of the preceding cases are true.

    self?: string

    The URL for this count of the issues contained in the component.

    Settings

    Member Visibility

    On This Page

    Properties