Get a message using advanced query
post
/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/{serviceRequests_id}/messages/{serviceRequests-messages_id}/$query
Request
Path Parameters
-
serviceRequests-messages_id(required): string
This path parameter maps to the following field defined in the Service Requests/Messages REST resource:
- id: The unique identifier associated with the service request message.
-
serviceRequests_id(required): string
This path parameter maps to the following field defined in the Service Requests REST resource:
- number: 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.
Supported Media Types
- application/json
Root 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 : 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.
Response
Default Response
A single item response
Nested Schema : oraCxServiceCoreSrMgmt.Message_item
Match All
Messages contain information about communication updates made to the service request. It keeps a record of messages from agents and workers.
Show Source
-
object
oraCxServiceCoreSrMgmt.Message_item-fields
-
object
Message
Title:
MessageMessages contain information about communication updates made to the service request. It keeps a record of messages from agents and workers.
Nested Schema : oraCxServiceCoreSrMgmt.Message_item-fields
Type:
Show Source
object-
aiLogLevelCode:
aiLogLevelCode
-
channelType:
channelType
-
createdBy: string
Title:
Created ByRead Only:trueThe user who created the record. -
feedFlag: boolean
Title:
Feed FlagRead Only:trueDefault Value:trueIndicates whether the SR Message should be pushed to the SR Feed. Values are Y and N. -
id: string
(big-integer)
Title:
Message IDRead Only:trueThe unique identifier associated with the service request message. -
messageContent: string
(long-text)
Title:
Message ContentRead Only:trueIndicates the content of the service request message. -
messageSubType:
messageSubType
-
messageType:
messageType
-
number: string
Title:
Message NumberRead Only:trueThe public unique identifier of the service request message. -
originalSystemReference: string
Title:
Original SystemRead Only:trueThe reference to the service request record in the original system from which service request was imported (if imported). -
originationDate: string
(date-time)
Title:
Origination DateRead Only:trueThe date the message was created in the original source system. This is applicable if the service request message was imported from another system. -
parentMessage:
parentMessage
-
postedByParty:
postedByParty
-
privateInformationFlag: boolean
Title:
Contains PII DataRead Only:trueIndicates whether the message contains personally identifiable information. -
processingStatusCode:
processingStatusCode
-
richTextFlag: boolean
Title:
Rich TextRead Only:trueDefault Value:trueIndicates whether the message content is in rich text format. -
sentDate: string
(date-time)
Title:
Sent DateRead Only:trueThe date and time when the message was sent. -
serviceRequest:
serviceRequest
-
source:
source
-
sourceCreatedBy: string
Title:
Source System Record Created-ByRead Only:trueThe user who created the message in the original source system. This is applicable if the service request message was imported from another system. -
sourceTimeUpdated: string
(date-time)
Title:
Last Update Date in Source SystemRead Only:trueThe date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system. -
sourceUpdatedBy: string
Title:
Source System Record Last-Updated-ByRead Only:trueThe user who last updated the message in the original source system. This is applicable if the service request message was imported from another system. -
statusCode:
statusCode
-
subject: string
Title:
SubjectRead Only:trueIndicates the subject of the service request message. -
templateName: string
Title:
Template NameRead Only:trueThe name of the template that's used for outbound communication of the message. -
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. -
visibilityCode:
visibilityCode
Nested Schema : Message
Type:
objectTitle:
MessageMessages contain information about communication updates made to the service request. It keeps a record of messages from agents and workers.
Nested Schema : aiLogLevelCode
Match All
Indicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE.
Show Source
Nested Schema : channelType
Match All
The channel type, such a email, phone, social, and so on.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Channel Type
Title:
Channel TypeThe channel type, such a email, phone, social, and so on.
Nested Schema : messageSubType
Match All
The service request message subtype.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Message Subtype
Title:
Message SubtypeThe service request message subtype.
Nested Schema : messageType
Match All
The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Message Type Code
Title:
Message Type CodeThe message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
Nested Schema : parentMessage
Match All
Show Source
-
object
oraCxServiceCoreSrMgmt.Message_item-fields
-
object
__busObj_context
-
object
Parent Message
Title:
Parent Message
Nested Schema : postedByParty
Match All
Show Source
-
allOf
oraCxServiceCoreCommon.ServicePerson_item-fields
-
object
__busObj_context
-
object
Posted by Party
Title:
Posted by Party
Nested Schema : processingStatusCode
Match All
The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
Show Source
-
string
Title:
Processing StatusRead Only:trueThe processing status of the message. The accepted values are Ready, Processing, Error, and Success. -
string
Allowed Values:
[ "ORA_SVC_BATCH_READY", "ORA_SVC_ERROR", "ORA_SVC_PENDING_RETRY", "ORA_SVC_PROCESSING", "ORA_SVC_READY", "ORA_SVC_REPROCESSING", "ORA_SVC_SETUP_ERROR", "ORA_SVC_SUCCESS", "ORA_SVC_WAITING" ]
Nested Schema : serviceRequest
Match All
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
Show Source
-
object
oraCxServiceCoreSrMgmt.ServiceRequest_item-fields
-
object
__busObj_context
-
object
Base Request
Title:
Base RequestThe service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
Nested Schema : source
Match All
The source of the message.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Source Code
Title:
Source CodeThe source of the message.
Nested Schema : statusCode
Match All
The status of the message. The accepted values are Draft, Committed, and Corrected.
Show Source
Nested Schema : visibilityCode
Match All
The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item-allOf[0]
Type:
Show Source
objectNested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type:
Show Source
object-
$sourceLang: string
Read Only:
true -
createdBy: string
Read Only:
true -
description: string
Read Only:
true -
displaySequence: string
(big-integer)
Read Only:
true -
enabledFlag: boolean
Read Only:
true -
endDateActive: string
(date)
Read Only:
true -
lookupCategoryId: string
(big-integer)
Read Only:
true -
lookupCode: string
Read Only:
true -
lookupType: string
Read Only:
true -
meaning: string
Read Only:
true -
startDateActive: string
(date)
Read Only:
true -
tag: string
Read Only:
true -
timeCreated: string
(date-time)
Read Only:
true -
timeUpdated: string
(date-time)
Read Only:
true -
updatedBy: string
Read Only:
true
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields-allOf[1]
Type:
Show Source
object-
$sourceLang: string
Title:
Source LanguageThe language in which the values of the translatable columns were created, updated, or copied from. -
createdBy: string
Title:
Created ByThe user who created the record. -
description: string
Title:
Lookup Code DescriptionThe translated description of the Lookup Code. -
displaySequence: string
Title:
Display SequenceThe display sequence of the Lookup Code. -
enabledFlag: boolean
Title:
Lookup Code EnabledThe enabled flag of the Lookup Code. -
endDateActive: string
Title:
End Date ActiveThe active end date of the Lookup Code. -
lookupCategoryId: string
Title:
Lookup CategoryThe lookup category of the Lookup Code. -
lookupCode: string
Title:
Lookup Code IDThe unique identifier of the Lookup Code. -
lookupType: string
Title:
Lookup Type IDThe unique identifier of the Lookup Type. -
meaning: string
Title:
Lookup Code MeaningThe translated meaning of the Lookup Code. -
startDateActive: string
Title:
Start Date ActiveThe active start date of the Lookup Code. -
tag: string
Title:
Lookup TagThe tag value of the Lookup Code. -
timeCreated: string
Title:
Created OnThe date and time when the record was created. -
timeUpdated: string
Title:
Last Updated DateThe date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated ByThe user who last updated the record.
Nested Schema : Channel Type
Type:
objectTitle:
Channel TypeThe channel type, such a email, phone, social, and so on.
Nested Schema : owningType
Match All
The standard lookup types list of values resource is used to query the list of standard lookup types.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupType_item-fields
-
object
__busObj_context
-
object
Standard Lookup Type
Title:
Standard Lookup TypeThe standard lookup types list of values resource is used to query the list of standard lookup types.
Nested Schema : oraCommonAppsInfraObjects.LookupType_abstract-item
Type:
Show Source
object-
$sourceLang: string
Read Only:
true -
configurationLevel:
configurationLevel
-
createdBy: string
Read Only:
true -
description: string
Read Only:
true -
lookupCategoryId: string
(big-integer)
Read Only:
true -
lookupType: string
Read Only:
true -
meaning: string
Read Only:
true -
restAccessSecured:
restAccessSecured
-
taxonomyNode:
taxonomyNode
-
timeCreated: string
(date-time)
Read Only:
true -
timeUpdated: string
(date-time)
Read Only:
true -
updatedBy: string
Read Only:
true
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields-allOf[1]
Type:
Show Source
object-
$sourceLang: string
Title:
Source LanguageThe language in which the values of the translatable columns were created, updated, or copied from. -
configurationLevel: string
Title:
Configuration LevelThe configuration level of the Lookup Type. -
createdBy: string
Title:
Created ByThe user who created the record. -
description: string
Title:
Lookup Type DescriptionThe translated description of the Lookup Type. -
lookupCategoryId: string
Title:
Lookup CategoryThe lookup category of the Lookup Code. -
lookupType: string
Title:
Lookup Type IDThe unique identifier of the Lookup Type. -
meaning: string
Title:
Lookup Type MeaningThe translated meaning of the Lookup Type. -
restAccessSecured: string
Title:
REST Access SecuredThe rest access secured value of the Lookup Type. -
timeCreated: string
Title:
Created OnThe date and time when the record was created. -
timeUpdated: string
Title:
Last Updated DateThe date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated ByThe user who last updated the record.
Nested Schema : Standard Lookup Type
Type:
objectTitle:
Standard Lookup TypeThe standard lookup types list of values resource is used to query the list of standard lookup types.
Nested Schema : taxonomyNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
-
allOf
oraCommonAppsInfraObjects.TaxonomyNode_item-fields
-
object
__busObj_context
-
object
Taxonomy Node
Title:
Taxonomy NodeThe taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_abstract-item
Type:
Show Source
object-
$sourceLang: string
Read Only:
true -
alternativeId: string
(big-integer)
Read Only:
true -
createdBy: string
Read Only:
true -
description: string
Read Only:
true -
hierarchySource:
hierarchySource
-
moduleGUID: string
Read Only:
true -
moduleKey: string
Read Only:
true -
moduleName: string
Read Only:
true -
moduleType:
moduleType
-
timeCreated: string
(date-time)
Read Only:
true -
timeUpdated: string
(date-time)
Read Only:
true -
updatedBy: string
Read Only:
true -
userModuleName: string
Read Only:
true
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]
Type:
Show Source
object-
$sourceLang: string
Title:
Source LanguageThe language in which the values of the translatable columns were created, updated, or copied from. -
alternativeId: string
Title:
Alternative IDThe alternative identifier of the taxonomy node. -
createdBy: string
Title:
Created ByThe user who created the record. -
description: string
Title:
Module DescriptionThe translated description of the taxonomy node. -
moduleGUID: string
Title:
Module GUIDThe unique identifier of the taxonomy node. -
moduleKey: string
Title:
Module KeyThe unique identifier of the module. -
moduleName: string
Title:
Module NameThe descriptive name of the taxonomy node. -
moduleType: string
Title:
Module TypeThe type of the taxonomy node. -
timeCreated: string
Title:
Created OnThe date and time when the record was created. -
timeUpdated: string
Title:
Last Updated DateThe date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated ByThe user who last updated the record. -
userModuleName: string
Title:
User Module NameThe translated visible name of the taxonomy node.
Nested Schema : Taxonomy Node
Type:
objectTitle:
Taxonomy NodeThe taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : hierarchySource
Match All
The taxonomy hierarchy represents relationships between taxonomy nodes.
Show Source
-
object
oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields
-
object
__busObj_context
-
object
Taxonomy Hierarchy
Title:
Taxonomy HierarchyThe taxonomy hierarchy represents relationships between taxonomy nodes.
Nested Schema : oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueThe user who created the record. -
sourceModuleGUID: string
Title:
Source Module GUIDRead Only:trueThe unique identifier of the source taxonomy node. -
sourceNode:
sourceNode
-
targetModuleGUID: string
Title:
Target Module GUIDRead Only:trueThe unique identifier of the target taxonomy node. -
targetNode:
targetNode
-
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 : Taxonomy Hierarchy
Type:
objectTitle:
Taxonomy HierarchyThe taxonomy hierarchy represents relationships between taxonomy nodes.
Nested Schema : sourceNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
-
allOf
oraCommonAppsInfraObjects.TaxonomyNode_item-fields
-
object
__busObj_context
-
object
Taxonomy Node
Title:
Taxonomy NodeThe taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : targetNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
-
allOf
oraCommonAppsInfraObjects.TaxonomyNode_item-fields
-
object
__busObj_context
-
object
Taxonomy Node
Title:
Taxonomy NodeThe taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : Taxonomy Node
Type:
objectTitle:
Taxonomy NodeThe taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : Taxonomy Node
Type:
objectTitle:
Taxonomy NodeThe taxonomy node list of values resource is used to query the taxonomy nodes.
Nested Schema : Message Subtype
Type:
objectTitle:
Message SubtypeThe service request message subtype.
Nested Schema : Message Type Code
Type:
objectTitle:
Message Type CodeThe message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
Nested Schema : Parent Message
Type:
objectTitle:
Parent MessageNested Schema : oraCxSalesCommonParty.Party_abstract-item
Type:
Show Source
object-
id: string
(big-integer)
Read Only:
true -
name: string
Read Only:
true -
registryId: string
Read Only:
true -
status:
status
Nested Schema : oraCxServiceCoreCommon.ServicePerson_item-fields-allOf[2]
Type:
Show Source
object-
id: string
Title:
Party IDThe unique identifier of the party. -
name: string
Title:
Party NameThe name of the party. -
registryId: string
Title:
Registry IDThe public key generated or user-entered for a given party. -
status: string
Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.
Nested Schema : Posted by Party
Type:
objectTitle:
Posted by PartyNested Schema : oraCxServiceCoreSrMgmt.ServiceRequest_item-fields
Type:
Show Source
object-
assigneeResource:
assigneeResource
-
assistedByHumanFlag: boolean
Title:
Assisted by Human FlagIndicates whether human agents worked on the service request at any stage of its lifecycle. -
businessUnit:
businessUnit
-
category:
category
-
channelType:
channelType
-
closedDate: string
(date-time)
Title:
Date ClosedThe date when the service request was closed, if closed. -
createdBy: string
Title:
Created ByRead Only:trueThe user who created the record. -
createdByParty:
createdByParty
-
criticalFlag: boolean
Title:
CriticalIndicates whether the service request is critical. If critical, the value is Y, else the value is N. -
customer:
customer
-
firstTransferDate: string
(date-time)
Title:
First Transfer DateRead Only:trueThe date when the service request was first transferred. -
handledByAIFlag: boolean
Title:
Handled by AI FlagIndicates whether automation agents acted upon the service request at any point in its lifecycle. -
id: string
(big-integer)
Title:
Service Request IDRead Only:trueThe unique identifier of the service request record. -
installedBaseAsset:
installedBaseAsset
-
internalPriority:
internalPriority
-
languageCode: string
Title:
Language CodeRead Only:trueThe customer's preferred language for the service request. -
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. -
lastTransferDate: string
(date-time)
Title:
Last Transfer DateRead Only:trueIndicates the date and time of the last transfer of the service request. -
lastTransferredBy: string
Title:
Last Transferred ByRead Only:trueThe user who last transferred the service request. -
lastUpdatedByParty:
lastUpdatedByParty
-
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. -
originalSystemReference: string
Title:
Original SystemRead Only:trueThe reference to the service request record in the original system from which service request was imported (if imported). -
ownerTypeCode:
ownerTypeCode
-
primaryContact:
primaryContact
-
problemDescription: string
Title:
Problem DescriptionThe service request's problem description or statement and the steps to reproduce the issue. -
problemType:
problemType
-
productGroup:
productGroup
-
productItem:
productItem
-
purchaseOrder: string
Title:
Purchase OrderThe purchase order associated with the service request. -
queue:
queue
-
reportedByParty:
reportedByParty
-
resolution:
resolution
-
resolvedBy: string
Title:
Resolved ByRead Only:trueThe user who resolved the service request. -
resolvedByAIFlag: boolean
Title:
Resolved by AI FlagIndicates whether the service request was resolved with the assistance of automation agents. -
resolvedByParty:
resolvedByParty
-
resolveDescription: string
Title:
Solution DescriptionRead Only:trueThe description of how the service request has been resolved. -
resolveOutcome:
resolveOutcome
-
severity:
severity
-
source:
source
-
sourceCreatedBy: string
Title:
Source System SR Created ByRead Only:trueThe user who created the service request. -
sourceTimeUpdated: string
(date-time)
Title:
Last Update Date in Source SystemRead Only:trueThe date and time when the service request was last updated. -
sourceUpdatedBy: string
Title:
Source System SR Last Updated ByRead Only:trueThe user who last updated the service request. -
sourceUpdatedByParty:
sourceUpdatedByParty
-
status:
status
-
statusType:
statusType
-
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. -
transferCount: string
(big-integer)
Title:
Transfer CountRead Only:trueThe count showing how many times a service request has been transferred. -
transferNote: string
Title:
Transfer NoteRead Only:trueThis field contains information about transfer note. -
transferReason:
transferReason
-
uniqueExternalSystemReference: string
Title:
Unique External System Reference NumberThe unique alternative identifier of the service request in the original reference system. You can this column to store the identifier of the service request in the external application you're integrating with. -
updatedBy: string
Title:
Last Updated ByRead Only:trueThe user who last updated the record.
Nested Schema : Base Request
Type:
objectTitle:
Base RequestThe service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
Nested Schema : assigneeResource
Match All
Show Source
-
object
oraCxSalesCommonResourceMgmt.Resource_item-fields
-
object
__busObj_context
-
object
Assignee Resource
Title:
Assignee Resource
Nested Schema : businessUnit
Match All
Show Source
-
object
__busObj_context
-
object
Business Unit
Title:
Business Unit
Nested Schema : category
Match All
Show Source
-
object
__busObj_context
-
object
Category
Title:
Category
Nested Schema : channelType
Match All
The channel type.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Channel Type
Title:
Channel TypeThe channel type.
Nested Schema : createdByParty
Match All
Show Source
-
object
__busObj_context
-
object
Created by Party
Title:
Created by Party
Nested Schema : customer
Match All
Show Source
-
object
__busObj_context
-
object
Customer
Title:
Customer
Nested Schema : installedBaseAsset
Match All
The unique identifier of the associated install base asset record.
Show Source
-
object
__busObj_context
-
object
Installed Base Asset ID
Title:
Installed Base Asset IDThe unique identifier of the associated install base asset record.
Nested Schema : internalPriority
Match All
The internal priority of the service request.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Internal Priority Code
Title:
Internal Priority CodeThe internal priority of the service request.
Nested Schema : lastUpdatedByParty
Match All
Show Source
-
object
__busObj_context
-
object
Last Updated by Party
Title:
Last Updated by Party
Nested Schema : ownerTypeCode
Match All
The type of the service request owner. For example, customer or partner.
Show Source
Nested Schema : primaryContact
Match All
Show Source
-
object
__busObj_context
-
object
Primary Contact
Title:
Primary Contact
Nested Schema : problemType
Match All
The problem code of the service request.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Problem Type Code
Title:
Problem Type CodeThe problem code of the service request.
Nested Schema : productGroup
Match All
Show Source
-
object
__busObj_context
-
object
Product Group
Title:
Product Group
Nested Schema : productItem
Match All
Show Source
-
object
__busObj_context
-
object
Product
Title:
Product
Nested Schema : reportedByParty
Match All
Show Source
-
object
__busObj_context
-
object
Reported by Party
Title:
Reported by Party
Nested Schema : resolution
Match All
The resolution code of the service request.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Resolution Code
Title:
Resolution CodeThe resolution code of the service request.
Nested Schema : resolvedByParty
Match All
Show Source
-
object
__busObj_context
-
object
Resolved by Party
Title:
Resolved by Party
Nested Schema : resolveOutcome
Match All
The outcome of a service request resolution.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Outcome
Title:
OutcomeThe outcome of a service request resolution.
Nested Schema : severity
Match All
The severity of the service request.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Severity Code
Title:
Severity CodeThe severity of the service request.
Nested Schema : source
Match All
Indicates how the service request was created.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Source Code
Title:
Source CodeIndicates how the service request was created.
Nested Schema : sourceUpdatedByParty
Match All
Show Source
-
object
__busObj_context
-
object
Source Updated by Party
Title:
Source Updated by Party
Nested Schema : status
Match All
The status code of the service request.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Status
Title:
StatusThe status code of the service request.
Nested Schema : statusType
Match All
The status type of the service request.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Status Type
Title:
Status TypeThe status type of the service request.
Nested Schema : transferReason
Match All
The lookup code that indicates the transfer reason.
Show Source
-
allOf
oraCommonAppsInfraObjects.StandardLookupCode_item-fields
-
object
__busObj_context
-
object
Transfer Reason
Title:
Transfer ReasonThe lookup code that indicates the transfer reason.
Nested Schema : oraCxSalesCommonResourceMgmt.Resource_item-fields
Type:
Show Source
object-
createdBy: string
Read Only:
trueThe user who created the record. -
endDateActive: string
(date)
Title:
To DateRead Only:trueThe date after which the resource is no longer available for transaction assignment. -
id: string
(big-integer)
Title:
Resource Profile IDRead Only:trueThe unique identifier of the resource profile. -
partyId: string
(big-integer)
Title:
Party IDRead Only:trueThe unique identifier of the party associated to the resource profile. -
person:
person
-
registryId: string
Title:
Registry IDRead Only:trueThe alternate unique identifier of the party. -
startDateActive: string
(date)
Title:
From DateRead Only:trueThe date when the resource becomes available for transaction assignment. -
timeCreated: string
(date-time)
Read Only:
trueThe date and time when the record was created. -
timeUpdated: string
(date-time)
Read Only:
trueThe date and time when the record was last updated. -
updatedBy: string
Read Only:
trueThe user who last updated the record.
Nested Schema : Assignee Resource
Type:
objectTitle:
Assignee ResourceNested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item
Match All
Resource Person records essential details pertaining to an individual within the resource framework.
Show Source
-
allOf
oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields
-
object
Resource Person
Title:
Resource PersonResource Person records essential details pertaining to an individual within the resource framework.
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields-allOf[0]
Type:
Show Source
object-
internalFlag: boolean
Title:
InternalRead Only:trueDefault Value:falseIndicates whether the person is an internal member of the organization. If Y, the person is an internal member. For example, employee or retired employee. If N they're an external person. For example, partner contact, supplier contact. Default value is set to N. -
middleName: string
Title:
Middle NameThe middle name of the person. -
name: string
Title:
NameRead Only:trueThe combination of title, first, middle, last, and suffix names of the person.
Nested Schema : oraCxSalesCommonParty.Person_abstract-item
Type:
Show Source
object-
comments: string
-
doNotCallFlag: boolean
Default Value:
false -
doNotContactFlag: boolean
Default Value:
false -
doNotMailFlag: boolean
Default Value:
false -
firstName: string
-
gender:
gender
-
id: string
(big-integer)
Read Only:
true -
jobTitle: string
-
jobTitleCode:
jobTitleCode
-
lastName: string
-
middleName: string
-
name: string
Read Only:
true -
preferredContactMethod:
preferredContactMethod
-
registryId: string
-
salutation: string
-
salutoryIntroduction:
salutoryIntroduction
-
timezone:
timezone
-
title: string
Nested Schema : oraCxSalesCommonResourceMgmt.ResourcePerson_item-fields-allOf[2]
Type:
Show Source
object-
comments: string
Title:
CommentsThe free text comments about the person. -
doNotCallFlag: boolean
Title:
Do Not CallIndicates whether the person can be called or not. If the value is True, then the person must not be called. The default is False. A list of accepted values is defined using the lookup YES_NO. -
doNotContactFlag: boolean
Title:
Do Not ContactIndicates whether the person can be contacted or not by phone, e-mail, or mail. If the value is True, then the person must not be contacted. The default is False. A list of accepted values is defined using the lookup YES_NO. -
doNotMailFlag: boolean
Title:
Do Not MailIndicates whether the person can be sent mail or not. If the value is True, then the person must not be sent mail. The default is False. A list of accepted values is defined using the lookup YES_NO. -
firstName: string
Title:
First NameFirst name of the person. -
gender: string
Title:
GenderThe gender of the person as identified by them. A list of accepted values are defined in the lookup HZ_GENDER. -
id: string
Title:
Person IDThe unique identifier of the person profile. -
jobTitle: string
Title:
Job TitleThe free form text for job title of the person. -
jobTitleCode: string
Title:
Job Title CodeThe code given to the job title. -
lastName: string
Title:
Last NameThe last name of the person. -
preferredContactMethod: string
Title:
Preferred Contact MethodThe preferred communication method of a person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. -
registryId: string
Title:
Registry IDThe alternate identifier of the contact. -
salutation: string
Title:
SalutationThe phrase used to address a contact party in any correspondence. -
salutoryIntroduction: string
Title:
PrefixContains titles or honorifics preceding a person's name, like Mr., Mrs., Ms., and so on. For example, Mr. in Mr. John Smith. -
title: string
Title:
TitleA professional or family title, such as Don or The Right Honorable.
Nested Schema : Resource Person
Type:
objectTitle:
Resource PersonResource Person records essential details pertaining to an individual within the resource framework.
Nested Schema : jobTitleCode
Match All
Show Source
-
string
-
string
Allowed Values:
[ "ACCOUNTANT", "ACCOUNTS_PAYABLE_SPECIALIST", "ADMINISTRATOR", "ANALYST", "ARCHITECT", "ARTIST", "ASSISTANT", "ASSOCIATE", "ATTORNEY", "AUDITOR", "BROKER", "BUYER", "CEO", "CFO", "CHAIRMAN", "CIO", "CONSULTANT", "CONTRLR", "COO", "CTO", "DESIGNER", "DEVELOPER", "DIRECTOR", "EDITOR", "ENGINEER", "MANAGER", "OFFICER", "OPERATOR", "OWNER", "PARALEGAL", "PARTNER", "PHYSICIAN", "PLANNER", "PRESIDENT", "PRODUCER", "RECEPTIONIST", "REPORTER", "REPRESENTATIVE", "RESEARCHER", "STAFF", "SUPERVISOR", "TRAINER", "VICE PRESIDENT", "WRITER" ]
Nested Schema : oraCommonAppsInfraObjects.Timezone_item
Match All
The time zones list of values resource is used to query the time zones.
Show Source
-
object
oraCommonAppsInfraObjects.Timezone_item-fields
-
object
Time Zone
Title:
Time ZoneThe time zones list of values resource is used to query the time zones.
Nested Schema : oraCommonAppsInfraObjects.Timezone_item-fields
Type:
Show Source
object-
$sourceLang: string
Title:
Source LanguageRead Only:trueThe language in which the values of the translatable columns were created, updated, or copied from. -
createdBy: string
Title:
Created ByRead Only:trueThe user who created the record. -
enabledFlag: boolean
Title:
Time Zone EnabledRead Only:trueIndicates if the time zone is enabled. -
name: string
Title:
Time Zone NameRead Only:trueThe name of the time zone. -
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. -
timezoneCode: string
Title:
Time Zone CodeRead Only:trueThe unique code that identifies the time zone. -
updatedBy: string
Title:
Last Updated ByRead Only:trueThe user who last updated the record.
Nested Schema : Time Zone
Type:
objectTitle:
Time ZoneThe time zones list of values resource is used to query the time zones.
Nested Schema : timezone-allOf[2]
Type:
objectNested Schema : Business Unit
Type:
objectTitle:
Business UnitNested Schema : Category
Type:
objectTitle:
CategoryNested Schema : Channel Type
Type:
objectTitle:
Channel TypeThe channel type.
Nested Schema : Created by Party
Type:
objectTitle:
Created by PartyNested Schema : Customer
Type:
objectTitle:
CustomerNested Schema : Installed Base Asset ID
Type:
objectTitle:
Installed Base Asset IDThe unique identifier of the associated install base asset record.
Nested Schema : Internal Priority Code
Type:
objectTitle:
Internal Priority CodeThe internal priority of the service request.
Nested Schema : Last Updated by Party
Type:
objectTitle:
Last Updated by PartyNested Schema : Primary Contact
Type:
objectTitle:
Primary ContactNested Schema : Problem Type Code
Type:
objectTitle:
Problem Type CodeThe problem code of the service request.
Nested Schema : Product Group
Type:
objectTitle:
Product GroupNested Schema : Product
Type:
objectTitle:
ProductNested Schema : Queue
Type:
objectTitle:
QueueNested Schema : Reported by Party
Type:
objectTitle:
Reported by PartyNested Schema : Resolution Code
Type:
objectTitle:
Resolution CodeThe resolution code of the service request.
Nested Schema : Resolved by Party
Type:
objectTitle:
Resolved by PartyNested Schema : Outcome
Type:
objectTitle:
OutcomeThe outcome of a service request resolution.
Nested Schema : Severity Code
Type:
objectTitle:
Severity CodeThe severity of the service request.
Nested Schema : Source Code
Type:
objectTitle:
Source CodeIndicates how the service request was created.
Nested Schema : Source Updated by Party
Type:
objectTitle:
Source Updated by PartyNested Schema : Status
Type:
objectTitle:
StatusThe status code of the service request.
Nested Schema : Status Type
Type:
objectTitle:
Status TypeThe status type of the service request.
Nested Schema : Transfer Reason
Type:
objectTitle:
Transfer ReasonThe lookup code that indicates the transfer reason.
Nested Schema : Source Code
Type:
objectTitle:
Source CodeThe source of the message.
Nested Schema : oraCxServiceCoreSrMgmt.MessageAttachment_item
Match All
Message attachment contains information about files or documents attached to messages associated with a service request.
Show Source
-
allOf
oraCxServiceCoreSrMgmt.MessageAttachment_item-fields
-
object
Service Request Message Attachment
Title:
Service Request Message AttachmentMessage attachment contains information about files or documents attached to messages associated with a service request.
Nested Schema : oraCxServiceCoreSrMgmt.MessageAttachment_item-fields-allOf[0]
Type:
Show Source
objectNested Schema : oraCommonAppsInfraAttachments.Attachment_abstract-item
Type:
Show Source
object-
createdBy: string
Read Only:
true -
document:
document
-
id: string
(big-integer)
Read Only:
true -
timeCreated: string
(date-time)
Read Only:
true -
timeUpdated: string
(date-time)
Read Only:
true -
updatedBy: string
Read Only:
true
Nested Schema : oraCxServiceCoreSrMgmt.MessageAttachment_item-fields-allOf[2]
Type:
Show Source
object-
createdBy: string
Title:
Created ByThe user who created the record. -
id: string
Title:
Attachment IDThe unique identifier of the attachment. -
timeCreated: string
Title:
Created OnThe date and time when the record was created. -
timeUpdated: string
Title:
Last Updated DateThe date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated ByThe user who last updated the record.
Nested Schema : Service Request Message Attachment
Type:
objectTitle:
Service Request Message AttachmentMessage attachment contains information about files or documents attached to messages associated with a service request.
Nested Schema : document
Match All
The name of the accessor used to retrieve the document.
Show Source
-
allOf
oraCommonAppsInfraAttachments.Document_item-fields
-
object
__busObj_context
-
object
Document Accessor
Title:
Document AccessorThe name of the accessor used to retrieve the document.
Nested Schema : oraCommonAppsInfraAttachments.Document_abstract-item
Type:
Show Source
object-
$sourceLang: string
Read Only:
true -
chunkingDirectives: object
chunkingDirectives
-
contentEndpoint: string
Read Only:
true -
createdBy: string
Read Only:
true -
description: string
-
downloadParameters: object
downloadParameters
-
fileName: string
-
id: string
(big-integer)
Read Only:
true -
latestDocument:
latestDocument
-
managedEndpointKey: string
-
managedPath: string
-
managedUrl: string
Read Only:
true -
mediaType: string
-
name: string
-
securityGroup: string
Read Only:
true -
size: string
(big-integer)
-
timeCreated: string
(date-time)
Read Only:
true -
timeUpdated: string
(date-time)
Read Only:
true -
title: string
-
type:
type
-
undoCheckOutParameters: object
undoCheckOutParameters
-
updatedBy: string
Read Only:
true -
uploadParameters: object
uploadParameters
-
url: string
-
version: string
Nested Schema : oraCommonAppsInfraAttachments.Document_item-fields-allOf[1]
Type:
Show Source
object-
chunkingDirectives: object
Document
Title:
DocumentDirectives for customers uploading chunked files. -
contentEndpoint: string
Title:
Server EndpointEndpoint for the content server. -
createdBy: string
Title:
Created ByThe user who created the record. -
description: string
Title:
DescriptionThe description of the document. -
downloadParameters: object
Download Parameters
Title:
Download ParametersUsed to get the parameters required to download a file type document. -
fileName: string
Title:
File NameThe file name of a file type document. -
id: string
Title:
Document IDThe unique identifier of the document. -
managedEndpointKey: string
Title:
Endpoint KeyThe endpoint key from topology manager. -
managedPath: string
Title:
PathThe relative path of the managed URL. -
managedUrl: string
Title:
Managed URLThe URL that's a combination of the managed endpoint and path. -
mediaType: string
Title:
Media TypeThe media type of a file type document. -
name: string
Title:
NameThe name that identifies a file type of the stored document. -
securityGroup: string
Title:
Security GroupUsed to get the group where the file type documents are organized. -
size: string
Title:
SizeThe size of a file type document. -
timeCreated: string
Title:
Created OnThe date and time when the record was created. -
timeUpdated: string
Title:
Last Updated DateThe date and time when the record was last updated. -
title: string
Title:
TitleThe title of the document. -
type: string
Title:
TypeThe type of document. -
undoCheckOutParameters: object
Undo Check Out Parameters
Title:
Undo Check Out ParametersUsed to get the parameters required to undo the checkout of a document. -
updatedBy: string
Title:
Last Updated ByThe user who last updated the record. -
uploadParameters: object
Upload Parameters
Title:
Upload ParametersUsed to get the parameters required to upload a file type document. -
url: string
Title:
URLThe URL of a web page type document. -
version: string
Title:
VersionThe version of a file type document.
Nested Schema : Document Accessor
Type:
objectTitle:
Document AccessorThe name of the accessor used to retrieve the document.
Nested Schema : latestDocument
Match All
The latest version of the attached document.
Show Source
-
allOf
oraCommonAppsInfraAttachments.Document_item-fields
-
object
__busObj_context
-
object
Latest Document
Title:
Latest DocumentThe latest version of the attached document.
Nested Schema : chunkCount
Match All
The required number of chunked files to be uploaded to the content server.
Show Source
-
string(big-integer)
-
string
Title:
DocumentThe required number of chunked files to be uploaded to the content server.
Nested Schema : chunkSize
Match All
The required size of each chunked file to be uploaded to the content server.
Show Source
-
string(big-integer)
-
string
Title:
DocumentThe required size of each chunked file to be uploaded to the content server.
Nested Schema : prefix
Match All
The prefix used in the file names of the chunked files.
Show Source
Nested Schema : Latest Document
Type:
objectTitle:
Latest DocumentThe latest version of the attached document.
Nested Schema : Document
Type:
objectTitle:
DocumentDirectives for customers uploading chunked files.
Nested Schema : Download Parameters
Type:
objectTitle:
Download ParametersUsed to get the parameters required to download a file type document.
Nested Schema : Undo Check Out Parameters
Type:
objectTitle:
Undo Check Out ParametersUsed to get the parameters required to undo the checkout of a document.
Nested Schema : Upload Parameters
Type:
objectTitle:
Upload ParametersUsed to get the parameters required to upload a file type document.
Links
- $self
-
Parameters:
- serviceRequests-messages_id:
$request.path.serviceRequests-messages_id - serviceRequests_id:
$request.path.serviceRequests_id
- serviceRequests-messages_id:
- channelType
-
Parameters:
- standardLookupCodes_id:
$response.body#/channelType/$id
The channel type, such a email, phone, social, and so on. - standardLookupCodes_id:
- messageSubType
-
Parameters:
- standardLookupCodes_id:
$response.body#/messageSubType/$id
The service request message subtype. - standardLookupCodes_id:
- messageType
-
Parameters:
- standardLookupCodes_id:
$response.body#/messageType/$id
The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. - standardLookupCodes_id:
- serviceRequest
-
Parameters:
- serviceRequests_id:
$response.body#/serviceRequest/$id
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved. - serviceRequests_id:
- source
-
Parameters:
- standardLookupCodes_id:
$response.body#/source/$id
The source of the message. - standardLookupCodes_id:
Examples
The following example shows how to create an advanced query to get a message by submitting a POST request on the REST resource.
cURL Command
curl -X POST --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/{serviceRequests_id}/messages/{serviceRequests-messages_id}/$query'\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>
--data @request.json
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"fields": [
"id",
"number",
"title"
],
"collection": {
"sortBy": [{"timeUpdated": "desc"}],
"filter":"number='\''SR0000011001'\''"
},
"accessors": {
"messages": {
"fields":["messageContent"]
}
}
}
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items": [
{
"id": "300100122471257",
"number": "SR0000011001",
"title": "Request for Software Installation: Adobe Photoshop",
"$id": "SR0000011001",
"$context": {
"etag": "2",
"links": {
"$self": {
"href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/SR0000011001"
}
}
},
"messages": {
"items": [
{
"messageContent": "Respond Flag-N- Child Message",
"$id": "300100122471262",
"$context": {
"etag": "1",
"links": {
"$self": {
"href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/SR0000011001/messages/300100122471262"
}
}
}
},
{
"messageContent": "A contact could not be associated with the SR because no contact was available with the social handle 1139536692773011.",
"$id": "300100122471260",
"$context": {
"etag": "1",
"links": {
"$self": {
"href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/SR0000011001/messages/300100122471260"
}
}
}
}
],
"hasMore": false
}
}
],
"hasMore": false
}