jira.js
    Preparing search index...

    Function getCustomerRequests

    • This method returns all customer requests for the user executing the query.

      The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.

      Permissions required: Permission to access the specified service desk.

      Response limitations: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.

      Parameters

      • client: Client
      • Optionalparameters: {
            approvalStatus?: string;
            expand?: string[];
            limit?: number;
            organizationId?: number;
            requestOwnership?: string[];
            requestStatus?: string;
            requestTypeId?: number;
            searchTerm?: string;
            serviceDeskId?: number;
            start?: number;
        }
        • OptionalapprovalStatus?: string

          Filters results to customer requests based on their approval status:

          • MY_PENDING_APPROVAL returns customer requests pending the user's approval.
          • MY_HISTORY_APPROVAL returns customer requests where the user was an approver.

          Note: Valid only when used with requestOwnership=APPROVER.

        • Optionalexpand?: string[]

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

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

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

        • OptionalorganizationId?: number

          Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). Note: Valid only when used with requestOwnership=ORGANIZATION.

        • OptionalrequestOwnership?: string[]

          Filters customer requests using the following values:

          • OWNED_REQUESTS returns customer requests where the user is the creator.
          • PARTICIPATED_REQUESTS returns customer requests where the user is a participant.
          • ORGANIZATION returns customer requests for an organization of which the user is a member when used in conjunction with organizationId.
          • ALL_ORGANIZATIONS returns customer requests that belong to all organizations of which the user is a member.
          • APPROVER returns customer requests where the user is an approver. Can be used in conjunction with approvalStatus to filter pending or complete approvals.
          • ALL_REQUESTS returns all customer requests. Deprecated and will be removed, as the returned requests may change if more values are added in the future. Instead, explicitly list the desired filtering strategies.

          Multiple values of the query parameter are supported. For example, requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to OWNED_REQUESTS, PARTICIPATED_REQUESTS, and ALL_ORGANIZATIONS.

        • OptionalrequestStatus?: string

          Filters customer requests where the request is closed, open, or either of the two where:

          • CLOSED_REQUESTS returns customer requests that are closed.
          • OPEN_REQUESTS returns customer requests that are open.
          • ALL_REQUESTS returns all customer requests.
        • OptionalrequestTypeId?: number

          Filters customer requests by request type. Note that the serviceDeskId must be specified for the service desk in which the request type belongs.

        • OptionalsearchTerm?: string

          Filters customer requests where the request summary matches the searchTerm. Wildcards can be used in the searchTerm parameter.

        • OptionalserviceDeskId?: number

          Filters customer requests by service desk.

        • 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?: {
                  _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?: (...)
                          | (...);
                          author?: (...) | (...);
                          created?: (...) | (...);
                          filename?: (...) | (...);
                          mimeType?: (...) | (...);
                          size?: (...) | (...);
                          [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?: (...)
                          | (...);
                          _links?: (...) | (...);
                          attachments?: (...) | (...);
                          author?: (...) | (...);
                          body?: (...) | (...);
                          created?: (...) | (...);
                          id?: (...) | (...);
                          public?: (...) | (...) | (...);
                          renderedBody?: (...) | (...);
                          [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?: (...)
                          | (...);
                          accountId?: (...) | (...);
                          active?: (...) | (...) | (...);
                          displayName?: (...) | (...);
                          emailAddress?: (...) | (...);
                          key?: (...) | (...);
                          name?: (...) | (...);
                          timeZone?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  reporter?: {
                      _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;
                  };
                  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?: (...)[];
                          [key: string]: unknown;
                      };
                      groupIds?: string[];
                      helpText?: string;
                      icon?: {
                          _links?: { iconUrls?: ...; [key: ...]: ... };
                          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?: (...)
                          | (...);
                          completedCycles?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          ongoingCycle?: (...) | (...);
                          slaDisplayFormat?: (...) | (...);
                          [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?: (...)
                          | (...);
                          statusCategory?: (...) | (...) | (...) | (...) | (...) | (...);
                          statusDate?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  summary?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility