GET collaboration/service-desk-requests/{serviceDeskRequestId}

Help desk request details for the provided identifier

Note: Log in to check if your API client have access to run this resource
Note: This is a deprecated version of the resource. Be cautious when using it, since there exists a newer version of it, that you should be using! The current production version of the resource (if any) can be found here.
Version: 21
Success HTTP Status Code: 200

Uri parameters

{serviceDeskRequestId} Integer Service desk request identifier

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.

$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.

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

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
<ServiceDeskRequest>
2
     <ServiceDeskRequestId
ServiceDeskRequestId

Service desk request identifier

>
{Integer}</ServiceDeskRequestId>
3
     <ObjectStatus
ObjectStatus

Status of the help desk request

>
{Integer}</ObjectStatus>
4
     <Date
Date

Date the object was issued

>
{Date}</Date>
5
     <ProgressStatus
ProgressStatus

Current action/status of the progress

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

Category of the request

>
{String}</Category>
7
     <RequestedPriority
RequestedPriority

The requesters priority of this service desk request

Possible domain values can be found here when logged in

>
{Integer}</RequestedPriority>
8
     <Priority
Priority

Internal priority of request

Possible domain values can be found here when logged in

>
{Integer}</Priority>
9
     <ExternalId
ExternalId

Identifier of corresponding external request/issue.

>
{String}</ExternalId>
10
     <ExternalSubject
ExternalSubject

Subject of corresponding external request/issue.

>
{String}</ExternalSubject>
11
     <RequestDatabase
RequestDatabase

Database of company that registered the request

>
{String}</RequestDatabase>
12
     <DateEvent>
13
          <TargetDate
TargetDate

Date when the service desk request is supposed to be completed

>
{Date}</TargetDate>
14
     </DateEvent>
15
     <RequestSpecification>
16
          <Subject
Subject

Title/subject of the request

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

Detailed description of the request

>
{String}</Description>
18
     </RequestSpecification>
19
     <ReleaseSpecification>
20
          <Description
Description

Detailed release information for service desk request

>
{String}</Description>
21
          <DateChanged
DateChanged

Date of last release specification change

>
{Date}</DateChanged>
22
          <ChangedBy>
23
               <LastName
LastName

Last name of employee

>
{String}</LastName>
24
               <FirstName
FirstName

First name of employee

>
{String}</FirstName>
25
               <ObjectReference
ObjectReference

Reference to the employee specifing last change of release specification

>
{Doc}</ObjectReference>
26
          </ChangedBy>
27
     </ReleaseSpecification>
28
     <Customer>
29
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
30
          <FirstName
FirstName

Secondary name of a company or firstname of a person

>
{String}</FirstName>
31
          <ObjectReference
ObjectReference

Customer reference

>
{Doc}</ObjectReference>
32
     </Customer>
33
     <FunctionalSpecification>
34
          <Description
Description

Functional specification description

>
{String}</Description>
35
          <DateChanged
DateChanged

Date of last functional specification change

>
{Date}</DateChanged>
36
          <ChangedBy>
37
               <LastName
LastName

Last name of employee

>
{String}</LastName>
38
               <FirstName
FirstName

First name of employee

>
{String}</FirstName>
39
               <ObjectReference
ObjectReference

Reference to the employee specifing last change of functional specification

>
{Doc}</ObjectReference>
40
          </ChangedBy>
41
     </FunctionalSpecification>
42
     <TimeTracking>
43
          <InitialEstimatedHours
InitialEstimatedHours

Initial/original/first estimation of hours needed to solve the help desk request. Is the estimation the requester relates to.

>
{Decimal}</InitialEstimatedHours>
44
          <EstimatedHours
EstimatedHours

Revised estimation of hours needed to solve the help desk request.

>
{Decimal}</EstimatedHours>
45
          <RemainingHours
RemainingHours

Remaining hours of work for the request

>
{Decimal}</RemainingHours>
46
          <LoggedHours
LoggedHours

Total hours logged for this help desk request

>
{Decimal}</LoggedHours>
47
     </TimeTracking>
48
     <AssignedTo>
49
          <LastName
LastName

Last name of employee

>
{String}</LastName>
50
          <FirstName
FirstName

First name of employee

>
{String}</FirstName>
51
          <ObjectReference
ObjectReference

Reference to the employee assigned to the request

>
{Doc}</ObjectReference>
52
     </AssignedTo>
53
     <RequestedBy>
54
          <LastName
LastName

Last name of requester

>
{String}</LastName>
55
          <FirstName
FirstName

First name og requester

>
{String}</FirstName>
56
          <ObjectReference
ObjectReference

Reference to employee or contact who registered the request

>
{Doc}</ObjectReference>
57
     </RequestedBy>
58
     <Developer>
59
          <LastName
LastName

Last name of employee

>
{String}</LastName>
60
          <FirstName
FirstName

First name of employee

>
{String}</FirstName>
61
          <ObjectReference
ObjectReference

The developer assigned if request needs development

