Details about an issue.

interface Issue {
    changelog?: {
        histories?: {
            author?: {
                accountId?: string;
                accountType?: string;
                active?: boolean;
                avatarUrls?: Agile.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?: {};
                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?: {};
    };
    expand?: string;
    fields?: Agile.AgileModels.Fields;
    fieldsToInclude?: {
        actuallyIncluded?: string[];
        excluded?: string[];
        included?: string[];
    };
    id?: string;
    key?: string;
    names?: {};
    operations?: Agile.AgileModels.Operations;
    properties?: {};
    renderedFields?: {};
    schema?: {};
    self?: string;
    transitions?: {
        expand?: string;
        fields?: {};
        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?: Agile.AgileModels.Scope;
            self?: string;
            statusCategory?: Agile.AgileModels.StatusCategory;
        };
    }[];
    versionedRepresentations?: {};
}

Properties

changelog?: {
    histories?: {
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: Agile.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?: {};
            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

  • Optional histories?: {
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: Agile.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?: {};
            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.

  • Optional maxResults?: number

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

  • Optional startAt?: number

    The index of the first item returned on the page.

  • Optional total?: number

    The number of results on the page.

editmeta?: {
    fields?: {};
}

A list of editable field details.

Type declaration

  • Optional fields?: {}
    expand?: string

    Expand options that include additional issue details in the response.

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

    Type declaration

    • Optional actuallyIncluded?: string[]
    • Optional excluded?: string[]
    • Optional included?: string[]
    id?: string

    The ID of the issue.

    key?: string

    The key of the issue.

    names?: {}

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

    Type declaration

      properties?: {}

      Details of the issue properties identified in the request.

      Type declaration

        renderedFields?: {}

        The rendered value of each field present on the issue.

        Type declaration

          schema?: {}

          The schema describing each field present on the issue.

          Type declaration

            self?: string

            The URL of the issue details.

            transitions?: {
                expand?: string;
                fields?: {};
                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?: Agile.AgileModels.Scope;
                    self?: string;
                    statusCategory?: Agile.AgileModels.StatusCategory;
                };
            }[]

            The transitions that can be performed on the issue.

            Type declaration

            • Optional expand?: string

              Expand options that include additional transition details in the response.

            • Optional fields?: {}

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

              • Optional hasScreen?: boolean

                Whether there is a screen associated with the issue transition.

              • Optional id?: string

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

              • Optional isAvailable?: boolean

                Whether the transition is available to be performed.

              • Optional isConditional?: boolean

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

              • Optional isGlobal?: boolean

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

              • Optional isInitial?: boolean

                Whether this is the initial issue transition for the workflow.

              • Optional looped?: boolean
              • Optional name?: string

                The name of the issue transition.

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

                A status.

                • Optional description?: string

                  The description of the status.

                • Optional iconUrl?: string

                  The URL of the icon used to represent the status.

                • Optional id?: string

                  The ID of the status.

                • Optional name?: string

                  The name of the status.

                • Optional scope?: Agile.AgileModels.Scope

                  The projects the item is associated with. Indicated for items associated with next-gen projects.

                • Optional self?: string

                  The URL of the status.

                • Optional statusCategory?: Agile.AgileModels.StatusCategory

                  A status category.

              versionedRepresentations?: {}

              The versions of each field on the issue.

              Type declaration