Skip to content

Interface: IssueInput ​

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

Properties ​

changelog? ​

ts
optional changelog?: object;

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

histories? ​

ts
optional histories?: object[];

The list of changelogs.

maxResults? ​

ts
optional maxResults?: number;

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

startAt? ​

ts
optional startAt?: number;

The index of the first item returned on the page.

total? ​

ts
optional total?: number;

The number of results on the page.


editmeta? ​

ts
optional editmeta?: object;

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

fields? ​

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

expand? ​

ts
optional expand?: string;

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

Expand options that include additional issue details in the response.


fields? ​

ts
optional fields?: IssueFieldsInput;

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


fieldsToInclude? ​

ts
optional fieldsToInclude?: object;

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

actuallyIncluded? ​

ts
optional actuallyIncluded?: string[];

excluded? ​

ts
optional excluded?: string[];

included? ​

ts
optional included?: string[];

id? ​

ts
optional id?: string;

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

The ID of the issue.


key? ​

ts
optional key?: string;

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

The key of the issue.


names? ​

ts
optional names?: Record<string, string>;

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

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


operations? ​

ts
optional operations?: object;

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

linkGroups? ​

ts
optional linkGroups?: LinkGroupInput[];

Details of the link groups defining issue operations.


properties? ​

ts
optional properties?: Record<string, unknown>;

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

Details of the issue properties identified in the request.


renderedFields? ​

ts
optional renderedFields?: Record<string, unknown>;

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

The rendered value of each field present on the issue.


schema? ​

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

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

The schema describing each field present on the issue.


self? ​

ts
optional self?: string;

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

The URL of the issue details.


transitions? ​

ts
optional transitions?: object[];

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

The transitions that can be performed on the issue.

expand? ​

ts
optional expand?: string;

Expand options that include additional transition details in the response.

fields? ​

ts
optional fields?: Record<string, {
  allowedValues?: unknown[];
  autoCompleteUrl?: string;
  configuration?: Record<string, any>;
  defaultValue?: unknown;
  hasDefaultValue?: boolean;
  key: string;
  name: string;
  operations: string[];
  required: boolean;
  schema?: {
     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? ​

ts
optional hasScreen?: boolean;

Whether there is a screen associated with the issue transition.

id? ​

ts
optional id?: string;

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

isAvailable? ​

ts
optional isAvailable?: boolean;

Whether the transition is available to be performed.

isConditional? ​

ts
optional isConditional?: boolean;

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

isGlobal? ​

ts
optional isGlobal?: boolean;

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

isInitial? ​

ts
optional isInitial?: boolean;

Whether this is the initial issue transition for the workflow.

looped? ​

ts
optional looped?: boolean;

name? ​

ts
optional name?: string;

The name of the issue transition.

to? ​

ts
optional to?: object;
to.description? ​
ts
optional description?: string;

The description of the status.

to.iconUrl? ​
ts
optional iconUrl?: string;

The URL of the icon used to represent the status.

to.id? ​
ts
optional id?: string;

The ID of the status.

to.name? ​
ts
optional name?: string;

The name of the status.

to.scope? ​
ts
optional scope?: object;
to.scope.project? ​
ts
optional project?: object;
to.scope.project.avatarUrls? ​
ts
optional avatarUrls?: object;
to.scope.project.avatarUrls.16x16? ​
ts
optional 16x16?: ...;

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

to.scope.project.avatarUrls.24x24? ​
ts
optional 24x24?: ...;

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

to.scope.project.avatarUrls.32x32? ​
ts
optional 32x32?: ...;

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

to.scope.project.avatarUrls.48x48? ​
ts
optional 48x48?: ...;

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

to.scope.project.id? ​
ts
optional id?: string;

The ID of the project.

to.scope.project.key? ​
ts
optional key?: string;

The key of the project.

to.scope.project.name? ​
ts
optional name?: string;

The name of the project.

to.scope.project.projectCategory? ​
ts
optional projectCategory?: object;
to.scope.project.projectCategory.description? ​
ts
optional description?: ...;

The name of the project category.

to.scope.project.projectCategory.id? ​
ts
optional id?: ...;

The ID of the project category.

to.scope.project.projectCategory.name? ​
ts
optional name?: ...;

The description of the project category.

to.scope.project.projectCategory.self? ​
ts
optional self?: ...;

The URL of the project category.

to.scope.project.projectTypeKey? ​
ts
optional projectTypeKey?: 
  | ... & ...
  | "software"
  | "service_desk"
  | "business"
  | "product_discovery"
  | "customer_service";

The project type of the project.

to.scope.project.self? ​
ts
optional self?: string;

The URL of the project details.

to.scope.project.simplified? ​
ts
optional simplified?: boolean;

Whether or not the project is simplified.

to.scope.type? ​
ts
optional type?: string & object | "PROJECT" | "TEMPLATE";

The type of scope.

to.self? ​
ts
optional self?: string;

The URL of the status.

to.statusCategory? ​
ts
optional statusCategory?: object;
to.statusCategory.colorName? ​
ts
optional colorName?: string;

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

to.statusCategory.id? ​
ts
optional id?: number;

The ID of the status category.

to.statusCategory.key? ​
ts
optional key?: string;

The key of the status category.

to.statusCategory.name? ​
ts
optional name?: string;

The name of the status category.

to.statusCategory.self? ​
ts
optional self?: string;

The URL of the status category.

to.untranslatedName? ​
ts
optional untranslatedName?: string;

versionedRepresentations? ​

ts
optional versionedRepresentations?: Record<string, unknown>;

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

The versions of each field on the issue.