jira.js
    Preparing search index...

    Function getCustomerRequestByIdOrKey

    • This method returns a customer request.

      Permissions required: Permission to access the specified service desk.

      Response limitations: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.

      Note: requestFieldValues does not include hidden fields. To get a list of request type fields that includes hidden fields, see /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field

      Parameters

      • client: Client
      • parameters: { expand?: string[]; issueIdOrKey: string }
        • Optionalexpand?: string[]

          A multi-value parameter indicating which properties of the customer request to expand, where:

          • serviceDesk returns additional service desk details.
          • requestType returns additional customer request type details.
          • participant returns the participant details.
          • sla returns the SLA information.
          • status returns the status transitions, in chronological order.
          • attachment returns the attachments.
          • action returns the actions that the user can or cannot perform.
          • comment returns the comments.
          • comment.attachment returns the attachment details for each comment.
          • comment.renderedBody (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment.
        • issueIdOrKey: string

          The ID or Key of the customer request to be returned

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              _expands?: string[];
              _links?: {
                  agent?: string;
                  jiraRest?: string;
                  self?: string;
                  web?: string;
                  [key: string]: unknown;
              };
              actions?: {
                  addAttachment?: { allowed?: boolean; [key: string]: unknown };
                  addComment?: { allowed?: boolean; [key: string]: unknown };
                  addParticipant?: { allowed?: boolean; [key: string]: unknown };
                  removeParticipant?: { allowed?: boolean; [key: string]: unknown };
                  [key: string]: unknown;
              };
              attachments?: {
                  _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?: {
                          content?: string;
                          jiraRest?: string;
                          self?: string;
                          thumbnail?: string;
                          [key: string]: unknown;
                      };
                      author?: {
                          _links?: {
                              avatarUrls?: ...;
                              jiraRest?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          accountId?: string;
                          active?: boolean;
                          displayName?: string;
                          emailAddress?: string;
                          key?: string;
                          name?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      created?: {
                          epochMillis?: number;
                          friendly?: string;
                          iso8601?: string;
                          jira?: string;
                          [key: string]: unknown;
                      };
                      filename?: string;
                      mimeType?: string;
                      size?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              comments?: {
                  _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?: {
                      _expands?: string[];
                      _links?: { self?: string; [key: string]: unknown };
                      attachments?: {
                          _expands?: (...)[];
                          _links?: {
                              base?: ...;
                              context?: ...;
                              next?: ...;
                              prev?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          isLastPage?: boolean;
                          limit?: number;
                          size?: number;
                          start?: number;
                          values?: (...)[];
                          [key: string]: unknown;
                      };
                      author?: {
                          _links?: {
                              avatarUrls?: ...;
                              jiraRest?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          accountId?: string;
                          active?: boolean;
                          displayName?: string;
                          emailAddress?: string;
                          key?: string;
                          name?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      body?: string;
                      created?: {
                          epochMillis?: number;
                          friendly?: string;
                          iso8601?: string;
                          jira?: string;
                          [key: string]: unknown;
                      };
                      id?: string;
                      public?: boolean;
                      renderedBody?: { html?: string; [key: string]: unknown };
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              createdDate?: {
                  epochMillis?: number;
                  friendly?: string;
                  iso8601?: string;
                  jira?: string;
                  [key: string]: unknown;
              };
              currentStatus?: {
                  status?: string;
                  statusCategory?: | string & {}
                  | "NEW"
                  | "DONE"
                  | "UNDEFINED"
                  | "INDETERMINATE";
                  statusDate?: {
                      epochMillis?: number;
                      friendly?: string;
                      iso8601?: string;
                      jira?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              };
              issueId?: string;
              issueKey?: string;
              participants?: {
                  _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?: {
                          avatarUrls?: Record<(...), (...)>;
                          jiraRest?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      accountId?: string;
                      active?: boolean;
                      displayName?: string;
                      emailAddress?: string;
                      key?: string;
                      name?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              reporter?: {
                  _links?: {
                      avatarUrls?: Record<string, any>;
                      jiraRest?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  accountId?: string;
                  active?: boolean;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              requestFieldValues?: {
                  fieldId?: string;
                  label?: string;
                  renderedValue?: Record<string, any>;
                  value?: unknown;
                  [key: string]: unknown;
              }[];
              requestType?: {
                  _expands?: string[];
                  _links?: { self?: string; [key: string]: unknown };
                  canCreateRequest?: boolean;
                  description?: string;
                  fields?: {
                      canAddRequestParticipants?: boolean;
                      canRaiseOnBehalfOf?: boolean;
                      requestTypeFields?: {
                          defaultValues?: (...)[];
                          description?: string;
                          fieldId?: string;
                          jiraSchema?: {
                              configuration?: ...;
                              custom?: ...;
                              customId?: ...;
                              items?: ...;
                              system?: ...;
                              type: ...;
                              [key: ...]: ...;
                          };
                          name?: string;
                          presetValues?: (...)[];
                          required?: boolean;
                          validValues?: (...)[];
                          visible?: boolean;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  groupIds?: string[];
                  helpText?: string;
                  icon?: {
                      _links?: { iconUrls?: Record<string, any>; [key: string]: unknown };
                      id?: string;
                      [key: string]: unknown;
                  };
                  id?: string;
                  issueTypeId?: string;
                  name?: string;
                  portalId?: string;
                  practice?: string;
                  restrictionStatus?: string & {}
                  | "OPEN"
                  | "RESTRICTED";
                  serviceDeskId?: string;
                  [key: string]: unknown;
              };
              requestTypeId?: string;
              serviceDesk?: {
                  _links?: { self?: string; [key: string]: unknown };
                  id?: string;
                  projectId?: string;
                  projectKey?: string;
                  projectName?: string;
                  projectTypeKey?: string;
                  [key: string]: unknown;
              };
              serviceDeskId?: string;
              sla?: {
                  _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?: (...) | (...) | (...);
                          breachTime?: (...) | (...);
                          elapsedTime?: (...) | (...);
                          goalDuration?: (...) | (...);
                          remainingTime?: (...) | (...);
                          startTime?: (...) | (...);
                          stopTime?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      id?: string;
                      name?: string;
                      ongoingCycle?: {
                          breached?: boolean;
                          breachTime?: {
                              epochMillis?: ...;
                              friendly?: ...;
                              iso8601?: ...;
                              jira?: ...;
                              [key: ...]: ...;
                          };
                          elapsedTime?: { friendly?: ...; millis?: ...; [key: ...]: ... };
                          goalDuration?: { friendly?: ...; millis?: ...; [key: ...]: ... };
                          paused?: boolean;
                          remainingTime?: { friendly?: ...; millis?: ...; [key: ...]: ... };
                          startTime?: {
                              epochMillis?: ...;
                              friendly?: ...;
                              iso8601?: ...;
                              jira?: ...;
                              [key: ...]: ...;
                          };
                          withinCalendarHours?: boolean;
                          [key: string]: unknown;
                      };
                      slaDisplayFormat?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              status?: {
                  _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?: {
                      status?: string;
                      statusCategory?: | string & {}
                      | "NEW"
                      | "DONE"
                      | "UNDEFINED"
                      | "INDETERMINATE";
                      statusDate?: {
                          epochMillis?: number;
                          friendly?: string;
                          iso8601?: string;
                          jira?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              summary?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility