Function: getMyCustomerRequests()
function getMyCustomerRequests(
client,
parameters?,
options?
): Promise<{
[key: string]: unknown;
_expands?: string[];
_links?: {
[key: string]: unknown;
base?: string;
context?: string;
next?: string;
prev?: string;
self?: string;
};
isLastPage?: boolean;
limit?: number;
maxResultWindow?: number;
size?: number;
start?: number;
values?: object[];
}>;Defined in: src/serviceDeskServer/api/customerRequests.ts:117
Returns all customer requests for the user that is executing the query. That is, the customer requests where the user is the creator of the customer request or has participated in the customer request.
Returned customer requests are ordered chronologically by the latest activity on each customer request. For example, the latest status transition or comment.
Note: The total number of issues across all pages that can be returned using paginated search is limited to the maxResultWindow, which is defined by the underlying search engine. The current value is returned in the maxResultWindow property of the response. If not set, it means there is no limit.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters? | { expand?: string; limit?: number; requestOwnership?: string; requestStatus?: string; requestTypeId?: string; searchTerm?: string; serviceDeskId?: string; start?: number; } | - |
parameters.expand? | string | This is a multi-value parameter indicating which properties of the customer request to expand: - serviceDesk - Return additional details for each service project in the response. - requestType - Return additional details for each request type in the response. - participant - Return the participant details, if any, for each customer request in the response. - sla - Return the SLA information on the given request. - status - Return the status transitions, in chronological order, for each customer request in the response. |
parameters.limit? | number | The maximum number of items to return per page. Default: 50. |
parameters.requestOwnership? | string | Filters results to customer requests where the user is the creator and/or participant: - OWNED_REQUESTS - Only return customer requests where the user is the creator. - PARTICIPATED_REQUESTS - Only return customer requests where the user is a participant. - ALL_REQUESTS - Return customer requests where the user is the creator or a participant. |
parameters.requestStatus? | string | Filters results to customer requests that are resolved, unresolved, or either of the two: - CLOSED_REQUESTS - Only return customer requests that are resolved. - OPEN_REQUESTS - Only return customer requests that are unresolved. - ALL_REQUESTS - Returns customer requests that are either resolved or unresolved. |
parameters.requestTypeId? | string | Filters results to customer requests of a specific request type. You must also specify the serviceDeskID for the service desk that the request type belongs to. |
parameters.searchTerm? | string | Filters results to customer requests where the issue summary matches the searchTerm. You can use wildcards in the searchTerm. |
parameters.serviceDeskId? | string | Filters results to customer requests from a specific service project. |
parameters.start? | number | The starting index of the returned objects. Base index: 0. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }>