jira.js
    Preparing search index...

    Function getContextsForField

    • Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:

      • With no other parameters set, all contexts.
      • By defining id only, all contexts from the list of IDs.
      • By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false)
      • By defining isGlobalContext, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).

      Permissions required: Administer Jira global permission. Edit Workflow edit workflow permission

      Parameters

      • client: Client
      • parameters: {
            contextId?: number[];
            fieldId: string;
            isAnyIssueType?: boolean;
            isGlobalContext?: boolean;
            maxResults?: number;
            startAt?: number;
        }
        • OptionalcontextId?: number[]

          The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&contextId=10001.

        • fieldId: string

          The ID of the custom field.

        • OptionalisAnyIssueType?: boolean

          Whether to return contexts that apply to all issue types.

        • OptionalisGlobalContext?: boolean

          Whether to return contexts that apply to all projects.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  description: string;
                  id: string;
                  isAnyIssueType: boolean;
                  isGlobalContext: boolean;
                  name: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility