Get all service request with contacts using advanced query
post
/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/$views/serviceRequestContacts/$query
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : schema
Type:
Show Source
object-
accessors: object
accessors
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
-
fields: array
fields
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
-
subTypes: object
subTypes
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : type
Type:
Show Source
object-
collection: object
collection
Defines query criteria that can be applied on a resource collection.
Nested Schema : type
Type:
Show Source
object-
parameters: object
parameters
Values to be applied in a parameterized filter specific to the view.
Nested Schema : accessors
Type:
objectMaps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type:
arrayRestricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type:
objectMaps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : collection
Type:
objectDefines query criteria that can be applied on a resource collection.
Show Source
-
filter: string
The resource collection will be queried using the specified filter condition.
-
limit: integer
Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
-
offset: integer
Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
-
privilege: string
Represents the privilege or action required to check for while serving a request to access a resource.
-
sortBy: array
sortBy
Orders a resource collection based on the specified fields.
Nested Schema : sortBy
Type:
arrayOrders a resource collection based on the specified fields.
Show Source
Nested Schema : type
Type:
objectObject with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.
Nested Schema : parameters
Type:
objectValues to be applied in a parameterized filter specific to the view.
Response
Default Response
Successful response of retrieving view serviceRequestContacts for resource Service Requests
Nested Schema : items-allOf[1]
Type:
Show Source
object-
closedDate: string
(date-time)
Title:
Date ClosedThe date when the service request was closed, if closed. -
contacts:
contacts
-
createdBy: string
Title:
Created ByRead Only:trueThe user who created the record. -
criticalFlag: boolean
Title:
CriticalIndicates whether the service request is critical. If critical, the value is Y, else the value is N. -
id: string
(big-integer)
Title:
Service Request IDRead Only:trueThe unique identifier of the service request record. -
lastReopenDate: string
(date-time)
Title:
Date ReopenedThe date and time when the service request was last reopened. -
lastResolvedDate: string
(date-time)
Title:
Resolution DateThe date and time when the service request was resolved. -
number: string
Title:
Reference NumberRead Only:trueThe unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements. -
openDate: string
(date-time)
Title:
Date ReportedThe date when the service request was reported by the customer. -
problemDescription: string
Title:
Problem DescriptionThe service request's problem description or statement and the steps to reproduce the issue. -
resolveDescription: string
Title:
Solution DescriptionRead Only:trueThe description of how the service request has been resolved. -
timeCreated: string
(date-time)
Title:
Created OnRead Only:trueThe date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
title: string
Title:
TitleThe brief title of the service request. -
updatedBy: string
Title:
Last Updated ByRead Only:trueThe user who last updated the record.
Nested Schema : items-allOf[1]
Type:
Show Source
object-
accessLevelCode:
accessLevelCode
-
contact:
contact
-
contactTypeCode:
contactTypeCode
-
createdBy: string
Title:
Created ByRead Only:trueThe user who created the record. -
memberId: string
(big-integer)
Title:
Member IDRead Only:trueThe unique identifier of the contact. -
timeCreated: string
(date-time)
Title:
Created OnRead Only:trueThe date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated ByRead Only:trueThe user who last updated the record.
Nested Schema : accessLevelCode
Match All
The access level granted to the service request contact.
Show Source
Nested Schema : contactTypeCode
Match All
The service request contact type such as Customer or Partner.
Show Source
Nested Schema : id
Match All
Show Source
-
string(big-integer)
Read Only:
true -
string
Title:
Person IDThe unique identifier of the person profile.