Interface: Issue

Defined in: src/cloud/models/issue.ts:11

Indexable

[key: string]: unknown

Properties

changelog?

optional changelog?: object;

Defined in: src/cloud/models/issue.ts:12

Index Signature

[key: string]: unknown

histories?

optional histories?: object[];

The list of changelogs.

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.

---

editmeta?

optional editmeta?: object;

Defined in: src/cloud/models/issue.ts:13

Index Signature

[key: string]: unknown

fields?

optional fields?: Record<string, {
[key: string]: unknown;
  allowedValues?: unknown[];
  autoCompleteUrl?: string;
  configuration?: Record<string, any>;
  defaultValue?: unknown;
  hasDefaultValue?: boolean;
  key: string;
  name: string;
  operations: string[];
  required: boolean;
  schema?: {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  };
}>;

---

expand?

optional expand?: string;

Defined in: src/cloud/models/issue.ts:15

Expand options that include additional issue details in the response.

---

fields?

optional fields?: IssueFields;

Defined in: src/cloud/models/issue.ts:16

---

fieldsToInclude?

optional fieldsToInclude?: object;

Defined in: src/cloud/models/issue.ts:17

Index Signature

[key: string]: unknown

actuallyIncluded?

optional actuallyIncluded?: string[];

excluded?

optional excluded?: string[];

included?

optional included?: string[];

---

id?

optional id?: string;

Defined in: src/cloud/models/issue.ts:19

The ID of the issue.

---

key?

optional key?: string;

Defined in: src/cloud/models/issue.ts:21

The key of the issue.

---

names?

optional names?: Record<string, string>;

Defined in: src/cloud/models/issue.ts:23

The ID and name of each field present on the issue.

---

operations?

optional operations?: object;

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

Index Signature

[key: string]: unknown

linkGroups?

optional linkGroups?: LinkGroup[];

Details of the link groups defining issue operations.

---

properties?

optional properties?: Record<string, unknown>;

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

Details of the issue properties identified in the request.

---

renderedFields?

optional renderedFields?: Record<string, unknown>;

Defined in: src/cloud/models/issue.ts:28

The rendered value of each field present on the issue.

---

schema?

optional schema?: Record<string, {
[key: string]: unknown;
  configuration?: Record<string, any>;
  custom?: string;
  customId?: number;
  items?: string;
  system?: string;
  type: string;
}>;

Defined in: src/cloud/models/issue.ts:30

The schema describing each field present on the issue.

---

self?

optional self?: string;

Defined in: src/cloud/models/issue.ts:32

The URL of the issue details.

---

transitions?

optional transitions?: object[];

Defined in: src/cloud/models/issue.ts:34

The transitions that can be performed on the issue.

Index Signature

[key: string]: unknown

expand?

optional expand?: string;

Expand options that include additional transition details in the response.

fields?

optional fields?: Record<string, {
[key: string]: unknown;
  allowedValues?: unknown[];
  autoCompleteUrl?: string;
  configuration?: Record<string, any>;
  defaultValue?: unknown;
  hasDefaultValue?: boolean;
  key: string;
  name: string;
  operations: string[];
  required: boolean;
  schema?: {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  };
}>;

Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.

hasScreen?

optional hasScreen?: boolean;

Whether there is a screen associated with the issue transition.

id?

optional id?: string;

The ID of the issue transition. Required when specifying a transition to undertake.

isAvailable?

optional isAvailable?: boolean;

Whether the transition is available to be performed.

isConditional?

optional isConditional?: boolean;

Whether the issue has to meet criteria before the issue transition is applied.

isGlobal?

optional isGlobal?: boolean;

Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.

isInitial?

optional isInitial?: boolean;

Whether this is the initial issue transition for the workflow.

looped?

optional looped?: boolean;

name?

optional name?: string;

The name of the issue transition.

to?

optional to?: object;

Index Signature

[key: string]: unknown

to.description?

optional description?: string;

The description of the status.

to.iconUrl?

optional iconUrl?: string;

The URL of the icon used to represent the status.

to.id?

optional id?: string;

The ID of the status.

to.name?

optional name?: string;

The name of the status.

to.scope?

optional scope?: object;

Index Signature

[key: string]: unknown

to.scope.project?

optional project?: object;

Index Signature

[key: string]: unknown

to.scope.project.avatarUrls?

optional avatarUrls?: object;

Index Signature

[key: ...]: ...

to.scope.project.avatarUrls.16x16?

optional 16x16?: ...;

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

to.scope.project.avatarUrls.24x24?

optional 24x24?: ...;

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

to.scope.project.avatarUrls.32x32?

optional 32x32?: ...;

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

to.scope.project.avatarUrls.48x48?

optional 48x48?: ...;

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

to.scope.project.id?

optional id?: string;

The ID of the project.

to.scope.project.key?

optional key?: string;

The key of the project.

to.scope.project.name?

optional name?: string;

The name of the project.

to.scope.project.projectCategory?

optional projectCategory?: object;

Index Signature

[key: ...]: ...

to.scope.project.projectCategory.description?

optional description?: ...;

The name of the project category.

to.scope.project.projectCategory.id?

optional id?: ...;

The ID of the project category.

to.scope.project.projectCategory.name?

optional name?: ...;

The description of the project category.

to.scope.project.projectCategory.self?

optional self?: ...;

The URL of the project category.

to.scope.project.projectTypeKey?

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

The project type of the project.

to.scope.project.self?

optional self?: string;

The URL of the project details.

to.scope.project.simplified?

optional simplified?: boolean;

Whether or not the project is simplified.

to.scope.type?

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

The type of scope.

to.self?

optional self?: string;

The URL of the status.

to.statusCategory?

optional statusCategory?: object;

Index Signature

[key: string]: unknown

to.statusCategory.colorName?

optional colorName?: string;

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

to.statusCategory.id?

optional id?: number;

The ID of the status category.

to.statusCategory.key?

optional key?: string;

The key of the status category.

to.statusCategory.name?

optional name?: string;

The name of the status category.

to.statusCategory.self?

optional self?: string;

The URL of the status category.

to.untranslatedName?

optional untranslatedName?: string;

---

versionedRepresentations?

optional versionedRepresentations?: Record<string, unknown>;

Defined in: src/cloud/models/issue.ts:36

The versions of each field on the issue.