GET collaboration/service-desk-requests

List of service desk requests

Note: Log in to check if your API client have access to run this resource
Version: 10
Success HTTP Status Code: 200
Maximum items from list ($top): 80

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

Category String Category of the request.
Date Date Date the object was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Liable String Indicates ( YES/NO) if the Service desk request is liable to be paid by the customer.
ProgressStatus String Current action/status of the progress.
RequestedBy.
ObjectReference.
ObjectId
Integer
The contact who requested the servicedesk ticket.
RequestedById Integer The contact who requested the servicedesk ticket.
RequestedPriority Integer The requesters priority of this service desk request.
RequestSpecification.
Subject
String
Title/subject of the request.
ServiceDeskRequestId Integer Service desk request identifier.
Status Integer Status of the help desk request.

See the page about filters and sorting on how to use sortable parameters

Category String Category of the request
Date Date Date the object was issued
Liable String Indicates ( YES/NO) if the Service desk request is liable to be paid by the customer
ProgressStatus String Current action/status of the progress
RequestedBy.
ObjectReference.
ObjectId
Integer
The contact who requested the servicedesk ticket
RequestedById Integer The contact who requested the servicedesk ticket
RequestedPriority Integer The requesters priority of this service desk request
RequestSpecification.
Subject
String
Title/subject of the request
ServiceDeskRequestId Integer Service desk request identifier
Status Integer Status of the help desk request

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ServiceDeskRequests>
2
     <ServiceDeskRequest>
3
          <ServiceDeskRequestId
ServiceDeskRequestId

Service desk request identifier

>
{Integer}</ServiceDeskRequestId>
4
          <Status
Status

Status of the help desk request

>
{Integer}</Status>
5
          <ProgressStatus
ProgressStatus

Current action/status of the progress

>
{String}</ProgressStatus>
6
          <Date
Date

Date the object was issued

>
{Date}</Date>
7
          <Category
Category

Category of the request

Possible domain values can be found here when logged in

>
{String}</Category>
8
          <RequestSpecification>
9
               <Subject
Subject

Title/subject of the request

>
{String}</Subject>
10
               <Description
Description

Detailed description of the request

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequest.RequestSpecification.Description in your request URI to get this field

>
{String}</Description>
11
          </RequestSpecification>
12
          <Commercial>
13
               <Liable
Liable

Indicates ( YES/NO) if the Service desk request is liable to be paid by the customer

>
{String}</Liable>
14
          </Commercial>
15
          <HelpDeskRequestLink
HelpDeskRequestLink

Help desk request reference

>
{String}</HelpDeskRequestLink>
16
     </ServiceDeskRequest>
17
</ServiceDeskRequests>
1
{
2
     "serviceDeskRequests": [
3
          {
4
               "serviceDeskRequestId
ServiceDeskRequestId

Service desk request identifier

":
"{Integer}",
5
               "status
Status

Status of the help desk request

":
"{Integer}",
6
               "progressStatus
ProgressStatus

Current action/status of the progress

":
"{String}",
7
               "date
Date

Date the object was issued

":
"{Date}",
8
               "category
Category

Category of the request

Possible domain values can be found here when logged in

":
"{String}",
9
               "requestSpecification": {
10
                    "subject
Subject

Title/subject of the request

":
"{String}",
11
                    "description
Description

Detailed description of the request

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequest.RequestSpecification.Description in your request URI to get this field

":
"{String}"
12
               },
13
               "commercial": {
14
                    "liable
Liable

Indicates ( YES/NO) if the Service desk request is liable to be paid by the customer

":
"{String}"
15
               },
16
               "helpDeskRequestLink
HelpDeskRequestLink

Help desk request reference

":
"{String}"
17
          }
18
     ]
19
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource