jira.js
    Preparing search index...

    Function getSlaInformation

    • This method returns all the SLA records on a customer request. A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes information on when it started and stopped, and whether it breached the SLA goal.

      Permissions required:

      • Agent for the Service Desk containing the queried customer request, AND
      • Browse Projects permission on the project containing the customer request, including any restrictions imposed by issue security schemes or custom permission schemes on the specific issue.

      Parameters

      • client: Client
      • parameters: { issueIdOrKey: string; limit?: number; start?: number }
        • issueIdOrKey: string

          The ID or key of the customer request whose SLAs will be retrieved.

        • Optionallimit?: number

          The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.

        • Optionalstart?: number

          The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              _expands?: string[];
              _links?: {
                  base?: string;
                  context?: string;
                  next?: string;
                  prev?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              isLastPage?: boolean;
              limit?: number;
              size?: number;
              start?: number;
              values?: {
                  _links?: { self?: string; [key: string]: unknown };
                  completedCycles?: {
                      breached?: boolean;
                      breachTime?: {
                          epochMillis?: (...) | (...);
                          friendly?: (...) | (...);
                          iso8601?: (...) | (...);
                          jira?: (...) | (...);
                          [key: string]: unknown;
                      };
                      elapsedTime?: {
                          friendly?: (...)
                          | (...);
                          millis?: (...) | (...);
                          [key: string]: unknown;
                      };
                      goalDuration?: {
                          friendly?: (...)
                          | (...);
                          millis?: (...) | (...);
                          [key: string]: unknown;
                      };
                      remainingTime?: {
                          friendly?: (...)
                          | (...);
                          millis?: (...) | (...);
                          [key: string]: unknown;
                      };
                      startTime?: {
                          epochMillis?: (...)
                          | (...);
                          friendly?: (...) | (...);
                          iso8601?: (...) | (...);
                          jira?: (...) | (...);
                          [key: string]: unknown;
                      };
                      stopTime?: {
                          epochMillis?: (...)
                          | (...);
                          friendly?: (...) | (...);
                          iso8601?: (...) | (...);
                          jira?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  id?: string;
                  name?: string;
                  ongoingCycle?: {
                      breached?: boolean;
                      breachTime?: {
                          epochMillis?: number;
                          friendly?: string;
                          iso8601?: string;
                          jira?: string;
                          [key: string]: unknown;
                      };
                      elapsedTime?: {
                          friendly?: string;
                          millis?: number;
                          [key: string]: unknown;
                      };
                      goalDuration?: {
                          friendly?: string;
                          millis?: number;
                          [key: string]: unknown;
                      };
                      paused?: boolean;
                      remainingTime?: {
                          friendly?: string;
                          millis?: number;
                          [key: string]: unknown;
                      };
                      startTime?: {
                          epochMillis?: number;
                          friendly?: string;
                          iso8601?: string;
                          jira?: string;
                          [key: string]: unknown;
                      };
                      withinCalendarHours?: boolean;
                      [key: string]: unknown;
                  };
                  slaDisplayFormat?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility