Interface ProjectComponent

Details about a project component.

interface ProjectComponent {
    ari?: string;
    assignee?: User;
    assigneeType?:
        | "PROJECT_LEAD"
        | "UNASSIGNED"
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD";
    description?: string;
    id?: string;
    isAssigneeTypeValid?: boolean;
    lead?: User;
    leadAccountId?: string;
    leadUserName?: string;
    metadata?: {
        [key: string]: string;
    };
    name?: string;
    project?: string;
    projectId?: number;
    realAssignee?: User;
    realAssigneeType?:
        | "PROJECT_LEAD"
        | "UNASSIGNED"
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD";
    self?: string;
}

Properties

ari? assignee? assigneeType? description? id? isAssigneeTypeValid? lead? leadAccountId? leadUserName? metadata? name? project? projectId? realAssignee? realAssigneeType? self?

Properties

Optionalari

ari?: string

Compass component's ID. Can't be updated. Not required for creating a Project Component.

Optionalassignee

assignee?: User

The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.

OptionalassigneeType

assigneeType?:
    | "PROJECT_LEAD"
    | "UNASSIGNED"
    | "PROJECT_DEFAULT"
    | "COMPONENT_LEAD"

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. Can take 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.

Default value: PROJECT_DEFAULT. Optional when creating or updating a component.

Optionaldescription

description?: string

The description for the component. Optional when creating or updating a component.

Optionalid

id?: string

The unique identifier for the component.

OptionalisAssigneeTypeValid

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.

Optionallead

lead?: User

The user details for the component's lead user.

OptionalleadAccountId

leadAccountId?: string

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

OptionalleadUserName

leadUserName?: string

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

Optionalmetadata

metadata?: {
    [key: string]: string;
}

Compass component's metadata. Can't be updated. Not required for creating a Project Component.

Optionalname

name?: string

The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.

Optionalproject

project?: string

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

OptionalprojectId

projectId?: number

The ID of the project the component is assigned to.

OptionalrealAssignee

realAssignee?: User

The user assigned to issues created with this component, when assigneeType does not identify a valid assignee.

OptionalrealAssigneeType

realAssigneeType?:
    | "PROJECT_LEAD"
    | "UNASSIGNED"
    | "PROJECT_DEFAULT"
    | "COMPONENT_LEAD"

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.

Optionalself

self?: string

The URL of the component.

Settings

Member Visibility

On This Page

Properties