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

Saves information about a service desk request

Note: Log in to check if your API client have access to run this resource
Version: 8
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
<ServiceDeskRequest
ServiceDeskRequest

This field is optional.

>
2
     <ObjectStatus
ObjectStatus

Status of the help desk request

Minimum value: 1

Maximum value: 9

This field is optional.

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

Current action/status of the progress

This field is optional.

>
{String}</ProgressStatus>
4
     <RequestedPriority
RequestedPriority

The requesters priority of this service desk request

This field is optional.

>
{Integer}</RequestedPriority>
5
     <Category
Category

Category of the request

This field is optional.

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

Identifier of corresponding external request/issue.

This field is optional.

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

Subject of corresponding external request/issue.

This field is optional.

>
{String}</ExternalSubject>
8
     <RequestSpecification
RequestSpecification

This field is optional.

>
9
          <Subject
Subject

Title/subject of the request

This field is optional.

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

Detailed description of the request

This field is optional.

>
{String}</Description>
11
     </RequestSpecification>
12
     <TimeTracking
TimeTracking

This field is optional.

>
13
          <InitialEstimatedHours
InitialEstimatedHours

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

This field is optional.

>
{Decimal}</InitialEstimatedHours>
14
          <RemainingHours
RemainingHours

Remaining hours of work for the request

This field is optional.

>
{Decimal}</RemainingHours>
15
          <HoursEstimated
HoursEstimated

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

This field is optional.

>
{Decimal}</HoursEstimated>
16
     </TimeTracking>
17
     <AssignedTo
AssignedTo

This field is optional.

>
18
          <ObjectReference
ObjectReference

This field is optional.

>
19
               <ObjectId
ObjectId

Reference to the employee assigned to the request

This field is optional.

>
{Integer}</ObjectId>
20
          </ObjectReference>
21
     </AssignedTo>
22
     <Developer
Developer

This field is optional.

>
23
          <ObjectReference
ObjectReference

This field is optional.

>
24
               <ObjectId
ObjectId

The developer assigned if request needs development

This field is optional.

>
{Integer}</ObjectId>
25
          </ObjectReference>
26
     </Developer>
27
</ServiceDeskRequest>
1
{
2
     "serviceDeskRequest
ServiceDeskRequest

This field is optional.

":
{
3
          "objectStatus
ObjectStatus

Status of the help desk request

Minimum value: 1

Maximum value: 9

This field is optional.

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

Current action/status of the progress

This field is optional.

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

The requesters priority of this service desk request

This field is optional.

":
"{Integer}",
6
          "category
Category

Category of the request

This field is optional.

":
"{String}",
7
          "externalId
ExternalId

Identifier of corresponding external request/issue.

This field is optional.

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

Subject of corresponding external request/issue.

This field is optional.

":
"{String}",
9
          "requestSpecification
RequestSpecification

This field is optional.

":
{
10
               "subject
Subject

Title/subject of the request

This field is optional.

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

Detailed description of the request

This field is optional.

":
"{String}"
12
          },
13
          "timeTracking
TimeTracking

This field is optional.

":
{
14
               "initialEstimatedHours
InitialEstimatedHours

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

This field is optional.

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

Remaining hours of work for the request

This field is optional.

":
"{Decimal}",
16
               "hoursEstimated
HoursEstimated

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

This field is optional.

":
"{Decimal}"
17
          },
18
          "assignedTo
AssignedTo

This field is optional.

":
{
19
               "objectReference
ObjectReference

This field is optional.

":
{
20
                    "objectId
ObjectId

Reference to the employee assigned to the request

This field is optional.

":
"{Integer}"
21
               }
22
          },
23
          "developer
Developer

This field is optional.

":
{
24
               "objectReference
ObjectReference

This field is optional.

":
{
25
                    "objectId
ObjectId

The developer assigned if request needs development

This field is optional.

":
"{Integer}"
26
               }
27
          }
28
     }
29
}

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.

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

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 100123 HTTP 403 Updates is only allowed for service desk requests in status 1
Error 100132 HTTP 400 Assignee not found
Error 100131 HTTP 404 Developer not found
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
Error 100125 HTTP 400 The attempt to update action status is not according to the rules
Error 100114 HTTP 400 Request of HLD is required
Error 100018 HTTP 404 Document {0} not found
Error 100115 HTTP 404 ACTION not found in revision history
Error 100126 HTTP 400 The application field is not correctly filled for this type of service desk request
Error 100209 HTTP 400 Illegal document Id {0}
Error 101086 HTTP 400 Missing required argument {0} for description
Error 101087 HTTP 400 Description argument/result mismatch
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 102529 HTTP 404 RamBase event type not found
Error 100009 HTTP 400 Missing required input arguments
Error 100012 HTTP 400 {0} must exist in {1}
Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 101420 HTTP 404 Setting definition not found
Error 100048 HTTP 400 Parameter {0}: {1} not valid
Error 101015 HTTP 404 Permission not found
Error 101514 HTTP 400 Setting definition reference is required
Error 101708 HTTP 400 Default value is required
Error 101640 HTTP 400 Data type is required