>
{Doc}</ObjectReference>
62
     </Developer>
63
     <Commercial>
64
          <Liable
Liable

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

>
{String}</Liable>
65
          <InvoiceableHours
InvoiceableHours

Number of hours that is invoiceable for the service desk request

>
{Decimal}</InvoiceableHours>
66
          <ServiceRate
ServiceRate

Sercvice rate is used to calculate the cost of a service desk request. The service rate is multiplied with the invoiceable hours

>
{Decimal}</ServiceRate>
67
     </Commercial>
68
</ServiceDeskRequest>
1
{
2
     "serviceDeskRequest": {
3
          "serviceDeskRequestId
ServiceDeskRequestId

Service desk request identifier

":
"{Integer}",
4
          "objectStatus
ObjectStatus

Status of the help desk request

":
"{Integer}",
5
          "date
Date

Date the object was issued

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

Current action/status of the progress

":
"{String}",
7
          "category
Category

Category of the request

":
"{String}",
8
          "requestedPriority
RequestedPriority

The requesters priority of this service desk request

Possible domain values can be found here when logged in

":
"{Integer}",
9
          "priority
Priority

Internal priority of request

Possible domain values can be found here when logged in

":
"{Integer}",
10
          "externalId
ExternalId

Identifier of corresponding external request/issue.

":
"{String}",
11
          "externalSubject
ExternalSubject

Subject of corresponding external request/issue.

":
"{String}",
12
          "requestDatabase
RequestDatabase

Database of company that registered the request

":
"{String}",
13
          "dateEvent": {
14
               "targetDate
TargetDate

Date when the service desk request is supposed to be completed

":
"{Date}"
15
          },
16
          "requestSpecification": {
17
               "subject
Subject

Title/subject of the request

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

Detailed description of the request

":
"{String}"
19
          },
20
          "releaseSpecification": {
21
               "description
Description

Detailed release information for service desk request

":
"{String}",
22
               "dateChanged
DateChanged

Date of last release specification change

":
"{Date}",
23
               "changedBy": {
24
                    "lastName
LastName

Last name of employee

":
"{String}",
25
                    "firstName
FirstName

First name of employee

":
"{String}",
26
                    "objectReference
ObjectReference

Reference to the employee specifing last change of release specification

":
"{Doc}"
27
               }
28
          },
29
          "customer": {
30
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

":
"{String}",
31
               "firstName
FirstName

Secondary name of a company or firstname of a person

":
"{String}",
32
               "objectReference
ObjectReference

Customer reference

":
"{Doc}"
33
          },
34
          "functionalSpecification": {
35
               "description
Description

Functional specification description

":
"{String}",
36
               "dateChanged
DateChanged

Date of last functional specification change

":
"{Date}",
37
               "changedBy": {
38
                    "lastName
LastName

Last name of employee

":
"{String}",
39
                    "firstName
FirstName

First name of employee

":
"{String}",
40
                    "objectReference
ObjectReference

Reference to the employee specifing last change of functional specification

":
"{Doc}"
41
               }
42
          },
43
          "timeTracking": {
44
               "initialEstimatedHours
InitialEstimatedHours

Initial/original/first estimation of hours needed to solve the help desk request. Is the estimation the requester relates to.

":
"{Decimal}",
45
               "estimatedHours
EstimatedHours

Revised estimation of hours needed to solve the help desk request.

":
"{Decimal}",
46
               "remainingHours
RemainingHours

Remaining hours of work for the request

":
"{Decimal}",
47
               "loggedHours
LoggedHours

Total hours logged for this help desk request

":
"{Decimal}"
48
          },
49
          "assignedTo": {
50
               "lastName
LastName

Last name of employee

":
"{String}",
51
               "firstName
FirstName

First name of employee

":
"{String}",
52
               "objectReference
ObjectReference

Reference to the employee assigned to the request

":
"{Doc}"
53
          },
54
          "requestedBy": {
55
               "lastName
LastName

Last name of requester

":
"{String}",
56
               "firstName
FirstName

First name og requester

":
"{String}",
57
               "objectReference
ObjectReference

Reference to employee or contact who registered the request

":
"{Doc}"
58
          },
59
          "developer": {
60
               "lastName
LastName

Last name of employee

":
"{String}",
61
               "firstName
FirstName

First name of employee

":
"{String}",
62
               "objectReference
ObjectReference

The developer assigned if request needs development

":
"{Doc}"
63
          },
64
          "commercial": {
65
               "liable
Liable

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

":
"{String}",
66
               "invoiceableHours
InvoiceableHours

Number of hours that is invoiceable for the service desk request

":
"{Decimal}",
67
               "serviceRate
ServiceRate

Sercvice rate is used to calculate the cost of a service desk request. The service rate is multiplied with the invoiceable hours

":
"{Decimal}"
68
          }
69
     }
70
}

Possible error codes the response might return:

Error 100107 HTTP 404 Service desk request not found
Error 100108 HTTP 403 You can only see service desk requests belonging to your own company