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:
object
Maps 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:
array
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type:
object
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 : collection
Type:
object
Defines 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:
array
Orders a resource collection based on the specified fields.
Show Source
Nested Schema : type
Type:
object
Object 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:
object
Values 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 Closed
The date when the service request was closed, if closed. -
contacts:
contacts
-
createdBy: string
Title:
Created By
Read Only:true
The user who created the record. -
criticalFlag: boolean
Title:
Critical
Indicates whether the service request is critical. If critical, the value is Y, else the value is N. -
id: string
(big-integer)
Title:
Service Request ID
Read Only:true
The unique identifier of the service request record. -
lastReopenDate: string
(date-time)
Title:
Date Reopened
The date and time when the service request was last reopened. -
lastResolvedDate: string
(date-time)
Title:
Resolution Date
The date and time when the service request was resolved. -
number: string
Title:
Reference Number
Read Only:true
The 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 Reported
The date when the service request was reported by the customer. -
problemDescription: string
Title:
Problem Description
The service request's problem description or statement and the steps to reproduce the issue. -
resolveDescription: string
Title:
Solution Description
Read Only:true
The description of how the service request has been resolved. -
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
The date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
title: string
Title:
Title
The brief title of the service request. -
updatedBy: string
Title:
Last Updated By
Read Only:true
The 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 By
Read Only:true
The user who created the record. -
memberId: string
(big-integer)
Title:
Member ID
Read Only:true
The unique identifier of the contact. -
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
The date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated By
Read Only:true
The 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 ID
The unique identifier of the person profile.