Jira.js - Jira Cloud API library
    Preparing search index...

    Class Plans

    Index

    Constructors

    constructor

    Methods

    archivePlan createPlan duplicatePlan getPlan getPlans trashPlan updatePlan

    Constructors

    Methods

    • Updates any of the following details of a plan using JSON Patch.

      • Name

      • LeadAccountId

      • Scheduling

        • Estimation with StoryPoints, Days or Hours as possible values

        • StartDate

          • Type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
          • DateCustomFieldId

        • EndDate

          • Type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
          • DateCustomFieldId

        • InferredDates with None, SprintDates or ReleaseDates as possible values

        • Dependencies with Sequential or Concurrent as possible values

      • IssueSources

        • Type with Board, Project or Filter as possible values
        • Value

      • ExclusionRules

        • NumberOfDaysToShowCompletedIssues
        • IssueIds
        • WorkStatusIds
        • WorkStatusCategoryIds
        • IssueTypeIds
        • ReleaseIds

      • CrossProjectReleases

        • Name
        • ReleaseIds

      • CustomFields

        • CustomFieldId
        • Filter

      • Permissions

        • Type with View or Edit as possible values

        • Holder

          • Type with Group or AccountId as possible values
          • Value

      Permissions required: Administer Jira global permission.

      Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.

      Type Parameters

      • T = void

      Parameters

      Returns Promise<void>

    • Updates any of the following details of a plan using JSON Patch.

      • Name

      • LeadAccountId

      • Scheduling

        • Estimation with StoryPoints, Days or Hours as possible values

        • StartDate

          • Type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
          • DateCustomFieldId

        • EndDate

          • Type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
          • DateCustomFieldId

        • InferredDates with None, SprintDates or ReleaseDates as possible values

        • Dependencies with Sequential or Concurrent as possible values

      • IssueSources

        • Type with Board, Project or Filter as possible values
        • Value

      • ExclusionRules

        • NumberOfDaysToShowCompletedIssues
        • IssueIds
        • WorkStatusIds
        • WorkStatusCategoryIds
        • IssueTypeIds
        • ReleaseIds

      • CrossProjectReleases

        • Name
        • ReleaseIds

      • CustomFields

        • CustomFieldId
        • Filter

      • Permissions

        • Type with View or Edit as possible values

        • Holder

          • Type with Group or AccountId as possible values
          • Value

      Permissions required: Administer Jira global permission.

      Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.

      Type Parameters

      • T = void

      Parameters

      Returns Promise<T>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods