GET collaboration/relationship-activities/service-desk-request-messages

List of messages sent in service desk requests

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

Direction String Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND)..
Message String Message/comment/text of the service desk request message.
OccuredAt Datetime Date and time the relationship activity occured. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Owner.
EmployeeId
Integer
Employee identifier.
Regarding.
ObjectId
Integer
Identifier of the object.
Regarding.
ObjectType
String
Type of object.
Sender.
Description
String
Name of the sender.
Sender.
ObjectReference.
ObjectId
Integer
Identifier of the object.
Sender.
ObjectReference.
ObjectType
String
Type of object.
ServiceDeskRequest.
ServiceDeskRequestId
Integer
Service desk request identifier.
ServiceDeskRequestMessageId Integer Service desk request message identifier.
Status Integer Status of the service desk request message.
Subject String A short subject of the service desk request message.

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

Direction String Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).
Message String Message/comment/text of the service desk request message
OccuredAt Datetime Date and time the relationship activity occured
Owner.
EmployeeId
Integer
Employee identifier
Regarding.
ObjectId
Integer
Identifier of the object
Regarding.
ObjectType
String
Type of object
Sender.
Description
String
Name of the sender
Sender.
ObjectReference.
ObjectId
Integer
Identifier of the object
Sender.
ObjectReference.
ObjectType
String
Type of object
ServiceDeskRequest.
ServiceDeskRequestId
Integer
Service desk request identifier
ServiceDeskRequestMessageId Integer Service desk request message identifier
Status Integer Status of the service desk request message
Subject String A short subject of the service desk request message

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
<ServiceDeskRequestMessages>
2
     <ServiceDeskRequestMessage>
3
          <ServiceDeskRequestMessageId
ServiceDeskRequestMessageId

Service desk request message identifier

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

Status of the service desk request message

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

Date and time of creation

>
{Datetime}</CreatedAt>
6
          <OccuredAt
OccuredAt

Date and time the relationship activity occured

>
{Datetime}</OccuredAt>
7
          <Direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

>
{String}</Direction>
8
          <Subject
Subject

A short subject of the service desk request message

>
{String}</Subject>
9
          <Message
Message

Message/comment/text of the service desk request message

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

>
{String}</Message>
10
          <Regarding
Regarding

The customer/supplier of the relationship

>
11
               <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
12
               <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
13
               <Name
Name

Name of the customer/supplier, or last name if it is a person.

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Regarding.Name in your request URI to get this field

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

First name of the customer/supplier

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Regarding.FirstName in your request URI to get this field

>
{String}</FirstName>
15
               <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
16
          </Regarding>
17
          <Owner
Owner

All activities are assigned an owner who is responsible for completing/follow up the activity

>
18
               <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
19
               <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Owner.LastName in your request URI to get this field

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

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Owner.FirstName in your request URI to get this field

>
{String}</FirstName>
21
               <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
22
          </Owner>
23
          <Sender>
24
               <Description
Description

Name of the sender

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

Reference to the contact/customer/supplier/employee who sent the message

>
26
                    <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
27
                    <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
28
                    <Name
Name

Lastname of the sender, name if it is not a person.

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Sender.ObjectReference.Name in your request URI to get this field

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

Firstname of the sender

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Sender.ObjectReference.FirstName in your request URI to get this field

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

API reference to the object

>
{String}</ObjectLink>
31
               </ObjectReference>
32
          </Sender>
33
          <ServiceDeskRequest>
34
               <ServiceDeskRequestId
ServiceDeskRequestId

Service desk request identifier

>
{Integer}</ServiceDeskRequestId>
35
               <ServiceDeskRequestLink
ServiceDeskRequestLink

Help desk request reference

>
{String}</ServiceDeskRequestLink>
36
          </ServiceDeskRequest>
37
          <ServiceDeskRequestMessageLink
ServiceDeskRequestMessageLink

Service desk request message reference

>
{String}</ServiceDeskRequestMessageLink>
38
     </ServiceDeskRequestMessage>
39
</ServiceDeskRequestMessages>
1
{
2
     "serviceDeskRequestMessages": [
3
          {
4
               "serviceDeskRequestMessageId
ServiceDeskRequestMessageId

Service desk request message identifier

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

Status of the service desk request message

":
"{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
7
               "occuredAt
OccuredAt

Date and time the relationship activity occured

":
"{Datetime}",
8
               "direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

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

A short subject of the service desk request message

":
"{String}",
10
               "message
Message

Message/comment/text of the service desk request message

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

":
"{String}",
11
               "regarding
Regarding

The customer/supplier of the relationship

":
{
12
                    "objectId
ObjectId

Identifier of the object

":
"{Integer}",
13
                    "objectType
ObjectType

Type of object

":
"{String}",
14
                    "name
Name

Name of the customer/supplier, or last name if it is a person.

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Regarding.Name in your request URI to get this field

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

First name of the customer/supplier

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Regarding.FirstName in your request URI to get this field

":
"{String}",
16
                    "objectLink
ObjectLink

API reference to the object

":
"{String}"
17
               },
18
               "owner
Owner

All activities are assigned an owner who is responsible for completing/follow up the activity

":
{
19
                    "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
20
                    "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Owner.LastName in your request URI to get this field

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

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Owner.FirstName in your request URI to get this field

":
"{String}",
22
                    "employeeLink
EmployeeLink

Employee reference

":
"{String}"
23
               },
24
               "sender": {
25
                    "description
Description

Name of the sender

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

Reference to the contact/customer/supplier/employee who sent the message

":
{
27
                         "objectId
ObjectId

Identifier of the object

":
"{Integer}",
28
                         "objectType
ObjectType

Type of object

":
"{String}",
29
                         "name
Name

Lastname of the sender, name if it is not a person.

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Sender.ObjectReference.Name in your request URI to get this field

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

Firstname of the sender

This field is greyed out because it is an expandable field. You have to add $expand=ServiceDeskRequestMessage.Sender.ObjectReference.FirstName in your request URI to get this field

":
"{String}",
31
                         "objectLink
ObjectLink

API reference to the object

":
"{String}"
32
                    }
33
               },
34
               "serviceDeskRequest": {
35
                    "serviceDeskRequestId
ServiceDeskRequestId

Service desk request identifier

":
"{Integer}",
36
                    "serviceDeskRequestLink
ServiceDeskRequestLink

Help desk request reference

":
"{String}"
37
               },
38
               "serviceDeskRequestMessageLink
ServiceDeskRequestMessageLink

Service desk request message reference

":
"{String}"
39
          }
40
     ]
41
}

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
Error 100050 HTTP 403 No admittance as customer {0}