Get a service request
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Request
Path Parameters
-
SrNumber(required): string
The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : serviceRequests-item-response
Type:
Show Source
object
-
AccountPartyEmailAddress: string
Title:
Account Party Email Address
Read Only:true
Maximum Length:320
The e-mail address of the account on the service request. -
AccountPartyFormattedPhoneNumber: string
Title:
Account Party Formatted Phone Number
Read Only:true
The formatted phone number of the account on the service request. -
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account party associated with the service request. -
AccountPartyName: string
Title:
Account Name
Read Only:true
Maximum Length:360
The name of the account party. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The public unique identifier of the account associated with the service request. -
AccountPartyPreferredContactMethod: string
Title:
Account Party Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of the account on the service request. -
AccountPartyUniqueName: string
Title:
Account
Maximum Length:900
The unique name to identify the account. -
activities: array
Activities
Title:
Activities
The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request. -
addresses: array
Service Addresses
Title:
Service Addresses
A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address. -
AffectedPartyAssignmentNumber: string
Title:
Affected Party Person Assignment Number
Maximum Length:50
The unique assignment number of the affected party person for the service request. -
AffectedPartyPersonId: string
Title:
Affected Party
The unique identifier of the affected person on the service request. This field is only applicable for the human resource help desk application. -
AffectedPartyPersonName: string
Title:
Affected Party Person Name
Read Only:true
The display name of the affected party person in the service request. -
AssetId: integer
(int64)
Title:
Asset
The unique identifier of the asset associated with the service request. -
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The asset number associated with the service request. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The serial number of the asset that is associated with the service request. -
AssigneeEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the assignee. -
AssigneeFormattedAddress: string
Title:
Assignee Formatted Address
Read Only:true
The formatted address of the service request assignee. -
AssigneeFormattedPhoneNumber: string
Title:
Assignee Phone
Read Only:true
The phone number of the resource to whom the service request is assigned. -
AssigneePartyId: integer
(int64)
Title:
Assigned to Party ID
Read Only:true
The unique identifier of the party object associated with the service request assignee. -
AssigneePersonName: string
Title:
Assigned To
Maximum Length:360
The name of the assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource ID
The foreign key of the party object associated with the service request assignee. -
AssigneeResourceNumber: string
Title:
Assigned to Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the assignee of the service request. -
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request. -
BillToCustomerAccountDescription: string
Title:
Bill-To Customer Account Description
Read Only:true
Maximum Length:240
The description of the customer account to be billed for work performed on the service request. -
BillToCustomerAccountId: integer
(int64)
Title:
Bill to Customer Account ID
The customer account to be billed for work performed on the service request. -
BillToCustomerAccountNumber: string
Title:
Bill-To Customer Account Number
Read Only:true
Maximum Length:30
The PUID for the customer account to be billed for work performed on the service request. -
BillToCustomerAccountSiteId: integer
(int64)
Title:
Bill to Customer Account Site ID
The customer account site to be billed for work performed on the service request. -
BillToCustomerAccountSiteUsageNumber: string
Title:
Bill-To Customer Account Site Usage Number
Maximum Length:255
The PUID for the customer account site bill-to usage. -
BillToCustomerId: integer
(int64)
Title:
Bill to Customer ID
The customer to be billed for work performed on the service request. -
BillToCustomerName: string
Title:
Bill-To Customer Name
Read Only:true
Maximum Length:360
The name of the customer to be billed for work performed on the service request. -
BillToCustomerNumber: string
Title:
Bill-To Customer Number
Read Only:true
Maximum Length:30
The PUID for the customer to be billed for work performed on the service request. -
BillToPartySiteFormattedAddress: string
Title:
Bill-To Party Site Formatted Address
Maximum Length:5000
The formatted address for the customer site to be billed for work performed on the service request. -
BillToPartySiteId: integer
(int64)
Title:
Bill-To Party Site ID
The address of the customer site to be billed for work performed on the service request. -
BillToPartySiteLocationId: integer
(int64)
Title:
Bill-To Party Site Location ID
Read Only:true
The location of the customer site to be billed for work performed on the service request. -
BillToPartySiteName: string
Title:
Bill-To Party Site Name
Read Only:true
Maximum Length:240
The name of the customer site to be billed for work performed on the service request. -
BillToPartySiteNumber: string
Title:
Bill-To Party Site Number
Read Only:true
Maximum Length:30
The PUID for the customer site to be billed for work performed on the service request. -
BUOrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit associated with the service request. -
BusinessUnitName: string
Title:
Business Unit Name
Read Only:true
Maximum Length:255
The name of the business unit associated with the service request. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case associated with the service request. -
CaseNumber: string
Title:
Case Number
Maximum Length:255
The public unique identifier of the case associated with the service request. -
CategoryCode: string
Title:
Category Code
Read Only:true
Maximum Length:290
Indicates the alternate key of the category associated to the service request. -
CategoryId: integer
(int64)
Title:
Category
The unique identifier of the service request category. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:400
The name of the category associated with the service request. -
channelCommunication: array
Channel Communications
Title:
Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers. -
ChannelId: integer
Title:
Channel
The unique identifier of the service request channel. -
ChannelTypeCd: string
Title:
Channel Type
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ChannelTypeCdMeaning: string
Title:
Channel Type Value
Read Only:true
Maximum Length:255
The display value of the channel type lookup code for the service request, such as Chat, Phone, or Email. -
ClosedDate: string
(date-time)
Title:
Date Closed
The date when the service request was closed (if closed). -
ComplianceFlag: boolean
Title:
Compliance
Read Only:true
Maximum Length:1
Indicates whether the milestone is compliant or not. The default value is true. -
contacts: array
Contact Members
Title:
Contact Members
The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the service request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the service request was created. -
CriticalFlag: boolean
Title:
Critical
Maximum Length:1
Default Value:false
Indicates whether the service request is critical. If critical, the value is Y, else the value is N. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether a service request is deleted and not to be displayed in the UI. The default value is false. -
DueDate: string
(date-time)
Title:
Due Date
Read Only:true
The date when the milestone is due. -
FirstTransferDate: string
(date-time)
Title:
First Transfer Date
The date when the service request was first transferred. -
HeaderFlag: boolean
Title:
Header
Read Only:true
Maximum Length:1
Indicates whether the milestone is a service request header milestone or not. -
IBAssetDescription: string
Title:
Installed Base Asset Description
Read Only:true
Maximum Length:240
The description of the installed base asset associated with the service request. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset ID
The unique identifier of the install base asset associated with the service request. -
IBAssetLocation: string
Title:
Installed Base Asset Location
Maximum Length:5000
The location address of the installed base asset associated with the service request. -
IBAssetLocationType: string
Title:
Installed Base Asset Location Type
Read Only:true
Maximum Length:80
The location type of the installed base asset associated with the service request. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The installed base asset number associated with the service request. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the install base asset associated with the service request. -
InternalPriorityCd: string
Title:
Internal Priority Code
Maximum Length:30
The code indicating the internal priority of the service request. For example, High, Normal, Low, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_INT_PRIORITY_CD. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated with the service request. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that is associated with the service request. -
LanguageCd: string
Title:
Language Code
Maximum Length:30
The code indicating the customer's preferred language for the service request. For example, en, fr, and so on. -
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 last resolved. -
LastTransferDate: string
(date-time)
Title:
Last Transfer Date
Indicates the date and time of the last transfer of the service request. -
LastTransferredBy: string
Title:
Last Transferred By
Maximum Length:64
The user who last transferred the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the service request was last updated. -
LastUpdatedBy: string
Title:
Last Updated by Login ID
Read Only:true
Maximum Length:64
The user who last updated the service request. -
LastUpdatedByDisplayName: string
Title:
Last Updated By
Read Only:true
Maximum Length:3600
The display name of the user who last update the service request. -
LastUpdatedByEmailAddress: string
Title:
Last Updated by Email Address
Read Only:true
Maximum Length:255
The e-mail address of the person who last updated the service request. -
LastUpdatedByPartyId: integer
(int64)
Title:
Last Updated by Party ID
The unique identifier of the party of the user who last updated the service request. -
LastUpdatedByPartyNumber: string
Title:
Last Updated by Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the person who last updated the service request. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login id of the user who last updated the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member
The unique identifier of the loyalty member associated with the customer contact. -
LoyMemberName: string
Title:
Loyalty Member
Maximum Length:100
The name of the loyalty member associated with the customer contact. -
LoyMemberNumber: string
Title:
Loyalty Member Number
Read Only:true
Maximum Length:30
The public unique loyalty member identifier of the service request primary contact. -
messages: array
Messages
Title:
Messages
The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.". -
MilestoneConfigId: integer
(int64)
Title:
Configuration ID
Read Only:true
The unique identifier of the milestone configuration. -
MilestoneLabel: string
Title:
Milestone Name
Read Only:true
Maximum Length:255
The display name of the milestone. -
MilestoneStatusCd: string
Title:
Milestone Status
Read Only:true
Maximum Length:255
The code indicating the status of the milestone. For example, In Progress, Complete. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE. -
OpenDate: string
(date-time)
Title:
Date Reported
The date when the service request was reported by the customer. Typically, the value is the same as Creation Date. However, if the service request was migrated from another system then the Creation Date is the date the SR was created and Date Reported is the date the customer reported the service request. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The reference to the service request record in the original system from which service request was imported (if imported). -
OwnerTypeCd: string
Title:
Owner Type
Maximum Length:30
The code indicating the type of the service request owner. For example, a customer or a partner. -
PartnerAccountPartyId: integer
(int64)
Title:
Partner Account Party ID
The unique identifier of the partner account party. -
PartnerAccountPartyName: string
Title:
Partner Account
Maximum Length:360
The name of the partner account party. Two accounts can have the same party name but not the same unique name. -
PartnerAccountPartyNumber: string
Title:
Partner Account Number
Read Only:true
Maximum Length:30
The public unique identifier of the partner account associated with the service request. -
PartnerAccountPartyUniqueName: string
Title:
Partner Account
Maximum Length:900
The unique name to identify the partner account. -
PrimaryContactAssignmentNumber: string
Title:
Primary Contact Person Assignment Number
Maximum Length:50
The unique assignment number of the primary contact of the service request. -
PrimaryContactDoNotContactFlag: boolean
Title:
Primary Contact Do Not Contact
Read Only:true
Maximum Length:1
Indicates that the primary contact of the service request does not want to be contacted. The default value is false. -
PrimaryContactEmailAddress: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
The e-mail address of the primary contact associated with the service request. -
PrimaryContactFormattedAddress: string
Title:
Primary Contact Formatted Address
Read Only:true
The formatted address of the primary contact of the service request. -
PrimaryContactFormattedPhoneNumber: string
Title:
Primary Contact Phone
Read Only:true
The phone number of the primary contact. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request. -
PrimaryContactPartyName: string
Title:
Primary Contact
Maximum Length:360
The name of the service request primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Number
Read Only:true
Maximum Length:30
The public unique identifier of the primary contact associated of the service request. -
PrimaryContactPartyUniqueName: string
Title:
Primary Contact Unique Name
Maximum Length:900
The unique party name associated with the primary contact. -
PrimaryContactPersonId: integer
(int64)
Title:
Primary Contact Person ID
The identifier of the primary contact person of the service request. This field is only applicable for the human resource help desk application. -
PrimaryContactPreferredContactMethod: string
Title:
Primary Contact Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of the primary contact of the service request. -
ProblemCd: string
Title:
Problem Type Code
Maximum Length:30
The code indicating the problem with a service request. A list of accepted values is defined in the lookup: ORA_SVC_SR_PROBLEM_TYPE_CD. For example, ORA_SVC_DOCS, ORA_SVC_PRODUCT. -
ProblemDescription: string
Title:
Problem Description
Maximum Length:1000
The service request's problem description/statement and the steps to reproduce the issue. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated with the service request. -
ProdGroupName: string
Title:
Product Group
Maximum Length:255
The name of the product group associated with the service request. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
The public unique identifier of the product associated with the service request. -
ProductItemDescription: string
Title:
Product Description
Maximum Length:255
The description of the product associated with the service request. -
ProductItemNumber: string
Title:
Product Number
Read Only:true
Maximum Length:255
The alternate key identifier of the product associated with the service request. -
ProductItemOrgId: integer
(int64)
Title:
Product Organization
Read Only:true
The unique identifier of the organization of the product that is associated with the service request. -
PurchaseOrder: string
Title:
Purchase Order
Maximum Length:50
The purchase order associated with the service request. -
QueueId: integer
(int64)
Title:
Assigned Queue ID
The unique identifier of the queue to which the service request is assigned. -
QueueName: string
Title:
Queue
Maximum Length:400
The name of the queue associated with the service request. -
QueueNumber: string
Title:
Queue Number
Read Only:true
Maximum Length:30
The public unique identifier of the service request queue. -
RecordSet: string
Title:
Search Filter
Read Only:true
The record set selected by the user. The selected record set is used to filter the search results. -
ReportedByEmailAddress: string
Title:
Reported by Email ID
Read Only:true
Maximum Length:320
The e-mail address of the person who reported the service request. -
ReportedByFormattedPhoneNumber: string
Title:
Reported by Phone Number
Read Only:true
The formatted phone number of the person who reported the service request. -
ReportedByPartyId: integer
(int64)
Title:
Reported by Party ID
The user who created the service request in the system. -
ReportedByPartyName: string
Title:
Reported By
Read Only:true
Maximum Length:360
The person who reported the service request. -
ReportedByPartyNumber: string
Title:
Reported by Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the person who reported the service request. -
ReportedByPartyUniqueName: string
Title:
Reported by Unique Name
Read Only:true
Maximum Length:900
The unique name of the user who created the service request. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
The code indicating the type of resolution of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD. -
ResolutionCdMeaning: string
Title:
Resolution Value
Read Only:true
The display value of the resolution lookup code for the service request, such as Satisfied. -
ResolvedBy: string
Title:
Resolved By
Maximum Length:64
The name of the person who initiated the resolution process. -
ResolveDescription: string
Title:
Solution Description
Maximum Length:1000
A brief description of how the problem was resolved. -
ResolveOutcomeCd: string
Title:
Outcome
Maximum Length:30
The code indicating the type of resolution that was achieved for the Service Request. -
ResolveOutcomeCdMeaning: string
Title:
Outcome Value
Read Only:true
The display value of the resolution outcome lookup code for the service request, such as Solution Provided. -
resourceMembers: array
Resources
Title:
Resources
Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The service profile associated with the service request. -
ServiceProfileName: string
Title:
Service Profile Name
Read Only:true
Maximum Length:400
The name of the service profile associated with the service request. -
ServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The PUID for the service profile associated with the service request. -
ServiceProfilePartySiteId: integer
(int64)
Title:
Service Profile Site ID
Read Only:true
The address of the service profile associated with the service request. -
ServiceProfilePartySiteLocationId: integer
(int64)
Title:
Service Profile Site Location ID
Read Only:true
The location of the service profile associated with the service request. -
ServiceProfilePartySiteName: string
Title:
Service Profile Site Party Name
Read Only:true
Maximum Length:240
The name of the address of the service profile associated with the service request. -
ServiceProfilePartySiteNumber: string
Title:
Service Profile Site Party Number
Read Only:true
Maximum Length:30
The PUID of the address of the service profile associated with the service request. -
ServiceProfileSiteFormattedAddress: string
Title:
Service Profile Formatted Address
Maximum Length:5000
The formatted address of the service profile associated with the service request. -
ServiceZoneId: integer
(int64)
Title:
Region Identifier
The unique identifier of the service request region. -
ServiceZoneName: string
Title:
Service Region
Read Only:true
Maximum Length:360
The name of the service request region. -
SeverityCd: string
Title:
Severity
Maximum Length:30
The code indicating the severity of the service request. For example, Sev1, Sev2, Sev3, and Sev4. -
SeverityCdMeaning: string
Title:
Severity Value
Read Only:true
The display value of the severity lookup code for the service request, such as High. -
SeverityColorCd: string
Title:
Severity Color Code
Read Only:true
The code indicating the color code for the service request severity. -
SeverityRank: integer
Title:
Severity Rank
Read Only:true
The code indicating the severity of the service request. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SocialPrivateFlag: boolean
Title:
Private Social Post
Maximum Length:1
Default Value:false
Indicates if the service request was created from a private social post. The default value is false. -
SourceCd: string
Title:
Source Code
Maximum Length:30
The code indicating how the service request was created in the application. For example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD . -
SrCreatedBy: string
Title:
Source System SR Created By
Maximum Length:64
The user who created the service request. -
SrId: integer
(int64)
Title:
Service Request ID
Read Only:true
The unique identifier of the service request record. -
srInteractionReferences: array
Interaction References
Title:
Interaction References
The interaction references resource is used to view the relationship between an interaction and a service request. -
SrLastUpdateDate: string
(date-time)
Title:
Last Update Date in Source System
The date and time when the service request was last updated. -
SrLastUpdatedBy: string
Title:
Source System SR Last Updated By
Maximum Length:64
The user who last updated the service request. It defaults to LAST_UPDATED_BY if null, or for migration, set to the user who last updated the row. -
SrLastUpdateLogin: string
Title:
Source System SR Last Updated by User Login ID
Maximum Length:32
The application login id of the user who last updated the service request. -
srMilestone: array
Milestones
Title:
Milestones
The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the milestone associated with the service request. -
SrNumber: string
Title:
Reference Number
Maximum Length:30
The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements. -
srReferences: array
Service Request References
Title:
Service Request References
The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request. -
srTags: array
Tags
Title:
Tags
The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request. -
StatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the service request. For example, New, InProgress, Waiting, Resolved, Closed, and so on. -
StatusCdMeaning: string
Title:
Status Value
Read Only:true
The display value of the status lookup code for the service request, such as New, or In-Progress. -
StatusTypeCd: string
Title:
Status Type
Read Only:true
Maximum Length:30
The code indicating the status type of the service request. The possible values are, New, In Progress, Waiting, Resolved, and Closed. -
StatusTypeCdMeaning: string
Title:
Status Type Value
Read Only:true
The display value of the status type lookup code for the service request, such as New, or Resolved. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The application stripe of the service request. -
SurveyResponseDate: string
(date-time)
Title:
Survey Response Date
Read Only:true
The date and time when the response to this survey was submitted to the survey vendor. -
SurveySentDate: string
(date-time)
Title:
Survey Sent Date
Read Only:true
The date and time when survey was last sent for this service request. -
TimeRemaining: string
Title:
Time Remaining
Read Only:true
The time remaining in the milestone. -
TimezoneCode: string
Title:
Time Zone Code
Maximum Length:50
The service request time zone optionally used for computing the milestone due date. -
Title: string
Title:
Title
Maximum Length:400
A brief title of the service request. -
TransferCount: integer
(int64)
Title:
Transfer Count
The count showing how many times a service request has been transferred. -
TransferNote: string
Title:
Transfer Note
Maximum Length:1500
This field contains information about transfer note. -
TransferReasonCd: string
Title:
Transfer Reason
Maximum Length:30
The lookup code that indicates the transfer reason. -
UniqueExternalSystemReference: string
Title:
Unique External System Reference Number
Maximum Length:255
The 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. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the service request has been updated. -
WarnedFlag: boolean
Title:
Warned
Read Only:true
Maximum Length:1
Indicates that the milestone passed the warning threshold.
Nested Schema : Activities
Type:
array
Title:
Activities
The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.
Show Source
Nested Schema : Service Addresses
Type:
array
Title:
Service Addresses
A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
Show Source
Nested Schema : Channel Communications
Type:
array
Title:
Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Contact Members
Type:
array
Title:
Contact Members
The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Interaction References
Type:
array
Title:
Interaction References
The interaction references resource is used to view the relationship between an interaction and a service request.
Show Source
Nested Schema : Milestones
Type:
array
Title:
Milestones
The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.
Show Source
Nested Schema : Service Request References
Type:
array
Title:
Service Request References
The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
Show Source
Nested Schema : Tags
Type:
array
Title:
Tags
The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.
Show Source
Nested Schema : serviceRequests-activities-item-response
Type:
Show Source
object
-
AccountAddress: string
Title:
Account Address
Read Only:true
The address of the related account. -
AccountId: integer
(int64)
Title:
Account ID
The unique identifier of the activity account, for example customer, organization, person, or partner. -
AccountIdAttr: integer
The unique identifier of the account. This attribute is for internal use.
-
AccountName: string
Title:
Account
The name of the account associated with the activity. -
AccountNameOsn: string
Title:
Social Account Name
The account name displayed in Oracle Social Network. -
AccountNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The public unique identifier of account associated with the activity. -
AccountPhoneNumber: string
Title:
Account Phone Number
Read Only:true
The phone number of the related account. -
AccountStatus: string
Read Only:
true
Maximum Length:1
The status of the associated account. -
AccountType: string
Read Only:
true
Maximum Length:30
The party type of the associated account. -
ActivityCreatedBy: string
Title:
Activity Created By
Read Only:true
Maximum Length:64
The user who created the activity. -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation Date
Read Only:true
The date when the record was created. -
ActivityDescription: string
(byte)
Title:
Description
A text area for capturing information about the activity. -
ActivityDirection: string
Read Only:
true
The direction of the interaction. -
ActivityEndDate: string
(date-time)
Title:
End Date
The date and time of when an appointment ends. The time when a task is completed. -
ActivityFilter: string
Read Only:
true
The attribute is used to add additional activity filter. This attribute is for internal use. -
ActivityFunctionCode: string
Title:
Activity
Maximum Length:30
The code indicating the function of the activity. -
ActivityFunctionCodeTrans: string
Title:
Activity
Maximum Length:255
The activity function code. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the record. -
ActivityMtgMinutes: string
(byte)
Title:
Meeting Minutes
The minutes of an activity meeting. -
ActivityNumber: string
Title:
Activity Number
Maximum Length:64
The unique number of the activity. The number can also be generated from an external source. -
ActivityOutcome: string
Read Only:
true
The outcome of the activity. -
ActivityPartialDescription: string
Title:
Short Description
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivityPriority: string
Title:
Priority
The priority of the activity (Internal Usage). -
ActivityStartDate: string
(date-time)
Title:
Start Date
The date and time when an appointment or a task begins. The default value for an appointment is null. The default value for a task is the date and time of when a task is created. -
ActivityStatus: string
Title:
Status
Read Only:true
The status of the activity. -
ActivitySubtypeCode: string
Title:
Subtype
Maximum Length:30
The code indicating the activity subtype that is dependent on the activity type. -
ActivityTimezone: string
The time zone that the activity needs to be created in, other than the default logged user's time zone preference.
-
ActivityType: string
Title:
Activity Type
The type of activity. -
ActivityTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type or category of the activity. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated Date
Read Only:true
The date when the record was last updated. -
ActivityUpdatedBy: string
Title:
Activity Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated Date
Read Only:true
The date when the record was last updated by the activity user. -
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Default Value:false
Indicates whether the appointment is for the entire day. If the value is True, the appointment is for the entire day. The default value is False. -
AppointmentStatus: string
Title:
Appointment Status
Maximum Length:30
The status of the appointment. -
ApptEndTime: string
(date-time)
Title:
End Time
The time when the activity ends. -
ApptStartTime: string
(date-time)
Title:
Start Time
The time when the activity starts. -
ArticleVersionId: string
Title:
Article Version ID
Maximum Length:64
The unique identifier of the article version. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of the assessment that is associated to the activity or the activity template. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of an asset. -
AssetName: string
Title:
Asset
The name of the asset associated with an activity. -
AssetNumber: string
Title:
Asset Number
The alternate key identifier of the activity. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The serial number of the associated asset. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:ZMM_ACTY_ACTIVITIES
The attachment of the entity name. -
AutoLogSource: string
Title:
Source System
Maximum Length:30
The name of the source for the activity. -
BpId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BuOrgId: integer
(int64)
Title:
Business Unit
The identifier for the business unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business Plan
The name of the business plan associated with the activity. -
BusinessPlanNumber: string
Title:
Business Plan Number
The public unique identifier of business plan associated with the activity. -
CalendarAccess: boolean
Indicates who has access to the calender.
-
CalendarRecurType: string
The activity recurrence type.
-
CalendarSubject: string
The subject of the activity.
-
CalendarSubjectDay: string
The title of the calender.
-
CalendarTimeType: string
The calender time type of the activity.
-
CallReportCount: integer
(int32)
Title:
Call Report Count
Default Value:0
A count of the number of call reports. -
CallReportUpcomingYN: string
Indicates the status of the call report for upcoming appointments.
-
CallReportYN: string
Indicates whether the activity is associated with a call report.
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the related campaign. -
CampaignName: string
Title:
Campaign
The name of the campaign associated with the activity. -
CampaignNumber: string
Title:
Campaign Number
The public unique identifier of the campaign associated with the activity. -
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
The case number associated with the activity. -
CaseTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The case title associated with the activity. -
CheckedInBy: string
Title:
Checked-In By
Maximum Length:64
The person who checked into a location. -
CheckedOutBy: string
Title:
Checked-Out By
Maximum Length:64
The person who checks out of a location. -
CheckinDate: string
(date-time)
Title:
Check-In Time
The date and time when a user checks in to a location. -
CheckinLatitude: number
Title:
Check-In Latitude
The latitude when a user checks in to a location. -
CheckinLongitude: number
Title:
Check-In Longitude
The longitude when a user checks in to a location. -
CheckoutDate: string
(date-time)
Title:
Check-Out Time
The date and time when a user checks out of a location. -
CheckoutLatitude: number
Title:
Check-Out Latitude
The latitude when a user checks out of a location. -
CheckoutLongitude: number
Title:
Check-Out Longitude
The longitude when a user checks out of a location. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the claim. -
ClaimName: string
Title:
MDF Claim
The name of the claim associated with the activity. -
ClaimNumber: string
Title:
Claim Number
The public unique identifier of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete. -
ContactIDAttr: integer
The unique identifier of the contact. This attribute is for internal use.
-
ContactNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The public unique identifier of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the activity. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the activity was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate
Maximum Length:30
The currency conversion rate type associated with the activity. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrentDateForCallReport: string
(date-time)
The current date for the Call Report.
-
CurrentDateForCallReportAttr: string
(date-time)
The current date of the call report. This attribute is for internal use.
-
CurrentSystemDtTransient: string
(date)
Read Only:
true
The current system date of the activity. -
CustomerAccountId: integer
(int64)
Title:
Customer Account ID
The unique identifier of the customer account related to the activity. -
DealId: integer
(int64)
Title:
Deal ID
The unique identifier of the related deal. -
DealNumber: string
Title:
Deal Registration
The alternate key identifier of the deal associated to the activity. The number can also be generated from an external source. -
DelegatorId: integer
(int64)
Title:
Delegator ID
The unique identifier of the user who delegated the activity to another activity resource. -
DelegatorName: string
Title:
Delegated By
The name of the user who delegated the activity to another activity resource. -
DeleteFlag: boolean
Read Only:
true
Indicates if the activity has been deleted. -
DerivedAccountId: integer
The unique identifier of the account.
-
DirectionCode: string
Title:
Direction
Maximum Length:30
The code indicating the direction of an activity. The options are inbound/outbound, optional. The default value is null. -
DismissAssignee: string
Title:
Dismissed
Indicates whether the assignee is dismissed. Valid values are Y and N. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Indicates if the calls that were logged for a past appointment are dismissed. -
DoNotCallFlag: boolean
Read Only:
true
Indicates whether the primary contact can be called. The default value is false. -
DueDate: string
(date)
Title:
Due Date
The date when task activity is due to be completed. -
Duration: number
Title:
Duration
The duration of an appointment or task. -
DynamicClaimLOVSwitcher: string
Read Only:
true
The attribute is used to Claim LOV. This attribute is for internal use. -
EmailSentDate: string
(date-time)
The date and time when the activity e-mail notifications are shared through Outlook.
-
EndDateForCallReport: string
(date-time)
The date when the call report ends.
-
EndDateForCallReportAttr: string
(date-time)
The end date of the call report. This attribute is for internal use.
-
EndDtRFAttr: string
(date-time)
The date when the activity ends. This attribute is for internal use.
-
ExternalContactEmail: string
Title:
Primary Email
Maximum Length:320
The e-mail address of an external contact. -
ExternalContactName: string
Title:
External Contact Name
Maximum Length:360
The name of an external contact. -
ExternallyOwnedFlag: boolean
Title:
Externally Owned
Maximum Length:1
Default Value:false
Indicates whether the activity is created by an external resource. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the fund request. -
FundRequestName: string
Title:
MDF Request
The name of the fund request associated with the activity. -
FundRequestNumber: string
Title:
Fund Request Number
The public unique identifier of the fund request associated with the activity. -
IbAssetId: integer
(int64)
Title:
IB Asset ID
The unique identifier of the installed base asset associated with the activity. -
IbAssetNumber: string
Title:
Installed Base Asset
The number of the installed base asset associated with the activity. -
IbAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the installed base asset associated with the activity. -
InstNumDerivedFrom: string
Default Value:
Y
The attribute identifies the recurrence mode. This attribute is for internal use. -
IsClientService: string
Default Value:
Y
This is obsolete and was for internal usage. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the activity was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the activity. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The unique identifier of the user who last logged in to the application. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the related lead. -
LeadIdAttr: integer
The unique identifier of the lead. This attribute is for internal use.
-
LeadName: string
Title:
Lead
The name of the activity lead. -
LeadNameOsn: string
Title:
Social Lead Name
The lead name displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead Number
The public unique identifier of the lead associated with the activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Location
Maximum Length:200
The location of the appointment. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier of the account or contact location. -
LoginUserRFAttr: integer
The login of the user of the activity. This attribute is for internal use.
-
MdfRequestId: integer
The unique identifier of the fund request.
-
MobileActivityCode: string
Title:
Mobile Activity Code
Maximum Length:50
The code indicating whether an external mobile was used for an activity. -
NotesLinkSourceCodeTransient: string
Read Only:
true
The note source object. -
ObjectiveId: integer
(int64)
Title:
Objective ID
The unique identifier of the objective. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the related opportunity. -
OpportunityIdAttr: integer
The unique identifier of the opportunity. This attribute is for internal use.
-
OpportunityName: string
Title:
Opportunity
The name of the opportunity associated with the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity Name
The opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity Number
The public unique identifier of the opportunity associated with the activity. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier to identify the orchestration process. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier to identify the orchestration step. -
OrigEntityCode: string
Maximum Length:
30
Default Value:ACTIVITY
The column to store the source of activity record during upgrade. -
OrigEntityNumber: string
Maximum Length:
64
The column to store the original user key of the object being upgraded to activity. -
OsnActivityId: integer
(int64)
The unique identifier of the activity.
-
OtherPartyPhoneNumber: string
Title:
Other Party Phone Number
Maximum Length:40
The inbound phone number that is used to make a call. Identifies the phone number dialed for outbound calls. -
OutcomeCode: string
Title:
Outcome
Maximum Length:30
The code indicating the outcome of the activity. -
OutlookAutoSyncFlag: boolean
Title:
Microsoft Auto-Synchronization
Maximum Length:1
Indicates whether an appointment was generated by the synchronization process from Microsoft 365. -
OutlookFlag: boolean
Title:
Outlook
Maximum Length:1
Default Value:false
Indicates whether the activity is created in Outlook. If the value is Y, then the activity is created in Outlook and synchronized. -
OutlookGlobalId: string
Title:
Outlook Global ID
Maximum Length:1024
The unique identifier of an appointment created from Microsoft 365. -
OutlookIdentifier: string
Title:
Outlook Identifier
Maximum Length:1024
The unique identifier for the activity in Outlook. -
OwnerAddress: string
Title:
Activity Owner Address
Read Only:true
The address of the activity owner. -
OwnerEmailAddress: string
Title:
Activity Owner Email
Read Only:true
Maximum Length:320
The e-mail address of the activity owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the activity owner. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of the owner of the activity. -
OwnerNameOsn: string
Title:
Social Owner Name
The owner name displayed in Oracle Social Network. -
OwnerPhoneNumber: string
Title:
Activity Owner Phone Number
Read Only:true
The phone number of the activity owner. -
ParentActivityId: integer
(int64)
Title:
Parent ID
The unique identifier of the related activity ID, only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The unique identifier of the parent activity. This attribute is for internal use.
-
PartialMtgMinutes: string
Title:
Short Meeting Minutes
Maximum Length:4000
A column that stores a truncated string of the meeting minutes. -
PartnerEnrollmentId: integer
(int64)
Title:
Enrollment ID
The unique identifier of the related program enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment Number
The surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party ID
The unique identifier of the party associated with the partner account. -
PartnerPartyName: string
Title:
Partner
Maximum Length:80
The name of the party associated with the partner account. -
PartnerPartyNumber: string
Title:
Partner Number
The public unique identifier of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the related partner program. -
PartnerProgramName: string
Title:
Program
The name of the partner program associated with the activity. -
PartnerProgramNumber: string
Title:
Program Number
The public unique identifier of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner Usage
Maximum Length:1
Default Value:false
Indicates whether the activity is created for an organization account with usage as Partner. -
PercentageComplete: number
Title:
Percentage Complete
Default Value:0
The amount of activity completed in percentage. This is a free form numeric value ranging from 0 to 100. -
PrimaryContactEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address of the primary contact for the activity. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the activity contact. -
PrimaryContactName: string
Title:
Primary Contact
The name of the primary contact of the activity. -
PrimaryContactNameOsn: string
Title:
Social Primary Contact Name
The primary contact name displayed in Oracle Social Network. -
PrimaryFormattedAddress: string
Title:
Primary Contact Address
Read Only:true
The formatted address information of the activity primary contact. -
PrimaryFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the primary contact. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The code indicating the priority of the activity. The default value is 2. The possible values are, 1, 2, or 3. -
PrivateFlag: boolean
Title:
Private
Maximum Length:1
Indicates whether the activity is private. -
RecordSet: string
Title:
Record Set
Maximum Length:255
The set of records to display in activity search. -
RecurDay: integer
(int64)
Title:
Day
The recurrence of an appointment on a specific day of the month. -
RecurEndDate: string
(date-time)
Title:
Ends
The date when a recurring activity ends. -
RecurEveryOptionFlag: boolean
Title:
Recurrence Option
Maximum Length:1
Indicates the frequency of recurrence of an activity. If the recurrence is everyday of the week, it is set to Y if it is weekdays only, it is set to N. The recurring options are every day, week, month, year, and so on. -
RecurExceptionFlag: boolean
Title:
Recurrence Exception
Maximum Length:1
Indicates if the appointment instance is updated outside the recurring appointment series. -
RecurFrequency: number
Title:
Repeat
The frequency with which the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
Friday
Maximum Length:1
Indicates if an appointment recurs every Friday. -
RecurMonFlag: boolean
Title:
Monday
Maximum Length:1
Indicates if an appointment recurs every Monday. -
RecurMonth: string
Title:
Month
Maximum Length:30
The recurrence of an appointment in a specified month. -
RecurNumberOfInstances: number
Title:
Number of Instances
The specific number of occurrences for the series, after which the recurring series ends. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance Date
The original date of a recurring appointment instance. -
RecurPattern: string
Title:
Pattern
Maximum Length:30
The recurring appointment for a specific week, for example, First, Second, Third, Fourth, Last. The recurrence can be monthly or yearly. -
RecurRecType: string
Title:
Recurrence Record Type
Maximum Length:1
Default Value:N
The type of recurrence of an Activity, for example "I" for instance, "S" for series, or "N" for non-recurring. For Internal Use Only. Do not populate it if Activity is of type Task. -
RecurSatFlag: boolean
Title:
Saturday
Maximum Length:1
Indicates if the activity recurs on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series ID
The unique identifier for the series that links instances of a series together. -
RecurSunFlag: boolean
Title:
Sunday
Maximum Length:1
Indicates if the activity recurs on Sunday. -
RecurThuFlag: boolean
Title:
Thursday
Maximum Length:1
Indicates if the activity recurs on Thursday. -
RecurTueFlag: boolean
Title:
Tuesday
Maximum Length:1
Indicates if the activity recurs on Tuesday. -
RecurTypeCode: string
Title:
Recurrence Type
Maximum Length:30
The code indicating how often an appointment recurs, for example Daily, Weekly, Monthly, or Yearly. -
RecurUpdatedAttributes: string
Title:
Recurrence Updated Attributes
Maximum Length:4000
The updated field references for recurring appointment exception records. -
RecurWedFlag: boolean
Title:
Wednesday
Maximum Length:1
Indicates if the activity recurs on Wednesday. -
RecurWeekday: string
Title:
Pattern Type
Maximum Length:30
The type of recurrence of an activity, for example Monday to Sunday, Weekday, Weekend, or a specific Day. -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity Type
Maximum Length:30
The activity that refers to the activity of a customer. To be used for adjustment only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference Customer
The unique identifier of the referenced customer who is associated with the activity. -
ReminderPeriod: string
Title:
Set Reminder
Indicates when the reminder should be sent. -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the activity owner. -
ResponseCode: string
Title:
Response
Indicates whether a reminder is required. -
SalesObjectiveName: string
Title:
Sales Objective
The name of the sales objective associated with the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective Number
The public unique identifier of sales objective associated with the activity. -
SearchDate: string
(date-time)
The date filter used in Search (Internal Usage).
-
SelectedFlag: boolean
Default Value:
false
The records selected for Mass Update (Internal Usage). -
ShowStatus: string
Title:
Show
Maximum Length:255
The show status of the the activity such as open, complete, or all activities. -
ShowTimeAs: string
Title:
Show Time As
The choice of display of time on your calendar for an activity. -
SmartActionContext: string
Title:
Smart Action Context
Maximum Length:4000
Stores metadata needed for smart action. -
SmartActionId: integer
(int64)
Title:
Smart Action ID
The smart action Identifier. Foreign key from zca_user_action. -
SortDate: string
(date-time)
Title:
Date
The date used to sort the activities. The sort date can be the appointment start date, the task due date, or the task complete date. -
SourceObjectCode: string
The code indicating the source object associated with the activity.
-
SourceObjectId: integer
The unique identifier of the object associated with the activity.
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request
The alternate key identifier of the service request. -
StartDateForCallReport: string
(date-time)
The date when the call report starts.
-
StartDateForCallReportAttr: string
(date-time)
The start date of the call report. This attribute is for internal use.
-
StartDtRFAttr: string
(date-time)
The date when the activity starts. This attribute is for internal use.
-
StatusCode: string
Title:
Status
Maximum Length:30
The status of the activity. The default value is Not Started. -
Subject: string
Title:
Subject
Maximum Length:500
The title of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted By
The user who submitted the Call Report. -
SubmittedByName: string
Title:
Submitted By
Maximum Length:255
The name of the user who submitted the Call Report. -
SubmittedDate: string
(date-time)
Title:
Submitted Date
The date and time when the Call Report was submitted. -
SwitchCallId: string
Title:
Switch Call ID
Maximum Length:128
The unique identifier of the call, on the external phone system. -
TaskReminderPeriod: string
Title:
Due Date Reminder
The reminder period for a task due date, such as one day before the task due date. -
TemplateDuration: number
Title:
Template Duration
The duration in number of days, for the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date. -
TemplateFlag: string
Title:
Template
Maximum Length:1
Default Value:N
Indicates whether this is a template activity. -
TemplateId: integer
(int64)
Title:
Template ID
Ithe identifier of the template associated with the activity. -
TemplateLeadTime: number
Title:
Lead Time
The lead time that is calculated from the activity start date, for the template activity. -
UpdateFlag: boolean
Read Only:
true
Indicates if the activity has been updated. -
UpgSourceObjectId: string
Read Only:
true
Maximum Length:64
The primary key value of the record in the source table that is upgraded. -
UpgSourceObjectType: string
Read Only:
true
Maximum Length:30
The source object type of the activity such as Appointment, Task, or Interaction. It indicates the source of the upgraded record. -
WebConferenceDetails: string
(byte)
Title:
Web Conference Details
The web conference details. -
WebConferenceId: string
Title:
Web Conference ID
Maximum Length:255
The unique identifier of the web conference. -
WebConferenceURL: string
Title:
Web Conference URL
Maximum Length:2000
The web conference join URL. -
WebconfSyncStatusFlag: boolean
Title:
Web Conference Synchronization
Maximum Length:1
The appointment interaction status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : serviceRequests-addresses-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first address line of the service address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line of the service address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line of the service address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line of the service address. -
AddressSourceCd: string
Title:
Address Source Code
Maximum Length:30
Indicates the source of the service address of the service request. For example, the address source can be account or contact. -
City: string
Title:
City
Maximum Length:60
The city of the service address. -
Country: string
Title:
Country
Maximum Length:2
The country of the service address. -
County: string
Title:
County
Maximum Length:60
The county of the service address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the service address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the service address was created. -
FormattedAddress: string
Title:
Formatted Address
Read Only:true
Maximum Length:1000
The formatted address value of the service address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the service address was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service address. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the service address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location ID
The location that was the source of the service address. -
PartySiteId: integer
(int64)
Title:
Party Site ID
The customer address that was the source of the service address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the service address. -
Province: string
Title:
Province
Maximum Length:60
The province of the service address. -
ServiceAddressId: integer
(int64)
Title:
Service Address ID
The unique identifier of the service address record. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request associated to the service address. -
State: string
Title:
State
Maximum Length:60
The state of the service address. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:50
The time zone of the service address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsDFFVL: array
AttachmentsDFFVL
-
AttachmentsPreview: array
Attachments Preview
Title:
Attachments Preview
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the attachment category. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of the data. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Attachments Preview
Type:
array
Title:
Attachments Preview
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-Attachment-AttachmentsDFFVL-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-Attachment-AttachmentsPreview-item-response
Type:
Show Source
object
-
ImageHeight: integer
Title:
Image Height
Read Only:true
The height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
The preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
The width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
The number of the page in the preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-channelCommunication-item-response
Type:
Show Source
object
-
ChannelAccountName: string
Title:
Account Name
Read Only:true
Maximum Length:400
The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like support@abc.com. -
ChannelDisplayName: string
Title:
Display Name
Maximum Length:400
The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short Name
Maximum Length:450
The public unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
CollabId: string
Title:
Collaboration ID
Read Only:true
Maximum Length:255
The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id. of a user. -
CollabName: string
Title:
Resource Name
Read Only:true
Maximum Length:400
The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource Identifier
The unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point ID
The unique identifier of the contact point record of the contact who is being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address and the contact point of a person for twitter would be the twitter handle. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the communication channel was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the channel communication has been updated. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Maximum Length:30
Default Value:SVC_SERVICE_REQUESTS
The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the person who is being communicated with. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the person who is being communicated with. The user can be an internal resource or a customer contact. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the contact associated with the service request communication. -
PartyViaEndPoint: string
Title:
Party Endpoint
Maximum Length:1000
The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of the person who is a contact on the service request. -
PostIdentifier: string
Title:
Post Identifier
Maximum Length:1000
The unique identifier of the social media post record that was used to create the service request or the service request message. -
ResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with. -
ResourceTypeCd: string
Title:
Resource Type
Read Only:true
Maximum Length:30
The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD. -
RoutingCd: string
Title:
Routing Code
Maximum Length:30
The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the channel communication has been deleted. -
ViaId: integer
(int64)
Title:
ID
Read Only:true
The unique identifier of the channel communication.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-contacts-item-response
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The service request access level granted to the contact. -
AccountName: string
Title:
Account Name
Read Only:true
Maximum Length:900
The primary account of the service request contact. -
ContactEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the party associated with the contact. -
ContactFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the party associated with the contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request contact. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The public unique identifier of the contact associated with the service request. -
ContactPreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of the party associated with the contact. -
ContactTypeCd: string
Title:
Contact Type
Maximum Length:30
The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique Name
Maximum Length:900
The unique party name associated with the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the contact has been deleted. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates whether the contact of the service request does not want to be contacted. The default value is false. -
FormattedAddress: string
Title:
Formatted Address
Read Only:true
The formatted address of the service request contact. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the service request contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login id of the user who last updated the contacts object associated with the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member ID
The unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person ID
The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the associated service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique number of the a service request. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the contact has been updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-item-response
Type:
Show Source
object
-
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message. -
channelCommunication: array
Channel Communications
Title:
Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers. -
ChannelId: string
Title:
Channel
The unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel Type
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
CollabResource: string
Title:
Collaboration Resource
This field is reserved for internal use only. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the message. -
CreatedByEmailAddress: string
Title:
Created by Email ID
Read Only:true
Maximum Length:320
The e-mail address of the person who created the service request message. -
CreatedByPartyId: string
Title:
Created by Party ID
Read Only:true
Maximum Length:80
The unique identifier of the party of the user who created the service request message. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the message was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the message has been deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the message was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the message. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated with the user who last updated the message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageContent: string
(byte)
Title:
Message Content
The content of the message encoded in base 64 format. Any attachment associated with the message is not the content of the message. -
MessageCreatedBy: string
Title:
Created By
Maximum Length:64
The user who created the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageExpandingState: integer
Title:
Message Expand State
Indicates the message expanding state. -
MessageId: integer
(int64)
Title:
Message ID
The unique identifier of the service request message. -
MessageLastUpdateDate: string
(date-time)
Title:
Last Updated Date
The last updated date of the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdatedBy: string
Title:
Last Updated By
Maximum Length:64
The user who last update the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdateLogin: string
Title:
Last Update Login
Maximum Length:32
The login of the user who last update the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageNumber: string
Title:
Message Number
Maximum Length:30
The public unique identifier of the service request message. -
MessageSubTypeCd: string
Title:
Message Subtype
Maximum Length:30
The service request message subtype. -
MessageTypeCd: string
Title:
Message Type Code
Maximum Length:30
The code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_TYPE_CD. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE. -
NotificationProcessingStatusCd: string
Title:
Notification Processing Status Code
Maximum Length:30
The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD. -
NotificationRetryCount: integer
(int32)
Title:
Notification Retry Count
The number of times the system tried to send the SR message notification. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication. -
ObjectTypeCd: string
Title:
Object Type Code
Maximum Length:30
Default Value:SVC_SR_MESSAGES
This field is reserved for internal use only. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system. -
OriginationDate: string
(date-time)
Title:
Origination Date
The date the message was created in the original source system. This is applicable if the service request message was imported from another system. -
ParentMessageId: integer
(int64)
Title:
Parent Message ID
The unique identifier of the parent service request message. -
PartyName: string
Title:
Posted By
Read Only:true
Maximum Length:360
The Party name of the user who the posted the message. The user can be an internal resource or a customer contact. -
PostedByPartyId: integer
(int64)
Title:
Posted by ID
The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact. -
PostedByPartyNumber: string
Title:
Posted by Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the person posting the message on the service request. -
PrivateInformationFlag: boolean
Title:
Contains PII Data
Maximum Length:1
Indicates whether the message contains personally identifiable information. -
ProcessingId: integer
(int64)
Title:
Processing ID
Read Only:true
The unique identifier of the processing. -
ProcessingStatusCd: string
Title:
Processing Status
Maximum Length:30
Default Value:ORA_SVC_READY
The code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD . -
ReplyToMessageId: integer
(int64)
Title:
Reply to Message ID
Read Only:true
The unique identifier of the message that is being replied to by the agent. -
RichTextFlag: boolean
Title:
Rich Text
Maximum Length:1
Default Value:true
Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N. -
RootMessageId: integer
(int64)
Title:
Root Message Identifier
Read Only:true
The identifier of the root message in the message hierarchy. -
RootThreadCount: integer
Title:
Root Message Thread Count
Read Only:true
The number of messages under a root message in a service request. -
RootThreadLastUpdateDate: string
(date-time)
Title:
Root Message Thread Last Updated Date
Read Only:true
The latest updated date for all messages under the root message in a service request. -
RootThreadMessageLastUpdateDate: string
(date-time)
Title:
Root Thread Message Last Updated Date
Read Only:true
The date when all messages under the root message in a service request were last updated. -
SentDate: string
(date-time)
Title:
Sent Date
The date and time when the message was sent. -
SocialPrivateFlag: boolean
Title:
Private Message
Maximum Length:1
Indicates whether the message was created from a private social post. -
SourceCd: string
Title:
Source Code
Maximum Length:30
The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD. -
SrBUOrgId: integer
(int64)
Title:
Service Request Business Unit
Read Only:true
The identifier of the business unit associated with the service request. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request to which the message is associated. -
SrInlineAttachmentIds: string
Title:
Inline Attachment Identifiers
Maximum Length:1000
The list of inline attachment identifiers associated with the service request -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique number of the a service request. -
SrStripeCd: string
Title:
Service Request Application Stripe
Read Only:true
Maximum Length:30
The application stripe of the service request. -
StatusCd: string
Title:
Status Code
Maximum Length:30
The code indicating the status of the message. The accepted values are Draft, Committed, and Corrected. -
Subject: string
Title:
Subject
Maximum Length:1000
The subject of the service request message. -
TemplateName: string
Title:
Template Name
Maximum Length:240
The name of the template used to send an email response to a customer. -
ThreadCount: integer
Title:
Thread Count
Read Only:true
The number of threads in a service request message. -
ThreadHierarchyLevel: integer
Title:
Thread Hierarchy Level
Read Only:true
The level of the thread in the message hierarchy. -
ThreadId: integer
Title:
Thread Identifier
Read Only:true
The unique ID of the service request message thread. -
ThreadLastUpdateDate: string
(date-time)
Title:
Thread Last Updated Date
Read Only:true
The date when the message was last updated. -
ThreadMessageLastUpdateDate: string
(date-time)
Title:
Thread Message Last Updated Date
Read Only:true
The date when the thread message was last updated. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the message has been updated. -
VisibilityCd: string
Title:
Visibility Code
Maximum Length:30
The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.
Show Source
Nested Schema : Channel Communications
Type:
array
Title:
Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsDFFVL: array
AttachmentsDFFVL
-
AttachmentsPreview: array
Attachments Preview
Title:
Attachments Preview
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the attachment category. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of the data. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Attachments Preview
Type:
array
Title:
Attachments Preview
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-Attachment-AttachmentsDFFVL-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-Attachment-AttachmentsPreview-item-response
Type:
Show Source
object
-
ImageHeight: integer
Title:
Image Height
Read Only:true
The height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
The preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
The width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
The number of the page in the preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-channelCommunication-item-response
Type:
Show Source
object
-
ChannelAccountName: string
Title:
Account Name
Read Only:true
Maximum Length:400
The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like support@abc.com. -
ChannelDisplayName: string
Title:
Display Name
Maximum Length:400
The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short Name
Maximum Length:450
The public unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
CollabId: string
Title:
Collaboration ID
Read Only:true
Maximum Length:255
The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id. of a user. -
CollabName: string
Title:
Resource Name
Read Only:true
Maximum Length:400
The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource Identifier
The unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point ID
The unique identifier of the contact point record of the contact who is being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address and the contact point of a person for twitter would be the twitter handle. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the communication channel was created. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNumber: string
Title:
Message Number
Read Only:true
Maximum Length:30
The public unique identifier of the service request message. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Maximum Length:30
Default Value:SVC_SR_MESSAGES
The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the person who is being communicated with. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the person who is being communicated with. The user can be an internal resource or a customer contact. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the contact associated with the service request message. -
PartyViaEndPoint: string
Title:
Party Endpoint
Maximum Length:1000
The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of the person who is a contact on the service request. -
PostIdentifier: string
Title:
Post Identifier
Maximum Length:1000
The unique identifier of the social media post record that was used to create the service request or the service request message. -
ResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with. -
ResourceTypeCd: string
Title:
Resource Type
Read Only:true
Maximum Length:30
The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD. -
RoutingCd: string
Title:
Routing Code
Maximum Length:30
The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD. -
ViaId: integer
(int64)
Title:
ID
Read Only:true
The unique identifier of the channel communication.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-resourceMembers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the resource as a member of the service request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the service request resource member was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the resource member has been deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the service request resource member record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service request resource member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login associated with the user who last updated the service request resource member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member ID
A unique identifier service request resource member record. -
ObjectId: integer
(int64)
Title:
Service Request Team Member Resource ID
The unique identifier of the individual resource added as service request resource member. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_RESOURCE
The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD . -
OwnerFlag: boolean
Title:
Assigned To
Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False. -
PartyUniqueName: string
Title:
Unique Party Name
Read Only:true
Maximum Length:900
The unique name of the individual resource added as service request resource member. -
ResourceEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the resource member. -
ResourceFormattedAddress: string
Title:
Resource Formatted Address
Read Only:true
Indicates the formatted address of the service request resource member. -
ResourceFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the resource member. -
ResourceName: string
Title:
Name
Maximum Length:360
The name of the individual resource added as service request resource member. -
ResourcePartyNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the service request team member. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request that the resource is associated with. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique identifier of the service request number. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the resource member has been updated. -
UserGUID: string
Title:
User GUID
Read Only:true
Maximum Length:64
A globally unique identifier of the resource added as the service request resource member. -
UserId: integer
(int64)
Title:
User ID
Read Only:true
The user identifier of the resource added as the service request resource member. -
Username: string
Title:
User Name
Read Only:true
Maximum Length:100
The user name of the resource member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether an action is designed to operate on multiple object instances selected by an end user. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the action is smart suggest enabled. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique identifier of the smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter Definitions
The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
array
Title:
Smart Action REST Path Parameter Definitions
The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : serviceRequests-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-srInteractionReferences-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the interaction account. -
AccountPartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The name of the interaction account. -
ChannelDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:400
The name of the display channel. -
ChannelId: integer
(int64)
Title:
Channel ID
Read Only:true
The unique identifier of the interaction channel. -
ChannelTypeCd: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the interaction contact. -
ContactPartyUniqueName: string
Title:
Contact
Read Only:true
Maximum Length:900
The name of the interaction contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the interaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the interaction was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the interaction reference has been deleted. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
A brief description of the interaction. -
DirectionCd: string
Title:
Direction
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_INBOUND
The code indicating whether the interaction is inbound or outbound. -
EndTime: string
(date-time)
Title:
End Time
Read Only:true
The date and time when the interaction ends. -
InteractionId: integer
(int64)
Title:
Interaction ID
Read Only:true
The unique identifier of the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the interaction was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the interaction. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the interaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalSystemReference: string
Title:
Original System
Read Only:true
Maximum Length:255
The original system of reference for an interaction that was imported. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
Read Only:true
The unique identifier of the agent who owns the interaction. -
OwnerResourcePartyUniqueName: string
Title:
Resource Name
Read Only:true
Maximum Length:900
The name of the resource who is an internal interaction owner associated with the interaction, such as a service agent. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction ID
Read Only:true
The unique identifier of the parent interaction. -
Payload: string
(byte)
Title:
Payload
Read Only:true
The payload associated with the interaction. -
QueueId: integer
(int64)
Title:
Queue ID
Read Only:true
The unique identifier of the interaction queue. -
QueueName: string
Title:
Name
Read Only:true
Maximum Length:400
The name of the interaction queue. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the service request interaction reference. -
StartTime: string
(date-time)
Title:
Start Time
Read Only:true
The date and time when the interaction starts. -
StatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_OPEN
The code indicating the status of the interaction. A list of accepted values is defined in the lookup ORA_SVC_IM_STATUS_CD. -
StripeCd: string
Title:
Stripe Code
Read Only:true
Maximum Length:30
The application stripe of the interaction. -
TopLevelFlag: boolean
Title:
Top Level
Read Only:true
Indicates if the interaction is the top level interaction in the hierarchy. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the interaction reference has been updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-srMilestone-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates that the milestone is active. -
AgentCompletedFlag: boolean
Title:
Agent Completed
Maximum Length:1
Default Value:false
Indicates whether agent marked the milestone as complete. -
AllowAgentCompletionFlag: boolean
Title:
Allow Agent Completion
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether an agent can mark the milestone as complete. -
AllowDueDateOverrideFlag: boolean
Title:
Allow Due Date Override
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether an agent can override the milestone due date. -
Comments: string
Title:
Comments
Maximum Length:400
The comments the agent made about the milestone. For example, why the due date was overridden. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone was completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
Indicates whether the milestone is compliant or not. The default value is true. -
CoverageId: integer
(int64)
Title:
Coverage ID
The unique identifier of the service request coverage. -
CoverageSourceCd: string
Title:
Coverage Source
Maximum Length:120
Coverage Source -
CoverageSourceCdMeaning: string
Title:
Coverage Source
Read Only:true
The display value corresponding to the coverage source lookup code. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the milestone. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the milestone was created. -
DelayTime: integer
(int64)
Title:
Delay Time
The amount of time the milestones has been delayed from the due date. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the milestone has been deleted. -
DueDate: string
(date-time)
The date when the milestone is due.
-
EntitlementId: integer
The unique identifier of the entitlement for the milestone.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the milestone was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the milestone. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the milestone. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneConfigId: integer
(int64)
Title:
Milestone Configuration ID
The unique identifier of the milestone configuration. -
MilestoneLabel: string
Title:
Name
Read Only:true
Maximum Length:255
The display name of the milestone. -
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
MilestoneStatusCdMeaning: string
Title:
Milestone Status
Read Only:true
Maximum Length:255
The display value corresponding to the status lookup code for the milestone. -
PauseConditionLabel: string
Title:
Pauses When
Read Only:true
Maximum Length:1000
The condition of the milestone when it pauses. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique identifier of the resource assigned to the service request. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrMilestoneHistory: array
Milestone Codes
Title:
Milestone Codes
The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the milestone. -
StartConditionLabel: string
Title:
Starts When
Read Only:true
Maximum Length:1000
The condition of the milestone when it starts. -
SubscriptionCoveragePuid: string
Title:
Subscription Coverage PUID
Maximum Length:120
Subscription Coverage PUID -
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Subscription Number -
TimeLeftOnceUnpaused: integer
Title:
Paused Minutes Remaining
The time left to complete the milestone after the service request is restored from a paused state. -
TimeRemaining: string
Title:
Time Remaining
Read Only:true
The time remaining in the milestone. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the milestone has been updated. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether the milestone has passed the warning threshold. -
WarningDate: string
(date-time)
Title:
Warning Date
The date and time when the milestone passed the warning threshold.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Milestone Codes
Type:
array
Title:
Milestone Codes
The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.
Show Source
Nested Schema : serviceRequests-srMilestone-SrMilestoneHistory-item-response
Type:
Show Source
object
-
AccumulatedTimeInStatus: integer
(int64)
Title:
Accumulated Time
The total time the service request milestone spent in the status. -
Comments: string
Title:
Description
Maximum Length:400
The comments the agent made about the milestone. For example, why the due date was overridden. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the milestone. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the milestone was created. -
EndTime: string
(date-time)
The date and time when the milestone exited the status.
-
HistoryId: integer
(int64)
Title:
History ID
Read Only:true
The unique identifier of the milestone history. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the millstone history was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the milestone history. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the milestone history. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
Indicates the new due date the agent set for the milestone. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone. -
StartTime: string
(date-time)
Title:
Date
The date and time when the milestone status was changed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-srReferences-item-response
Type:
Show Source
object
-
ArticleId: string
Title:
Article ID
Maximum Length:64
The unique identifier of the Oracle Knowledge Cloud Service article. -
ArticleLocale: string
Title:
Article Locale
Maximum Length:10
The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the service request reference. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the service request reference was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the reference has been deleted. -
DocumentId: string
Title:
Document ID
Read Only:true
Maximum Length:50
The identifier of the document associated with the referenced article. -
HelpfulFlag: boolean
Title:
Helpful
Maximum Length:1
Indicates whether the service request reference was helpful. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the service request reference was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service request reference. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login ID of the user who last updated the service request reference. -
LinkedFlag: boolean
Title:
Linked
Maximum Length:1
Indicates whether the reference is linked with the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the service request reference record. -
RelationTypeCd: string
Title:
Relation Type
Maximum Length:30
The type of relationship. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request to which the reference is associated. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique identifier of the service request. -
Subject: string
Title:
Title
Maximum Length:1000
The title of the article. This attribute is valid only when ArticleId is populated. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the reference has been updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-srTags-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Tag: string
Maximum Length:
64
The value of the tag associated with a service request. -
TagId: integer
(int64)
Title:
Tag ID
The unique identifier of the tag. -
TagRefId: integer
(int64)
Title:
Tag Reference ID
Read Only:true
The unique identifier of the tag associated with a service request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AssetLOV
-
Operation: /crmRestApi/resources/11.13.18.05/assetsThe list of values for asset unique identifiers.
- Attachment
-
Parameters:
- SrNumber:
$request.path.SrNumber
The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request. - SrNumber:
- BusinessUnitsLOV
-
The list of values for the business units associated with the logged in user.
- ChannelLOV
-
Operation: /crmRestApi/resources/11.13.18.05/channelsParameters:
- finder:
EnabledChannelByBUAndStripeAndTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}%2CStripeCd%3D{StripeCd}%2CBUOrgId%3D{BUOrgId}
The list of values for service channels. - finder:
- ChannelTypeCdLookup
-
Parameters:
- finder:
IsActiveIsEnabledFinder
The list of values for channel types such as email, phone, social, and so on. - finder:
- CustomerPickerVO
-
Operation: /crmRestApi/resources/11.13.18.05/accountsThe list of values for account party unique name.
- GeographyLovPVO
-
Operation: /crmRestApi/resources/11.13.18.05/geoZonesThe list of values indicating the service zone of the service request.
- IBAssetLocationTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CSE_CURRENT_LOC_CONTEXT
The list of values for the installed base asset location. - finder:
- InternalPriorityLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_INT_PRIORITY_CD
The list of values for the internal priority of the service request such as High, Normal, Low, and so on. - finder:
- LanguageCdLOV
-
The list of values for the language on the service request.
- LoyaltyMemberIdLOV
-
The list of values containing the names of the loyalty members.
- NetworkTypeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE
The list of values for the social networks. - finder:
- OwnerTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_OWNER_TYPE_CD
The list of values for the service request owner type such as Customer and Partner. - finder:
- PartnerAccountLOV
-
Operation: /crmRestApi/resources/11.13.18.05/partnersThe list of values for the partner account unique names.
- PrimaryContactLOV
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list of values for the contact unique names.
- ProblemCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_PROBLEM_TYPE_CD
The list of values reserved for future use. - finder:
- ProductGroupLOV
-
The list of values for product group names.
- ProductInventoryItemLOV
-
The list of values for product descriptions.
- QueueVO
-
Operation: /crmRestApi/resources/11.13.18.05/queuesParameters:
- finder:
QueueEnabledFinder
The list of values for service request queues. - finder:
- ResolutionCdLookup
-
Parameters:
- finder:
SrResolutionCdFinder%3BBindChildLookupType%3DORA_SVC_SR_RESOLUTION_CD%2CBindParentLookupType%3DORA_SVC_RESOLVE_OUTCOME_CD%2CBindParentLookupCode%3D{ResolveOutcomeCd}
The list of values for resolution code of a service request such as Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. - finder:
- ResolveOutcomeCdLookup
-
Parameters:
- finder:
IsEnabledFinder
The list of values for outcome of the service request. The accepted values are defined in the lookup type ORA_SVC_RESOLVE_OUTCOME_CD. - finder:
- ResourcePickerLOV
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values the service request assignee.
- SearchFilterLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_SEARCH_REC_SET_CD
The list of values for record sets. - finder:
- SeverityCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_SEVERITY_CD
The list of values for the severity of a service request such as severity 1, severity 2, and so on. - finder:
- SourceCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
The list of values for the source of the service request such as Agent_UI, Customer_UI, API, and so on. - finder:
- SrCategoryLOV
-
Operation: /crmRestApi/resources/11.13.18.05/categoriesParameters:
- finder:
CategoryEnabledFinder
The list of values for service request categories. - finder:
- SrStatusCdLookup
-
Parameters:
- finder:
IsEnabledFinder%3BBindChildLookupType%3DORA_SVC_SR_STATUS_CD%2CBindParentLookupType%3DORA_SVC_SR_STATUS_TYPE_CD
The list of values for the status code of the service request such as New, In Progress, Waiting, Resolved, Closed, and so on. - finder:
- StatusTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_STATUS_TYPE_CD
The list of values for the status type of the service request such as New, In Progress, Waiting, Resolved, Closed. - finder:
- TimezoneVO
-
Parameters:
- finder:
EnabledFinder
TimezoneCode LOV - finder:
- TransferReasonCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_TRANSFER_REASON
The list of values for the transfer reason of the service request such as Incorrectly Routed, Workload Balancing, SR Owner Unavailable, and so on. - finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating whether the service request was created using a private social network channel. The accepted values are Y and N. - finder:
- activities
-
Parameters:
- SrNumber:
$request.path.SrNumber
The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request. - SrNumber:
- addresses
-
Parameters:
- SrNumber:
$request.path.SrNumber
A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address. - SrNumber:
- channelCommunication
-
Parameters:
- SrNumber:
$request.path.SrNumber
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers. - SrNumber:
- contacts
-
Parameters:
- SrNumber:
$request.path.SrNumber
The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone. - SrNumber:
- getSrMilestoneDiagnostics
-
Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/getSrMilestoneDiagnosticsParameters:
- SrNumber:
$request.path.SrNumber
Returns the service request milestone diagnostics report results for the specified service request. - SrNumber:
- messages
-
Parameters:
- SrNumber:
$request.path.SrNumber
The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.". - SrNumber:
- processSrMilestones
-
Parameters:
- SrNumber:
$request.path.SrNumber
Evaluates service request and applies any required changes to its milestones. - SrNumber:
- resourceMembers
-
Parameters:
- SrNumber:
$request.path.SrNumber
Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue. - SrNumber:
- sendEmailForSrMessage
-
Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/sendEmailForSrMessageParameters:
- SrNumber:
$request.path.SrNumber
This method lets you send an email to the recipients of the service request message for the specified message identifier. - SrNumber:
- smartActions
-
Parameters:
- SrNumber:
$request.path.SrNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - SrNumber:
- srInteractionReferences
-
Operation: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferencesParameters:
- SrNumber:
$request.path.SrNumber
The interaction references resource is used to view the relationship between an interaction and a service request. - SrNumber:
- srMilestone
-
Parameters:
- SrNumber:
$request.path.SrNumber
The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2. - SrNumber:
- srReferences
-
Parameters:
- SrNumber:
$request.path.SrNumber
The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request. - SrNumber:
- srTags
-
Parameters:
- SrNumber:
$request.path.SrNumber
The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request. - SrNumber:
Examples
The following example shows how to get information on a particular a service request by submitting a GET request on the REST resource.
Example of Request Header
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Fri, 12 Aug 2016 10:55:33 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "SrId": 300100089890770 "SrNumber": "SR0000002002" "Title": "REST API - Automated Test Script- created time - 2016/06/05 11:28:03" "ProblemDescription": null "SeverityCd": "ORA_SVC_SEV3" "AssigneeResourceId": null "AssigneePartyId": null "AssigneePersonName": null "AssigneeEmailAddress": null "CreatedBy": "autoapicsm2" "CreationDate": "2016-06-05T11:28:04-07:00" "LastUpdateDate": "2016-06-05T11:28:04-07:00" "LastUpdateLogin": "348D01EFFABE54DBE05393D0F00AEE8E" "LastUpdatedBy": "autoapicsm2" "LastUpdatedByDisplayName": "autoapicsm2 svc" "AccountPartyId": null "AccountPartyUniqueName": null "PartnerAccountPartyId": null "PartnerAccountPartyName": null "PartnerAccountPartyUniqueName": null "OwnerTypeCd": "ORA_SVC_CUSTOMER" "PrimaryContactPartyId": null "PrimaryContactPartyUniqueName": null "PrimaryContactFormattedPhoneNumber": null "CategoryId": null "ClosedDate": null "CorpCurrencyCode": null "CurcyConvRateType": null "CurrencyCode": null "OpenDate": "2016-06-05T11:28:04-07:00" "ReportedByPartyId": 300100077629336 "ReportedByPartyUniqueName": "autoapicsm2 svc" "ProblemCd": null "ProdGroupId": null "ProdGroupName": null "InventoryItemId": null "InventoryOrgId": null "ProductItemOrgId": null "ProductItemDescription": null "ProductItemNumber": null "AssetId": null "AssetSerialNumber": null "QueueId": null "LastReopenDate": null "LastResolvedDate": null "ResolutionCd": null "SourceCd": null "ChannelTypeCd": null "StatusCd": "ORA_SVC_NEW" "InternalPriorityCd": null "LanguageCd": null "StatusTypeCd": "ORA_SVC_NEW" "SrCreatedBy": "autoapicsm2" "QueueName": null "CriticalFlag": false "OriginalSystemReference": "SR0000002002" "CategoryName": null "SrLastUpdateDate": "2016-06-05T11:28:04-07:00" "SrLastUpdateLogin": "348D01EFFABE54DBE05393D0F00AEE8E" "SrLastUpdatedBy": "autoapicsm2" "RecordSet": null "links": [ 28] 0: { "rel": "self" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002" "name": "serviceRequests" "kind": "item" "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000177040000000A737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } - } - 1: { "rel": "canonical" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002" "name": "serviceRequests" "kind": "item" } - 2: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/SearchFilterLookupPVO" "name": "SearchFilterLookupPVO" "kind": "collection" } - 3: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/ResourcePickerLOV" "name": "ResourcePickerLOV" "kind": "collection" } - 4: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/PartnerAccountLOV" "name": "PartnerAccountLOV" "kind": "collection" } - 5: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/QueueVO" "name": "QueueVO" "kind": "collection" } - . . . - }