Interface: IssueFields

Defined in: src/cloud/models/issueFields.ts:24

Indexable

[key: string]: any

Properties

aggregateprogress?

optional aggregateprogress?: object;

Defined in: src/cloud/models/issueFields.ts:87

Index Signature

[key: string]: unknown

percent?

optional percent?: number;

Logged as a share of the total, 0 to 100.

progress?

optional progress?: number;

Seconds logged.

total?

optional total?: number;

Seconds logged plus seconds still estimated.

---

aggregatetimeestimate?

optional aggregatetimeestimate?: number | null;

Defined in: src/cloud/models/issueFields.ts:83

Seconds still estimated on the issue and its subtasks.

---

aggregatetimeoriginalestimate?

optional aggregatetimeoriginalestimate?: number | null;

Defined in: src/cloud/models/issueFields.ts:85

Seconds the issue and its subtasks were first estimated at.

---

aggregatetimespent?

optional aggregatetimespent?: number | null;

Defined in: src/cloud/models/issueFields.ts:81

Seconds logged on the issue and its subtasks.

---

assignee?

optional assignee?: 
  | {
[key: string]: unknown;
  accountId?: string;
  accountType?: string;
  active?: boolean;
  avatarUrls?: {
   [key: string]: unknown;
     16x16?: string;
     24x24?: string;
     32x32?: string;
     48x48?: string;
  };
  displayName?: string;
  emailAddress?: string;
  self?: string;
  timeZone?: string;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:47

Union Members

Type Literal

{
[key: string]: unknown;
  accountId?: string;
  accountType?: string;
  active?: boolean;
  avatarUrls?: {
   [key: string]: unknown;
     16x16?: string;
     24x24?: string;
     32x32?: string;
     48x48?: string;
  };
  displayName?: string;
  emailAddress?: string;
  self?: string;
  timeZone?: string;
}

Index Signature

[key: string]: unknown

accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

active?

optional active?: boolean;

Whether the user is active.

avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

self?

optional self?: string;

The URL of the user.

timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

---

null

---

attachment?

optional attachment?: object[];

Defined in: src/cloud/models/issueFields.ts:70

Index Signature

[key: string]: unknown

author?

optional author?: object;

Index Signature

[key: string]: unknown

author.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

author.accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

author.active?

optional active?: boolean;

Whether the user is active.

author.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

author.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

author.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

author.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

author.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

author.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

author.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

author.self?

optional self?: string;

The URL of the user.

author.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

content?

optional content?: string;

The content of the attachment.

created?

optional created?: Date;

The datetime the attachment was created.

filename?

optional filename?: string;

The file name of the attachment.

id?

optional id?: string;

The ID of the attachment.

mimeType?

optional mimeType?: string;

The MIME type of the attachment.

self?

optional self?: string;

The URL of the attachment details response.

size?

optional size?: number;

The size of the attachment.

thumbnail?

optional thumbnail?: string;

The URL of a thumbnail representing the attachment.

---

comment?

optional comment?: object;

Defined in: src/cloud/models/issueFields.ts:71

Index Signature

[key: string]: unknown

comments?

optional comments?: object[];

The list of comments.

Index Signature

[key: string]: unknown

maxResults?

optional maxResults?: number;

The maximum number of items that could be returned.

self?

optional self?: string;

The URL of the comments of the issue.

startAt?

optional startAt?: number;

The index of the first item returned.

total?

optional total?: number;

The number of items returned.

---

components?

optional components?: object[];

Defined in: src/cloud/models/issueFields.ts:64

Index Signature

[key: string]: unknown

ari?

optional ari?: string;

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

assignee?

optional assignee?: object;

Index Signature

[key: string]: unknown

assignee.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

assignee.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

assignee.active?

optional active?: boolean;

Whether the user is active.

assignee.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

assignee.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

assignee.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

assignee.applicationRoles.max-results?

optional max-results?: number;

assignee.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

assignee.applicationRoles.size?

optional size?: number;

assignee.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

assignee.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

assignee.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

assignee.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

assignee.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

assignee.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

assignee.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

assignee.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

assignee.expand?

optional expand?: string;

Expand options that include additional user details in the response.

assignee.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

assignee.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

assignee.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

assignee.groups.max-results?

optional max-results?: number;

assignee.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

assignee.groups.size?

optional size?: number;

assignee.guest?

optional guest?: boolean;

Whether the user is a guest.

assignee.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

assignee.self?

optional self?: string;

The URL of the user.

assignee.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

assigneeType?

optional assigneeType?: 
  | string & object
  | "PROJECT_DEFAULT"
  | "COMPONENT_LEAD"
  | "PROJECT_LEAD"
  | "UNASSIGNED";

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.

description?

optional description?: string;

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

id?

optional id?: string;

The unique identifier for the component.

isAssigneeTypeValid?

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.

lead?

optional lead?: object;

Index Signature

[key: string]: unknown

lead.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

lead.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

lead.active?

optional active?: boolean;

Whether the user is active.

lead.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

lead.applicationRoles.max-results?

optional max-results?: number;

lead.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.size?

optional size?: number;

lead.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

lead.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

lead.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

lead.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

lead.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

lead.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

lead.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

lead.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

lead.expand?

optional expand?: string;

Expand options that include additional user details in the response.

lead.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

lead.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

lead.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

lead.groups.max-results?

optional max-results?: number;

lead.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

lead.groups.size?

optional size?: number;

lead.guest?

optional guest?: boolean;

Whether the user is a guest.

lead.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

lead.self?

optional self?: string;

The URL of the user.

lead.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

leadAccountId?

optional leadAccountId?: string;

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

metadata?

optional metadata?: Record<string, string>;

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

name?

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.

project?

optional project?: string;

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

projectId?

optional projectId?: number;

The ID of the project the component is assigned to.

realAssignee?

optional realAssignee?: object;

Index Signature

[key: string]: unknown

realAssignee.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

realAssignee.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

realAssignee.active?

optional active?: boolean;

Whether the user is active.

realAssignee.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

realAssignee.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

realAssignee.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

realAssignee.applicationRoles.max-results?

optional max-results?: number;

realAssignee.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

realAssignee.applicationRoles.size?

optional size?: number;

realAssignee.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

realAssignee.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

realAssignee.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

realAssignee.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

realAssignee.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

realAssignee.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

realAssignee.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

realAssignee.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

realAssignee.expand?

optional expand?: string;

Expand options that include additional user details in the response.

realAssignee.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

realAssignee.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

realAssignee.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

realAssignee.groups.max-results?

optional max-results?: number;

realAssignee.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

realAssignee.groups.size?

optional size?: number;

realAssignee.guest?

optional guest?: boolean;

Whether the user is a guest.

realAssignee.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

realAssignee.self?

optional self?: string;

The URL of the user.

realAssignee.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

realAssigneeType?

optional realAssigneeType?: 
  | string & object
  | "PROJECT_DEFAULT"
  | "COMPONENT_LEAD"
  | "PROJECT_LEAD"
  | "UNASSIGNED";

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?

optional self?: string;

The URL of the component.

---

created?

optional created?: Date;

Defined in: src/cloud/models/issueFields.ts:51

When the issue was created.

---

creator?

optional creator?: object;

Defined in: src/cloud/models/issueFields.ts:49

Index Signature

[key: string]: unknown

accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

active?

optional active?: boolean;

Whether the user is active.

avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

self?

optional self?: string;

The URL of the user.

timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

---

description?

optional description?: 
  | string
  | {
[key: string]: unknown;
  content: Record<string, any>[];
  type: string & object | "doc";
  version: number;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:33

A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and Jira stores the document it made of it. One write goes to one endpoint, so description, environment, the comment bodies and the worklog comments in update are all markup or all documents; a multi-line custom field is not looked at and has to be given in the same form as them.

---

duedate?

optional duedate?: string | null;

Defined in: src/cloud/models/issueFields.ts:61

The due date, as YYYY-MM-DD.

---

environment?

optional environment?: 
  | string
  | {
[key: string]: unknown;
  content: Record<string, any>[];
  type: string & object | "doc";
  version: number;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:40

A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and Jira stores the document it made of it. One write goes to one endpoint, so description, environment, the comment bodies and the worklog comments in update are all markup or all documents; a multi-line custom field is not looked at and has to be given in the same form as them.

---

fixVersions?

optional fixVersions?: object[];

Defined in: src/cloud/models/issueFields.ts:65

Index Signature

[key: string]: unknown

approvers?

optional approvers?: object[];

If the expand option approvers is used, returns a list containing the approvers for this version.

Index Signature

[key: string]: unknown

archived?

optional archived?: boolean;

Indicates that the version is archived. Optional when creating or updating a version.

description?

optional description?: string;

The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

driver?

optional driver?: string;

The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver.

expand?

optional expand?: string;

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

• operations Returns the list of operations available for this version.
• issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
• driver Returns the Atlassian account ID of the version driver.
• approvers Returns a list containing approvers for this version.

Optional for create and update.

id?

optional id?: string;

The ID of the version.

issuesStatusForFixVersion?

optional issuesStatusForFixVersion?: object;

Index Signature

[key: string]: unknown

issuesStatusForFixVersion.done?

optional done?: number;

Count of issues with status done.

issuesStatusForFixVersion.inProgress?

optional inProgress?: number;

Count of issues with status in progress.

issuesStatusForFixVersion.toDo?

optional toDo?: number;

Count of issues with status to do.

issuesStatusForFixVersion.unmapped?

optional unmapped?: number;

Count of issues with a status other than to do, in progress, and done.

moveUnfixedIssuesTo?

optional moveUnfixedIssuesTo?: string;

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name?

optional name?: string;

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

operations?

optional operations?: object[];

If the expand option operations is used, returns the list of operations available for this version.

Index Signature

[key: string]: unknown

overdue?

optional overdue?: boolean;

Indicates that the version is overdue.

projectId?

optional projectId?: number;

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

released?

optional released?: boolean;

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

releaseDate?

optional releaseDate?: string;

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

self?

optional self?: string;

The URL of the version.

startDate?

optional startDate?: string;

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate?

optional userReleaseDate?: string;

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDate?

optional userStartDate?: string;

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

---

issuelinks?

optional issuelinks?: object[];

Defined in: src/cloud/models/issueFields.ts:69

Index Signature

[key: string]: unknown

id?

optional id?: string;

The ID of the issue link.

inwardIssue?

optional inwardIssue?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields?

optional fields?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.assignee?

optional assignee?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.assignee.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

inwardIssue.fields.assignee.accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

inwardIssue.fields.assignee.active?

optional active?: boolean;

Whether the user is active.

inwardIssue.fields.assignee.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: ...]: ...

inwardIssue.fields.assignee.avatarUrls.16x16?

optional 16x16?: ...;

The URL of the item's 16x16 pixel avatar.

inwardIssue.fields.assignee.avatarUrls.24x24?

optional 24x24?: ...;

The URL of the item's 24x24 pixel avatar.

inwardIssue.fields.assignee.avatarUrls.32x32?

optional 32x32?: ...;

The URL of the item's 32x32 pixel avatar.

inwardIssue.fields.assignee.avatarUrls.48x48?

optional 48x48?: ...;

The URL of the item's 48x48 pixel avatar.

inwardIssue.fields.assignee.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

inwardIssue.fields.assignee.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

inwardIssue.fields.assignee.self?

optional self?: string;

The URL of the user.

inwardIssue.fields.assignee.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

inwardIssue.fields.issuetype?

optional issuetype?: object;

The type of the linked issue.

Index Signature

[key: string]: unknown

inwardIssue.fields.issuetype.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

inwardIssue.fields.issuetype.description?

optional description?: string;

The description of the issue type.

inwardIssue.fields.issuetype.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

inwardIssue.fields.issuetype.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

inwardIssue.fields.issuetype.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

inwardIssue.fields.issuetype.id?

optional id?: string;

The ID of the issue type.

inwardIssue.fields.issuetype.name?

optional name?: string;

The name of the issue type.

inwardIssue.fields.issuetype.scope?

optional scope?: object;

Index Signature

[key: ...]: ...

inwardIssue.fields.issuetype.scope.project?

optional project?: ...;

inwardIssue.fields.issuetype.scope.type?

optional type?: ...;

The type of scope.

inwardIssue.fields.issuetype.self?

optional self?: string;

The URL of these issue type details.

inwardIssue.fields.issuetype.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

inwardIssue.fields.issuetype.untranslatedName?

optional untranslatedName?: string;

inwardIssue.fields.issueType?

optional issueType?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.issueType.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

inwardIssue.fields.issueType.description?

optional description?: string;

The description of the issue type.

inwardIssue.fields.issueType.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

inwardIssue.fields.issueType.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

inwardIssue.fields.issueType.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

inwardIssue.fields.issueType.id?

optional id?: string;

The ID of the issue type.

inwardIssue.fields.issueType.name?

optional name?: string;

The name of the issue type.

inwardIssue.fields.issueType.scope?

optional scope?: object;

Index Signature

[key: ...]: ...

inwardIssue.fields.issueType.scope.project?

optional project?: ...;

inwardIssue.fields.issueType.scope.type?

optional type?: ...;

The type of scope.

inwardIssue.fields.issueType.self?

optional self?: string;

The URL of these issue type details.

inwardIssue.fields.issueType.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

inwardIssue.fields.issueType.untranslatedName?

optional untranslatedName?: string;

inwardIssue.fields.priority?

optional priority?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.priority.avatarId?

optional avatarId?: number;

The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.

inwardIssue.fields.priority.description?

optional description?: string;

The description of the issue priority.

inwardIssue.fields.priority.iconUrl?

optional iconUrl?: string;

The URL of the icon for the issue priority.

inwardIssue.fields.priority.id?

optional id?: string;

The ID of the issue priority.

inwardIssue.fields.priority.isDefault?

optional isDefault?: boolean;

Whether this priority is the default.

inwardIssue.fields.priority.name?

optional name?: string;

The name of the issue priority.

inwardIssue.fields.priority.schemes?

optional schemes?: object;

Index Signature

[key: ...]: ...

inwardIssue.fields.priority.schemes.maxResults?

optional maxResults?: ...;

inwardIssue.fields.priority.schemes.startAt?

optional startAt?: ...;

inwardIssue.fields.priority.schemes.total?

optional total?: ...;

inwardIssue.fields.priority.self?

optional self?: string;

The URL of the issue priority.

inwardIssue.fields.priority.statusColor?

optional statusColor?: string;

The color used to indicate the issue priority.

inwardIssue.fields.status?

optional status?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.status.description?

optional description?: string;

The description of the status.

inwardIssue.fields.status.iconUrl?

optional iconUrl?: string;

The URL of the icon used to represent the status.

inwardIssue.fields.status.id?

optional id?: string;

The ID of the status.

inwardIssue.fields.status.name?

optional name?: string;

The name of the status.

inwardIssue.fields.status.scope?

optional scope?: object;

Index Signature

[key: ...]: ...

inwardIssue.fields.status.scope.project?

optional project?: ...;

inwardIssue.fields.status.scope.type?

optional type?: ...;

The type of scope.

inwardIssue.fields.status.self?

optional self?: string;

The URL of the status.

inwardIssue.fields.status.statusCategory?

optional statusCategory?: object;

Index Signature

[key: ...]: ...

inwardIssue.fields.status.statusCategory.colorName?

optional colorName?: ...;

The name of the color used to represent the status category.

inwardIssue.fields.status.statusCategory.id?

optional id?: ...;

The ID of the status category.

inwardIssue.fields.status.statusCategory.key?

optional key?: ...;

The key of the status category.

inwardIssue.fields.status.statusCategory.name?

optional name?: ...;

The name of the status category.

inwardIssue.fields.status.statusCategory.self?

optional self?: ...;

The URL of the status category.

inwardIssue.fields.status.untranslatedName?

optional untranslatedName?: string;

inwardIssue.fields.summary?

optional summary?: string;

The summary description of the linked issue.

inwardIssue.fields.timetracking?

optional timetracking?: object;

Index Signature

[key: string]: unknown

inwardIssue.fields.timetracking.originalEstimate?

optional originalEstimate?: string;

The original estimate of time needed for this issue in readable format.

inwardIssue.fields.timetracking.originalEstimateSeconds?

optional originalEstimateSeconds?: number;

The original estimate of time needed for this issue in seconds.

inwardIssue.fields.timetracking.remainingEstimate?

optional remainingEstimate?: string;

The remaining estimate of time needed for this issue in readable format.

inwardIssue.fields.timetracking.remainingEstimateSeconds?

optional remainingEstimateSeconds?: number;

The remaining estimate of time needed for this issue in seconds.

inwardIssue.fields.timetracking.timeSpent?

optional timeSpent?: string;

Time worked on this issue in readable format.

inwardIssue.fields.timetracking.timeSpentSeconds?

optional timeSpentSeconds?: number;

Time worked on this issue in seconds.

inwardIssue.id?

optional id?: string;

The ID of an issue. Required if key isn't provided.

inwardIssue.key?

optional key?: string;

The key of an issue. Required if id isn't provided.

inwardIssue.self?

optional self?: string;

The URL of the issue.

outwardIssue?

optional outwardIssue?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields?

optional fields?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.assignee?

optional assignee?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.assignee.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

outwardIssue.fields.assignee.accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

outwardIssue.fields.assignee.active?

optional active?: boolean;

Whether the user is active.

outwardIssue.fields.assignee.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: ...]: ...

outwardIssue.fields.assignee.avatarUrls.16x16?

optional 16x16?: ...;

The URL of the item's 16x16 pixel avatar.

outwardIssue.fields.assignee.avatarUrls.24x24?

optional 24x24?: ...;

The URL of the item's 24x24 pixel avatar.

outwardIssue.fields.assignee.avatarUrls.32x32?

optional 32x32?: ...;

The URL of the item's 32x32 pixel avatar.

outwardIssue.fields.assignee.avatarUrls.48x48?

optional 48x48?: ...;

The URL of the item's 48x48 pixel avatar.

outwardIssue.fields.assignee.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

outwardIssue.fields.assignee.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

outwardIssue.fields.assignee.self?

optional self?: string;

The URL of the user.

outwardIssue.fields.assignee.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

outwardIssue.fields.issuetype?

optional issuetype?: object;

The type of the linked issue.

Index Signature

[key: string]: unknown

outwardIssue.fields.issuetype.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

outwardIssue.fields.issuetype.description?

optional description?: string;

The description of the issue type.

outwardIssue.fields.issuetype.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

outwardIssue.fields.issuetype.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

outwardIssue.fields.issuetype.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

outwardIssue.fields.issuetype.id?

optional id?: string;

The ID of the issue type.

outwardIssue.fields.issuetype.name?

optional name?: string;

The name of the issue type.

outwardIssue.fields.issuetype.scope?

optional scope?: object;

Index Signature

[key: ...]: ...

outwardIssue.fields.issuetype.scope.project?

optional project?: ...;

outwardIssue.fields.issuetype.scope.type?

optional type?: ...;

The type of scope.

outwardIssue.fields.issuetype.self?

optional self?: string;

The URL of these issue type details.

outwardIssue.fields.issuetype.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

outwardIssue.fields.issuetype.untranslatedName?

optional untranslatedName?: string;

outwardIssue.fields.issueType?

optional issueType?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.issueType.avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

outwardIssue.fields.issueType.description?

optional description?: string;

The description of the issue type.

outwardIssue.fields.issueType.entityId?

optional entityId?: string;

Unique ID for next-gen projects.

outwardIssue.fields.issueType.hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

outwardIssue.fields.issueType.iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

outwardIssue.fields.issueType.id?

optional id?: string;

The ID of the issue type.

outwardIssue.fields.issueType.name?

optional name?: string;

The name of the issue type.

outwardIssue.fields.issueType.scope?

optional scope?: object;

Index Signature

[key: ...]: ...

outwardIssue.fields.issueType.scope.project?

optional project?: ...;

outwardIssue.fields.issueType.scope.type?

optional type?: ...;

The type of scope.

outwardIssue.fields.issueType.self?

optional self?: string;

The URL of these issue type details.

outwardIssue.fields.issueType.subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

outwardIssue.fields.issueType.untranslatedName?

optional untranslatedName?: string;

outwardIssue.fields.priority?

optional priority?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.priority.avatarId?

optional avatarId?: number;

The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.

outwardIssue.fields.priority.description?

optional description?: string;

The description of the issue priority.

outwardIssue.fields.priority.iconUrl?

optional iconUrl?: string;

The URL of the icon for the issue priority.

outwardIssue.fields.priority.id?

optional id?: string;

The ID of the issue priority.

outwardIssue.fields.priority.isDefault?

optional isDefault?: boolean;

Whether this priority is the default.

outwardIssue.fields.priority.name?

optional name?: string;

The name of the issue priority.

outwardIssue.fields.priority.schemes?

optional schemes?: object;

Index Signature

[key: ...]: ...

outwardIssue.fields.priority.schemes.maxResults?

optional maxResults?: ...;

outwardIssue.fields.priority.schemes.startAt?

optional startAt?: ...;

outwardIssue.fields.priority.schemes.total?

optional total?: ...;

outwardIssue.fields.priority.self?

optional self?: string;

The URL of the issue priority.

outwardIssue.fields.priority.statusColor?

optional statusColor?: string;

The color used to indicate the issue priority.

outwardIssue.fields.status?

optional status?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.status.description?

optional description?: string;

The description of the status.

outwardIssue.fields.status.iconUrl?

optional iconUrl?: string;

The URL of the icon used to represent the status.

outwardIssue.fields.status.id?

optional id?: string;

The ID of the status.

outwardIssue.fields.status.name?

optional name?: string;

The name of the status.

outwardIssue.fields.status.scope?

optional scope?: object;

Index Signature

[key: ...]: ...

outwardIssue.fields.status.scope.project?

optional project?: ...;

outwardIssue.fields.status.scope.type?

optional type?: ...;

The type of scope.

outwardIssue.fields.status.self?

optional self?: string;

The URL of the status.

outwardIssue.fields.status.statusCategory?

optional statusCategory?: object;

Index Signature

[key: ...]: ...

outwardIssue.fields.status.statusCategory.colorName?

optional colorName?: ...;

The name of the color used to represent the status category.

outwardIssue.fields.status.statusCategory.id?

optional id?: ...;

The ID of the status category.

outwardIssue.fields.status.statusCategory.key?

optional key?: ...;

The key of the status category.

outwardIssue.fields.status.statusCategory.name?

optional name?: ...;

The name of the status category.

outwardIssue.fields.status.statusCategory.self?

optional self?: ...;

The URL of the status category.

outwardIssue.fields.status.untranslatedName?

optional untranslatedName?: string;

outwardIssue.fields.summary?

optional summary?: string;

The summary description of the linked issue.

outwardIssue.fields.timetracking?

optional timetracking?: object;

Index Signature

[key: string]: unknown

outwardIssue.fields.timetracking.originalEstimate?

optional originalEstimate?: string;

The original estimate of time needed for this issue in readable format.

outwardIssue.fields.timetracking.originalEstimateSeconds?

optional originalEstimateSeconds?: number;

The original estimate of time needed for this issue in seconds.

outwardIssue.fields.timetracking.remainingEstimate?

optional remainingEstimate?: string;

The remaining estimate of time needed for this issue in readable format.

outwardIssue.fields.timetracking.remainingEstimateSeconds?

optional remainingEstimateSeconds?: number;

The remaining estimate of time needed for this issue in seconds.

outwardIssue.fields.timetracking.timeSpent?

optional timeSpent?: string;

Time worked on this issue in readable format.

outwardIssue.fields.timetracking.timeSpentSeconds?

optional timeSpentSeconds?: number;

Time worked on this issue in seconds.

outwardIssue.id?

optional id?: string;

The ID of an issue. Required if key isn't provided.

outwardIssue.key?

optional key?: string;

The key of an issue. Required if id isn't provided.

outwardIssue.self?

optional self?: string;

The URL of the issue.

self?

optional self?: string;

The URL of the issue link.

type?

optional type?: object;

Index Signature

[key: string]: unknown

type.id?

optional id?: string;

The ID of the issue link type and is used as follows:

• In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only.
• In the issueLinkType resource it is read only.

type.inward?

optional inward?: string;

The description of the issue link type inward link and is used as follows:

• In the issueLink resource it is read only.
• In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

type.name?

optional name?: string;

The name of the issue link type and is used as follows:

• In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only.
• In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

type.outward?

optional outward?: string;

The description of the issue link type outward link and is used as follows:

• In the issueLink resource it is read only.
• In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

type.self?

optional self?: string;

The URL of the issue link type. Read only.

---

issuetype?

optional issuetype?: object;

Defined in: src/cloud/models/issueFields.ts:41

Index Signature

[key: string]: unknown

avatarId?

optional avatarId?: number;

The ID of the issue type's avatar.

description?

optional description?: string;

The description of the issue type.

entityId?

optional entityId?: string;

Unique ID for next-gen projects.

hierarchyLevel?

optional hierarchyLevel?: number;

Hierarchy level of the issue type.

iconUrl?

optional iconUrl?: string;

The URL of the issue type's avatar.

id?

optional id?: string;

The ID of the issue type.

name?

optional name?: string;

The name of the issue type.

scope?

optional scope?: object;

Index Signature

[key: string]: unknown

scope.project?

optional project?: object;

Index Signature

[key: string]: unknown

scope.project.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

scope.project.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

scope.project.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

scope.project.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

scope.project.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

scope.project.id?

optional id?: string;

The ID of the project.

scope.project.key?

optional key?: string;

The key of the project.

scope.project.name?

optional name?: string;

The name of the project.

scope.project.projectCategory?

optional projectCategory?: object;

Index Signature

[key: string]: unknown

scope.project.projectCategory.description?

optional description?: string;

The name of the project category.

scope.project.projectCategory.id?

optional id?: string;

The ID of the project category.

scope.project.projectCategory.name?

optional name?: string;

The description of the project category.

scope.project.projectCategory.self?

optional self?: string;

The URL of the project category.

scope.project.projectTypeKey?

optional projectTypeKey?: 
  | string & object
  | "software"
  | "service_desk"
  | "business"
  | "product_discovery"
  | "customer_service";

The project type of the project.

scope.project.self?

optional self?: string;

The URL of the project details.

scope.project.simplified?

optional simplified?: boolean;

Whether or not the project is simplified.

scope.type?

optional type?: string & object | "PROJECT" | "TEMPLATE";

The type of scope.

self?

optional self?: string;

The URL of these issue type details.

subtask?

optional subtask?: boolean;

Whether this issue type is used to create subtasks.

untranslatedName?

optional untranslatedName?: string;

---

labels?

optional labels?: string[];

Defined in: src/cloud/models/issueFields.ts:63

The labels on the issue.

---

lastViewed?

optional lastViewed?: Date | null;

Defined in: src/cloud/models/issueFields.ts:59

When the current user last opened the issue.

---

parent?

optional parent?: Issue;

Defined in: src/cloud/models/issueFields.ts:67

---

priority?

optional priority?: 
  | {
[key: string]: unknown;
  avatarId?: number;
  description?: string;
  iconUrl?: string;
  id?: string;
  isDefault?: boolean;
  name?: string;
  schemes?: {
   [key: string]: unknown;
     maxResults?: number;
     startAt?: number;
     total?: number;
  };
  self?: string;
  statusColor?: string;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:45

Union Members

Type Literal

{
[key: string]: unknown;
  avatarId?: number;
  description?: string;
  iconUrl?: string;
  id?: string;
  isDefault?: boolean;
  name?: string;
  schemes?: {
   [key: string]: unknown;
     maxResults?: number;
     startAt?: number;
     total?: number;
  };
  self?: string;
  statusColor?: string;
}

Index Signature

[key: string]: unknown

avatarId?

optional avatarId?: number;

The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.

description?

optional description?: string;

The description of the issue priority.

iconUrl?

optional iconUrl?: string;

The URL of the icon for the issue priority.

id?

optional id?: string;

The ID of the issue priority.

isDefault?

optional isDefault?: boolean;

Whether this priority is the default.

name?

optional name?: string;

The name of the issue priority.

schemes?

optional schemes?: object;

Index Signature

[key: string]: unknown

schemes.maxResults?

optional maxResults?: number;

schemes.startAt?

optional startAt?: number;

schemes.total?

optional total?: number;

self?

optional self?: string;

The URL of the issue priority.

statusColor?

optional statusColor?: string;

The color used to indicate the issue priority.

---

null

---

progress?

optional progress?: object;

Defined in: src/cloud/models/issueFields.ts:86

Index Signature

[key: string]: unknown

percent?

optional percent?: number;

Logged as a share of the total, 0 to 100.

progress?

optional progress?: number;

Seconds logged.

total?

optional total?: number;

Seconds logged plus seconds still estimated.

---

project?

optional project?: object;

Defined in: src/cloud/models/issueFields.ts:42

Index Signature

[key: string]: unknown

archived?

optional archived?: boolean;

Whether the project is archived.

archivedBy?

optional archivedBy?: object;

Index Signature

[key: string]: unknown

archivedBy.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

archivedBy.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

archivedBy.active?

optional active?: boolean;

Whether the user is active.

archivedBy.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.max-results?

optional max-results?: number;

archivedBy.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

archivedBy.applicationRoles.size?

optional size?: number;

archivedBy.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

archivedBy.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

archivedBy.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

archivedBy.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

archivedBy.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

archivedBy.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

archivedBy.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

archivedBy.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

archivedBy.expand?

optional expand?: string;

Expand options that include additional user details in the response.

archivedBy.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

archivedBy.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

archivedBy.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

archivedBy.groups.max-results?

optional max-results?: number;

archivedBy.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

archivedBy.groups.size?

optional size?: number;

archivedBy.guest?

optional guest?: boolean;

Whether the user is a guest.

archivedBy.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

archivedBy.self?

optional self?: string;

The URL of the user.

archivedBy.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

archivedDate?

optional archivedDate?: Date;

The date when the project was archived.

assigneeType?

optional assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED";

The default assignee when creating issues for this project.

avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

components?

optional components?: object[];

List of the components contained in the project.

Index Signature

[key: string]: unknown

deleted?

optional deleted?: boolean;

Whether the project is marked as deleted.

deletedBy?

optional deletedBy?: object;

Index Signature

[key: string]: unknown

deletedBy.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

deletedBy.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

deletedBy.active?

optional active?: boolean;

Whether the user is active.

deletedBy.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.max-results?

optional max-results?: number;

deletedBy.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

deletedBy.applicationRoles.size?

optional size?: number;

deletedBy.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

deletedBy.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

deletedBy.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

deletedBy.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

deletedBy.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

deletedBy.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

deletedBy.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

deletedBy.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

deletedBy.expand?

optional expand?: string;

Expand options that include additional user details in the response.

deletedBy.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

deletedBy.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

deletedBy.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

deletedBy.groups.max-results?

optional max-results?: number;

deletedBy.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

deletedBy.groups.size?

optional size?: number;

deletedBy.guest?

optional guest?: boolean;

Whether the user is a guest.

deletedBy.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

deletedBy.self?

optional self?: string;

The URL of the user.

deletedBy.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

deletedDate?

optional deletedDate?: Date;

The date when the project was marked as deleted.

description?

optional description?: string;

A brief description of the project.

email?

optional email?: string;

An email address associated with the project.

entityId?

optional entityId?: string;

expand?

optional expand?: string;

Expand options that include additional project details in the response.

favourite?

optional favourite?: boolean;

Whether the project is selected as a favorite.

id?

optional id?: string;

The ID of the project.

insight?

optional insight?: object;

Index Signature

[key: string]: unknown

insight.lastIssueUpdateTime?

optional lastIssueUpdateTime?: Date;

The last issue update time.

insight.totalIssueCount?

optional totalIssueCount?: number;

Total issue count.

isPrivate?

optional isPrivate?: boolean;

Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues.

issueTypeHierarchy?

optional issueTypeHierarchy?: object;

Index Signature

[key: string]: unknown

issueTypeHierarchy.levels?

optional levels?: object[];

Details about the hierarchy level.

Index Signature

[key: string]: unknown

issueTypes?

optional issueTypes?: object[];

List of the issue types available in the project.

Index Signature

[key: string]: unknown

key?

optional key?: string;

The key of the project.

landingPageInfo?

optional landingPageInfo?: object;

Index Signature

[key: string]: unknown

landingPageInfo.attributes?

optional attributes?: Record<string, string>;

landingPageInfo.boardId?

optional boardId?: number;

landingPageInfo.boardName?

optional boardName?: string;

landingPageInfo.projectKey?

optional projectKey?: string;

landingPageInfo.projectType?

optional projectType?: string;

landingPageInfo.queueCategory?

optional queueCategory?: string;

landingPageInfo.queueId?

optional queueId?: number;

landingPageInfo.queueName?

optional queueName?: string;

landingPageInfo.simpleBoard?

optional simpleBoard?: boolean;

landingPageInfo.simplified?

optional simplified?: boolean;

landingPageInfo.url?

optional url?: string;

lead?

optional lead?: object;

Index Signature

[key: string]: unknown

lead.accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

lead.accountType?

optional accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";

The user account type. Can take the following values:

• atlassian regular Atlassian user account
• app system account used for Connect applications and OAuth to represent external systems
• customer Jira Service Desk account representing an external service desk

lead.active?

optional active?: boolean;

Whether the user is active.

lead.applicationRoles?

optional applicationRoles?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.items?

optional items?: object[];

Index Signature

[key: string]: unknown

lead.applicationRoles.max-results?

optional max-results?: number;

lead.applicationRoles.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

lead.applicationRoles.size?

optional size?: number;

lead.appType?

optional appType?: string;

The app type of the user account when accountType is 'app'. Can take the following values:

• service Service Account
• agent Rovo Agent Account
• unknown Unknown app type

lead.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

lead.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

lead.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

lead.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

lead.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

lead.displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

lead.emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

lead.expand?

optional expand?: string;

Expand options that include additional user details in the response.

lead.groups?

optional groups?: object;

Index Signature

[key: string]: unknown

lead.groups.callback?

optional callback?: object;

Index Signature

[key: string]: unknown

lead.groups.items?

optional items?: object[];

Index Signature

[key: string]: unknown

lead.groups.max-results?

optional max-results?: number;

lead.groups.pagingCallback?

optional pagingCallback?: object;

Index Signature

[key: string]: unknown

lead.groups.size?

optional size?: number;

lead.guest?

optional guest?: boolean;

Whether the user is a guest.

lead.locale?

optional locale?: string;

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

lead.self?

optional self?: string;

The URL of the user.

lead.timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

name?

optional name?: string;

The name of the project.

permissions?

optional permissions?: object;

Index Signature

[key: string]: unknown

permissions.canEdit?

optional canEdit?: boolean;

Whether the logged user can edit the project.

projectCategory?

optional projectCategory?: object;

Index Signature

[key: string]: unknown

projectCategory.description?

optional description?: string;

The description of the project category.

projectCategory.id?

optional id?: string;

The ID of the project category.

projectCategory.name?

optional name?: string;

The name of the project category. Required on create, optional on update.

projectCategory.self?

optional self?: string;

The URL of the project category.

projectTypeKey?

optional projectTypeKey?: 
  | string & object
  | "software"
  | "service_desk"
  | "business"
  | "product_discovery"
  | "customer_service";

The project type of the project.

properties?

optional properties?: Record<string, any>;

Map of project properties. Only the properties named in the request's properties query parameter are returned, so this is an empty object when that parameter is omitted.

retentionTillDate?

optional retentionTillDate?: Date;

The date when the project is deleted permanently.

roles?

optional roles?: Record<string, string>;

The name and self URL for each role defined in the project. For more information, see Create project role.

self?

optional self?: string;

The URL of the project details.

simplified?

optional simplified?: boolean;

Whether the project is simplified.

style?

optional style?: "classic" | string & object | "next-gen";

The type of the project.

url?

optional url?: string;

A link to information about this project, such as project documentation.

uuid?

optional uuid?: string;

Unique ID for next-gen projects.

versions?

optional versions?: object[];

The versions defined in the project. For more information, see Create version.

Index Signature

[key: string]: unknown

---

reporter?

optional reporter?: 
  | {
[key: string]: unknown;
  accountId?: string;
  accountType?: string;
  active?: boolean;
  avatarUrls?: {
   [key: string]: unknown;
     16x16?: string;
     24x24?: string;
     32x32?: string;
     48x48?: string;
  };
  displayName?: string;
  emailAddress?: string;
  self?: string;
  timeZone?: string;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:48

Union Members

Type Literal

{
[key: string]: unknown;
  accountId?: string;
  accountType?: string;
  active?: boolean;
  avatarUrls?: {
   [key: string]: unknown;
     16x16?: string;
     24x24?: string;
     32x32?: string;
     48x48?: string;
  };
  displayName?: string;
  emailAddress?: string;
  self?: string;
  timeZone?: string;
}

Index Signature

[key: string]: unknown

accountId?

optional accountId?: string;

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

accountType?

optional accountType?: string;

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

active?

optional active?: boolean;

Whether the user is active.

avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

displayName?

optional displayName?: string;

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

emailAddress?

optional emailAddress?: string;

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

self?

optional self?: string;

The URL of the user.

timeZone?

optional timeZone?: string;

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

---

null

---

resolution?

optional resolution?: 
  | {
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:46

Union Members

Type Literal

{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}

Index Signature

[key: string]: unknown

description?

optional description?: string;

The description of the issue resolution.

id?

optional id?: string;

The ID of the issue resolution.

name?

optional name?: string;

The name of the issue resolution.

self?

optional self?: string;

The URL of the issue resolution.

---

null

---

resolutiondate?

optional resolutiondate?: Date | null;

Defined in: src/cloud/models/issueFields.ts:55

When the issue was resolved.

---

security?

optional security?: 
  | {
[key: string]: unknown;
  description?: string;
  id?: string;
  isDefault?: boolean;
  issueSecuritySchemeId?: string;
  name?: string;
  self?: string;
}
  | null;

Defined in: src/cloud/models/issueFields.ts:92

Union Members

Type Literal

{
[key: string]: unknown;
  description?: string;
  id?: string;
  isDefault?: boolean;
  issueSecuritySchemeId?: string;
  name?: string;
  self?: string;
}

Index Signature

[key: string]: unknown

description?

optional description?: string;

The description of the issue level security item.

id?

optional id?: string;

The ID of the issue level security item.

isDefault?

optional isDefault?: boolean;

Whether the issue level security item is the default.

issueSecuritySchemeId?

optional issueSecuritySchemeId?: string;

The ID of the issue level security scheme.

name?

optional name?: string;

The name of the issue level security item.

self?

optional self?: string;

The URL of the issue level security item.

---

null

---

status?

optional status?: object;

Defined in: src/cloud/models/issueFields.ts:43

Index Signature

[key: string]: unknown

description?

optional description?: string;

The description of the status.

iconUrl?

optional iconUrl?: string;

The URL of the icon used to represent the status.

id?

optional id?: string;

The ID of the status.

name?

optional name?: string;

The name of the status.

scope?

optional scope?: object;

Index Signature

[key: string]: unknown

scope.project?

optional project?: object;

Index Signature

[key: string]: unknown

scope.project.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: string]: unknown

scope.project.avatarUrls.16x16?

optional 16x16?: string;

The URL of the item's 16x16 pixel avatar.

scope.project.avatarUrls.24x24?

optional 24x24?: string;

The URL of the item's 24x24 pixel avatar.

scope.project.avatarUrls.32x32?

optional 32x32?: string;

The URL of the item's 32x32 pixel avatar.

scope.project.avatarUrls.48x48?

optional 48x48?: string;

The URL of the item's 48x48 pixel avatar.

scope.project.id?

optional id?: string;

The ID of the project.

scope.project.key?

optional key?: string;

The key of the project.

scope.project.name?

optional name?: string;

The name of the project.

scope.project.projectCategory?

optional projectCategory?: object;

Index Signature

[key: string]: unknown

scope.project.projectCategory.description?

optional description?: string;

The name of the project category.

scope.project.projectCategory.id?

optional id?: string;

The ID of the project category.

scope.project.projectCategory.name?

optional name?: string;

The description of the project category.

scope.project.projectCategory.self?

optional self?: string;

The URL of the project category.

scope.project.projectTypeKey?

optional projectTypeKey?: 
  | string & object
  | "software"
  | "service_desk"
  | "business"
  | "product_discovery"
  | "customer_service";

The project type of the project.

scope.project.self?

optional self?: string;

The URL of the project details.

scope.project.simplified?

optional simplified?: boolean;

Whether or not the project is simplified.

scope.type?

optional type?: string & object | "PROJECT" | "TEMPLATE";

The type of scope.

self?

optional self?: string;

The URL of the status.

statusCategory?

optional statusCategory?: object;

Index Signature

[key: string]: unknown

statusCategory.colorName?

optional colorName?: string;

The name of the color used to represent the status category.

statusCategory.id?

optional id?: number;

The ID of the status category.

statusCategory.key?

optional key?: string;

The key of the status category.

statusCategory.name?

optional name?: string;

The name of the status category.

statusCategory.self?

optional self?: string;

The URL of the status category.

untranslatedName?

optional untranslatedName?: string;

---

statusCategory?

optional statusCategory?: object;

Defined in: src/cloud/models/issueFields.ts:44

Index Signature

[key: string]: unknown

colorName?

optional colorName?: string;

The name of the color used to represent the status category.

id?

optional id?: number;

The ID of the status category.

key?

optional key?: string;

The key of the status category.

name?

optional name?: string;

The name of the status category.

self?

optional self?: string;

The URL of the status category.

---

statuscategorychangedate?

optional statuscategorychangedate?: Date;

Defined in: src/cloud/models/issueFields.ts:57

When the issue last moved between status categories.

---

subtasks?

optional subtasks?: Issue[];

Defined in: src/cloud/models/issueFields.ts:68

---

summary?

optional summary?: string;

Defined in: src/cloud/models/issueFields.ts:26

The one-line title.

---

timeestimate?

optional timeestimate?: number | null;

Defined in: src/cloud/models/issueFields.ts:77

Seconds still estimated on the issue.

---

timeoriginalestimate?

optional timeoriginalestimate?: number | null;

Defined in: src/cloud/models/issueFields.ts:79

Seconds the issue was first estimated at.

---

timespent?

optional timespent?: number | null;

Defined in: src/cloud/models/issueFields.ts:75

Seconds logged on the issue.

---

timetracking?

optional timetracking?: object;

Defined in: src/cloud/models/issueFields.ts:73

Index Signature

[key: string]: unknown

originalEstimate?

optional originalEstimate?: string;

The original estimate of time needed for this issue in readable format.

originalEstimateSeconds?

optional originalEstimateSeconds?: number;

The original estimate of time needed for this issue in seconds.

remainingEstimate?

optional remainingEstimate?: string;

The remaining estimate of time needed for this issue in readable format.

remainingEstimateSeconds?

optional remainingEstimateSeconds?: number;

The remaining estimate of time needed for this issue in seconds.

timeSpent?

optional timeSpent?: string;

Time worked on this issue in readable format.

timeSpentSeconds?

optional timeSpentSeconds?: number;

Time worked on this issue in seconds.

---

updated?

optional updated?: Date;

Defined in: src/cloud/models/issueFields.ts:53

When the issue last changed.

---

versions?

optional versions?: object[];

Defined in: src/cloud/models/issueFields.ts:66

Index Signature

[key: string]: unknown

approvers?

optional approvers?: object[];

If the expand option approvers is used, returns a list containing the approvers for this version.

Index Signature

[key: string]: unknown

archived?

optional archived?: boolean;

Indicates that the version is archived. Optional when creating or updating a version.

description?

optional description?: string;

The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

driver?

optional driver?: string;

The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option driver is used, returns the Atlassian account ID of the driver.

expand?

optional expand?: string;

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

• operations Returns the list of operations available for this version.
• issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
• driver Returns the Atlassian account ID of the version driver.
• approvers Returns a list containing approvers for this version.

Optional for create and update.

id?

optional id?: string;

The ID of the version.

issuesStatusForFixVersion?

optional issuesStatusForFixVersion?: object;

Index Signature

[key: string]: unknown

issuesStatusForFixVersion.done?

optional done?: number;

Count of issues with status done.

issuesStatusForFixVersion.inProgress?

optional inProgress?: number;

Count of issues with status in progress.

issuesStatusForFixVersion.toDo?

optional toDo?: number;

Count of issues with status to do.

issuesStatusForFixVersion.unmapped?

optional unmapped?: number;

Count of issues with a status other than to do, in progress, and done.

moveUnfixedIssuesTo?

optional moveUnfixedIssuesTo?: string;

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name?

optional name?: string;

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

operations?

optional operations?: object[];

If the expand option operations is used, returns the list of operations available for this version.

Index Signature

[key: string]: unknown

overdue?

optional overdue?: boolean;

Indicates that the version is overdue.

projectId?

optional projectId?: number;

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

released?

optional released?: boolean;

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

releaseDate?

optional releaseDate?: string;

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

self?

optional self?: string;

The URL of the version.

startDate?

optional startDate?: string;

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate?

optional userReleaseDate?: string;

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDate?

optional userStartDate?: string;

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

---

votes?

optional votes?: object;

Defined in: src/cloud/models/issueFields.ts:90

Index Signature

[key: string]: unknown

hasVoted?

optional hasVoted?: boolean;

Whether the user making this request has voted on the issue.

self?

optional self?: string;

The URL of these issue vote details.

voters?

optional voters?: object[];

List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the View voters and watchers project permission.

Index Signature

[key: string]: unknown

votes?

optional votes?: number;

The number of votes on the issue.

---

watches?

optional watches?: object;

Defined in: src/cloud/models/issueFields.ts:91

Index Signature

[key: string]: unknown

isWatching?

optional isWatching?: boolean;

Whether the calling user is watching this issue.

self?

optional self?: string;

The URL of these issue watcher details.

watchCount?

optional watchCount?: number;

The number of users watching this issue.

watchers?

optional watchers?: object[];

Details of the users watching this issue.

Index Signature

[key: string]: unknown

---

worklog?

optional worklog?: object;

Defined in: src/cloud/models/issueFields.ts:72

Index Signature

[key: string]: unknown

maxResults?

optional maxResults?: number;

The maximum number of results that could be on the page.

startAt?

optional startAt?: number;

The index of the first item returned on the page.

total?

optional total?: number;

The number of results on the page.

worklogs?

optional worklogs?: object[];

List of worklogs.

Index Signature

[key: string]: unknown

---

workratio?

optional workratio?: number;

Defined in: src/cloud/models/issueFields.ts:89

Time spent as a percentage of the original estimate, or -1 where nothing was estimated.