Skip to content

Latest commit

 

History

History
37 lines (34 loc) · 4.45 KB

Component.md

File metadata and controls

37 lines (34 loc) · 4.45 KB

Component

Properties

Name Type Description Notes
self String The URL of the component. [optional]
id String The unique identifier for the component. [optional]
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. [optional]
description String The description for the component. Optional when creating or updating a component. [optional]
lead AllOfComponentLead The user details for the component's lead user. [optional]
leadUserName String This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. [optional]
leadAccountId String The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. [optional]
assigneeType AssigneeTypeEnum 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. [optional]
assignee AllOfComponentAssignee The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component. [optional]
realAssigneeType RealAssigneeTypeEnum 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 `assignee`Type 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. [optional]
realAssignee AllOfComponentRealAssignee The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. [optional]
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. [optional]
project String The key of the project the component is assigned to. Required when creating a component. Can't be updated. [optional]
projectId Long The ID of the project the component is assigned to. [optional]

Enum: AssigneeTypeEnum

Name Value
PROJECT_DEFAULT "PROJECT_DEFAULT"
COMPONENT_LEAD "COMPONENT_LEAD"
PROJECT_LEAD "PROJECT_LEAD"
UNASSIGNED "UNASSIGNED"

Enum: RealAssigneeTypeEnum

Name Value
PROJECT_DEFAULT "PROJECT_DEFAULT"
COMPONENT_LEAD "COMPONENT_LEAD"
PROJECT_LEAD "PROJECT_LEAD"
UNASSIGNED "UNASSIGNED"