Optional
approvalOptional
expandA 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.
Optional
limitThe maximum number of items to return per page. Default: 50. See the Pagination section for more details.
Optional
organizationFilters 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.
Optional
requestFilters 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.
Optional
requestFilters customer requests by request type. Note that the serviceDeskId
must be specified for the service desk in
which the request type belongs.
Optional
searchFilters customer requests where the request summary matches the searchTerm
.
Wildcards can be used in
the searchTerm
parameter.
Optional
serviceFilters customer requests by service desk.
Optional
startThe starting index of the returned objects. Base index: 0. See the Pagination section for more details.
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.