Interface Issue

Details about an issue.

interface Issue {
    changelog?: {
        histories?: {
            author?: {
                accountId?: string;
                accountType?: string;
                active?: boolean;
                avatarUrls?: AgileModels.AvatarUrls;
                displayName?: string;
                emailAddress?: string;
                self?: string;
                timeZone?: string;
            };
            created?: string;
            historyMetadata?: {
                activityDescription?: string;
                activityDescriptionKey?: string;
                actor?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                };
                cause?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                };
                description?: string;
                descriptionKey?: string;
                emailDescription?: string;
                emailDescriptionKey?: string;
                extraData?: unknown;
                generator?: {
                    avatarUrl?: string;
                    displayName?: string;
                    displayNameKey?: string;
                    id?: string;
                    type?: string;
                    url?: string;
                };
                type?: string;
            };
            id?: string;
            items?: {
                field?: string;
                fieldId?: string;
                fieldtype?: string;
                from?: string;
                fromString?: string;
                to?: string;
                toString?: string;
            }[];
        }[];
        maxResults?: number;
        startAt?: number;
        total?: number;
    };
    editmeta?: { fields?: unknown };
    expand?: string;
    fields?: AgileModels.Fields;
    fieldsToInclude?: {
        actuallyIncluded?: string[];
        excluded?: string[];
        included?: string[];
    };
    id?: string;
    key?: string;
    names?: unknown;
    operations?: AgileModels.Operations;
    properties?: unknown;
    renderedFields?: unknown;
    schema?: unknown;
    self?: string;
    transitions?: {
        expand?: string;
        fields?: unknown;
        hasScreen?: boolean;
        id?: string;
        isAvailable?: boolean;
        isConditional?: boolean;
        isGlobal?: boolean;
        isInitial?: boolean;
        looped?: boolean;
        name?: string;
        to?: {
            description?: string;
            iconUrl?: string;
            id?: string;
            name?: string;
            scope?: AgileModels.Scope;
            self?: string;
            statusCategory?: AgileModels.StatusCategory;
        };
    }[];
    versionedRepresentations?: unknown;
}

Index

Properties

changelog? editmeta? expand? fields? fieldsToInclude? id? key? names? operations? properties? renderedFields? schema? self? transitions? versionedRepresentations?

Properties

`Optional`changelog

changelog?: {
    histories?: {
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: AgileModels.AvatarUrls;
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
        };
        created?: string;
        historyMetadata?: {
            activityDescription?: string;
            activityDescriptionKey?: string;
            actor?: {
                avatarUrl?: string;
                displayName?: string;
                displayNameKey?: string;
                id?: string;
                type?: string;
                url?: string;
            };
            cause?: {
                avatarUrl?: string;
                displayName?: string;
                displayNameKey?: string;
                id?: string;
                type?: string;
                url?: string;
            };
            description?: string;
            descriptionKey?: string;
            emailDescription?: string;
            emailDescriptionKey?: string;
            extraData?: unknown;
            generator?: {
                avatarUrl?: string;
                displayName?: string;
                displayNameKey?: string;
                id?: string;
                type?: string;
                url?: string;
            };
            type?: string;
        };
        id?: string;
        items?: {
            field?: string;
            fieldId?: string;
            fieldtype?: string;
            from?: string;
            fromString?: string;
            to?: string;
            toString?: string;
        }[];
    }[];
    maxResults?: number;
    startAt?: number;
    total?: number;
}

A page of changelogs.

Type declaration

Optionalhistories?: {
    author?: {
        accountId?: string;
        accountType?: string;
        active?: boolean;
        avatarUrls?: AgileModels.AvatarUrls;
        displayName?: string;
        emailAddress?: string;
        self?: string;
        timeZone?: string;
    };
    created?: string;
    historyMetadata?: {
        activityDescription?: string;
        activityDescriptionKey?: string;
        actor?: {
            avatarUrl?: string;
            displayName?: string;
            displayNameKey?: string;
            id?: string;
            type?: string;
            url?: string;
        };
        cause?: {
            avatarUrl?: string;
            displayName?: string;
            displayNameKey?: string;
            id?: string;
            type?: string;
            url?: string;
        };
        description?: string;
        descriptionKey?: string;
        emailDescription?: string;
        emailDescriptionKey?: string;
        extraData?: unknown;
        generator?: {
            avatarUrl?: string;
            displayName?: string;
            displayNameKey?: string;
            id?: string;
            type?: string;
            url?: string;
        };
        type?: string;
    };
    id?: string;
    items?: {
        field?: string;
        fieldId?: string;
        fieldtype?: string;
        from?: string;
        fromString?: string;
        to?: string;
        toString?: string;
    }[];
}[]
The list of changelogs.
OptionalmaxResults?: number
The maximum number of results that could be on the page.
OptionalstartAt?: number
The index of the first item returned on the page.
Optionaltotal?: number
The number of results on the page.

`Optional`editmeta

editmeta?: { fields?: unknown }

A list of editable field details.

`Optional`expand

expand?: string

Expand options that include additional issue details in the response.

`Optional`fields

fields?: AgileModels.Fields

`Optional`fieldsToInclude

fieldsToInclude?: {
    actuallyIncluded?: string[];
    excluded?: string[];
    included?: string[];
}

`Optional`id

id?: string

The ID of the issue.

`Optional`key

key?: string

The key of the issue.

`Optional`names

names?: unknown

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

`Optional`operations

operations?: AgileModels.Operations

`Optional`properties

properties?: unknown

Details of the issue properties identified in the request.

`Optional`renderedFields

renderedFields?: unknown

The rendered value of each field present on the issue.

`Optional`schema

schema?: unknown

The schema describing each field present on the issue.

`Optional`self

self?: string

The URL of the issue details.

`Optional`transitions

transitions?: {
    expand?: string;
    fields?: unknown;
    hasScreen?: boolean;
    id?: string;
    isAvailable?: boolean;
    isConditional?: boolean;
    isGlobal?: boolean;
    isInitial?: boolean;
    looped?: boolean;
    name?: string;
    to?: {
        description?: string;
        iconUrl?: string;
        id?: string;
        name?: string;
        scope?: AgileModels.Scope;
        self?: string;
        statusCategory?: AgileModels.StatusCategory;
    };
}[]

The transitions that can be performed on the issue.

Type declaration

Optionalexpand?: string
Expand options that include additional transition details in the response.
Optionalfields?: unknown
Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.
OptionalhasScreen?: boolean
Whether there is a screen associated with the issue transition.
Optionalid?: string
The ID of the issue transition. Required when specifying a transition to undertake.
OptionalisAvailable?: boolean
Whether the transition is available to be performed.
OptionalisConditional?: boolean
Whether the issue has to meet criteria before the issue transition is applied.
OptionalisGlobal?: boolean
Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.
OptionalisInitial?: boolean
Whether this is the initial issue transition for the workflow.
Optionallooped?: boolean
Optionalname?: string
The name of the issue transition.
Optionalto?: {
    description?: string;
    iconUrl?: string;
    id?: string;
    name?: string;
    scope?: AgileModels.Scope;
    self?: string;
    statusCategory?: AgileModels.StatusCategory;
}
A status.
- Optionaldescription?: string
  The description of the status.
- OptionaliconUrl?: string
  The URL of the icon used to represent the status.
- Optionalid?: string
  The ID of the status.
- Optionalname?: string
  The name of the status.
- Optionalscope?: AgileModels.Scope
  The projects the item is associated with. Indicated for items associated with next-gen projects.
- Optionalself?: string
  The URL of the status.
- OptionalstatusCategory?: AgileModels.StatusCategory
  A status category.

`Optional`versionedRepresentations

versionedRepresentations?: unknown

The versions of each field on the issue.

Interface Issue

Index

Properties

Properties

Optionalchangelog

Type declaration

OptionalmaxResults?: number

OptionalstartAt?: number

Optionaltotal?: number

Optionaleditmeta

Optionalexpand

Optionalfields

OptionalfieldsToInclude

Optionalid

Optionalkey

Optionalnames

Optionaloperations

Optionalproperties

OptionalrenderedFields

Optionalschema

Optionalself

Optionaltransitions

Type declaration

Optionalexpand?: string

Optionalfields?: unknown

OptionalhasScreen?: boolean

Optionalid?: string

OptionalisAvailable?: boolean

OptionalisConditional?: boolean

OptionalisGlobal?: boolean

OptionalisInitial?: boolean

Optionallooped?: boolean

Optionalname?: string

Optionalto?: { description?: string; iconUrl?: string; id?: string; name?: string; scope?: AgileModels.Scope; self?: string; statusCategory?: AgileModels.StatusCategory;}

Optionaldescription?: string

OptionaliconUrl?: string

Optionalid?: string

Optionalname?: string

Optionalscope?: AgileModels.Scope

Optionalself?: string

OptionalstatusCategory?: AgileModels.StatusCategory

OptionalversionedRepresentations

Settings

On This Page

`Optional`changelog

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`total?: number

`Optional`editmeta

`Optional`expand

`Optional`fields

`Optional`fieldsToInclude

`Optional`id

`Optional`key

`Optional`names

`Optional`operations

`Optional`properties

`Optional`renderedFields

`Optional`schema

`Optional`self

`Optional`transitions

`Optional`expand?: string

`Optional`fields?: unknown

`Optional`hasScreen?: boolean

`Optional`id?: string

`Optional`isAvailable?: boolean

`Optional`isConditional?: boolean

`Optional`isGlobal?: boolean

`Optional`isInitial?: boolean

`Optional`looped?: boolean

`Optional`name?: string

`Optional`to?: {
description?: string;
iconUrl?: string;
id?: string;
name?: string;
scope?: AgileModels.Scope;
self?: string;
statusCategory?: AgileModels.StatusCategory;
}

`Optional`description?: string

`Optional`iconUrl?: string

`Optional`id?: string

`Optional`name?: string

`Optional`scope?: AgileModels.Scope

`Optional`self?: string

`Optional`statusCategory?: AgileModels.StatusCategory

`Optional`versionedRepresentations