Share via


Provide support - Get all service request details

Gets the service requests.

GET https://api.partnercenter.microsoft.com/v1/servicerequests
GET https://api.partnercenter.microsoft.com/v1/servicerequests?Field={Field}&Value={Value}&offset={offset}&size={size}&optionalFilters={optionalFilters}

URI Parameters

Name In Required Type Description
Field
query

string

offset
query

integer (int32)

The index

optionalFilters
query

object[]

The optional filters

size
query

integer (int32)

The size.

Value
query

string

Request Header

Name Required Type Description
IncludeOrganizationRequests

string

When present, will authorize the caller for the Support Request Admin role before attempting to retrieve organization requests.

Responses

Name Type Description
200 OK

ResourceCollection`1

Success

Media Types: "text/plain", "application/json", "text/json"

403 Forbidden

ProblemDetails

Forbidden

Media Types: "text/plain", "application/json", "text/json"

404 Not Found

ProblemDetails

Not Found

Media Types: "text/plain", "application/json", "text/json"

Other Status Codes

ProblemDetails

Error

Media Types: "text/plain", "application/json", "text/json"

Definitions

Name Description
BookingAppointment
DateTimeTimeZone
FileInfo
KeyValuePair`2
Link
ProblemDetails
ResourceAttributes
ResourceCollection`1
ResourceLinks
ServiceRequest
ServiceRequestAdditionalInfo
ServiceRequestContact
ServiceRequestNote
ServiceRequestOrganization
ServiceRequestSeverity
ServiceRequestStatus

BookingAppointment

Name Type Description
customerEmailAddress

string

customerEmailAddress

customerName

string

customerPhone

string

end

DateTimeTimeZone

notes

string

serviceRequestId

string

start

DateTimeTimeZone

DateTimeTimeZone

Name Type Description
dateTime

string

timeZone

string

FileInfo

Name Type Description
comment

string

extensionType

string

fileNameWithoutExtension

string

fileSize

integer (int64)

id

string

location

string

KeyValuePair`2

Name Type Description
key

string

value

string

Name Type Description
body

string

headers

KeyValuePair`2[]

method

string

uri

string (uri)

ProblemDetails

Name Type Description
detail

string

instance

string

status

integer (int32)

title

string

type

string

ResourceAttributes

Name Type Description
etag

string

objectType

string

ResourceCollection`1

Name Type Description
attributes

ResourceAttributes

items

ServiceRequest[]

links

ResourceLinks

totalCount

integer (int32)

Name Type Description
next

Link

previous

Link

self

Link

ServiceRequest

Name Type Description
additionalInfo

ServiceRequestAdditionalInfo[]

appointment

BookingAppointment

attributes

ResourceAttributes

countryCode

string

createdDate

string (date-time)

creationChannel

string

description

string

emailCcList

string[]

fileLinks

FileInfo[]

id

string

minLength: 0
maxLength: 16
pattern: ^([0-9]{10}|[0-9]{15}|[0-9]{1,9}|[0-9]{16}|[0-9]-[0-9]{13})$
lastClosedDate

string (date-time)

lastModifiedDate

string (date-time)

lastUpdatedBy

ServiceRequestContact

newNote

ServiceRequestNote

notes

ServiceRequestNote[]

organization

ServiceRequestOrganization

primaryContact

ServiceRequestContact

productId

string

productName

string

severity

ServiceRequestSeverity (int32)

status

ServiceRequestStatus (int32)

supportTopicDescription

string

supportTopicId

string

supportTopicName

string

title

string

maxLength: 255

ServiceRequestAdditionalInfo

Name Type Description
payLoad

type

string

ServiceRequestContact

Name Type Description
contactId

string

email

string (email)

firstName

string

lastName

string

organization

ServiceRequestOrganization

phoneNumber

string

preferredContactMethod

string

ServiceRequestNote

Name Type Description
createdByName

string

createdDate

string (date-time)

text

string

updatedByName

string

ServiceRequestOrganization

Name Type Description
id

string

name

string

phoneNumber

string

ServiceRequestSeverity

Value Description
0
1
2
3

ServiceRequestStatus

Value Description
0
1
2
3