Update a service request
patch
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Request
Path Parameters
-
SrId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
activities: array
Activities
Title:
Activities
The activities resource is used to view, create, update, and delete an activity. -
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 party person. -
AssigneePersonName: string
Title:
Assigned To
Maximum Length:360
The email address of the assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource ID
The unique identifier of the assignee resource. -
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BUOrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit associated to the service request. -
CategoryId: integer
(int64)
Title:
Category
The unique identifier of the service request category. -
channelCommunication: array
Service Request Communications
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include 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 channel type. -
ClosedDate: string
(date-time)
Title:
Date Closed
The date when the service request was closed, if closed. -
contacts: array
Contact Members
Title:
Contact Members
The list of contacts associated to the serivce request. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code. -
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 corporate currency conversion rate type. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. -
FirstTransferDate: string
(date-time)
Title:
First Transfer Date
The date when the service request was first transferred. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset ID
The unique identifier of the associated install base asset record. -
InternalPriorityCd: string
Title:
Internal Priority Code
Maximum Length:30
The internal priority of the service request. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated to the service request. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that's associated with the service request. -
LanguageCd: string
Title:
Language Code
Maximum Length:30
The customer's preferred language for the service request. -
LastReopenDate: string
(date-time)
Title:
Date Reopened
The date and time when the service request was last reopened. -
LastResolvedDate: string
(date-time)
Title:
Resolution Date
The date and time when the service request was resolved. -
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. -
LastUpdatedByPartyId: integer
(int64)
The unique party identifier of the person who last updated the service request.
-
messages: array
Messages
Title:
Messages
The list of service request messages. -
OpenDate: string
(date-time)
Title:
Date Reported
The date when the service request was reported by the customer. -
OriginalSystemReference: string
Maximum Length:
255
The reference to the service request record in the original system from which service request was imported. -
PrimaryContactAssignmentNumber: string
Title:
Primary Contact Person Assignment Number
Maximum Length:50
The unique assignment number of the primary contact of the service request. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the primary contact of the service request. -
PrimaryContactPersonId: integer
(int64)
Title:
Primary Contact Person ID
The unique identifier of the primary contact of the service request. -
PrimaryContactPersonIdTransient: string
Title:
Primary Point of Contact
The unique identifier of the primary contact of the service request. -
ProblemCd: string
Title:
Problem Type Code
Maximum Length:30
The problem code of the service request. -
ProblemDescription: string
Title:
Detailed Description
Maximum Length:1000
The service request's problem description or statement and the steps to reproduce the issue. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated to the service request. -
ProdGroupName: string
Title:
Product Group
The name of the product group associated to the service request. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
The alternative key for the product group identifier. -
ProductItemDescription: string
Title:
Product Description
The description of the product 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 to the service request. -
ReferenceObjectId: integer
(int64)
Title:
Reference Object ID
API response attribute that maps to ref_obj_id in SVC_SERVICE_REQUESTS table -
ReferenceObjectPuid: string
Title:
Reference ID
Maximum Length:100
API response attribute that maps to ref_obj_puid in SVC_SERVICE_REQUESTS table -
ReferenceObjectType: string
Title:
Reference Object Type
Maximum Length:50
Reference Object Type -
ReportedByPartyId: integer
(int64)
Title:
Reported by Party ID
The user who created the request. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
The resolution code of the service request. -
ResolvedBy: string
Title:
Resolved By
Maximum Length:64
The user who resolved the service request. -
ResolveDescription: string
Title:
Solution Description
Maximum Length:1000
The description of how the service request has been resolved. -
ResolveOutcomeCd: string
Title:
Outcome
Maximum Length:30
The outcome of a service request resolution. -
resourceMembers: array
Resources
Title:
Resources
The list of resources associated to the service request. -
ServiceZoneId: integer
(int64)
Title:
Region Identifier
The unique identifier of the service request region. -
SeverityCd: string
Title:
Severity
Maximum Length:30
The severity of the service request. -
SeverityCdTransient: string
Title:
Severity
The severity of the service request. -
smartActions: array
Smart Actions
Title:
Smart Actions
This VO stores the endpoint and security details for every user action. -
SourceCd: string
Title:
Source Code
Maximum Length:30
Indicates how the service request was created in the application. -
SrCreatedBy: string
Title:
Source System SR Created By
Maximum Length:64
The user who created the service request. -
srInteractionReferences: array
Interaction References
Title:
Interaction References
Indicates the list of interaction references for 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. -
SrLastUpdateLogin: string
Title:
Source System SR Last Updated by User Login ID
Maximum Length:32
The login of the user who last updated the service request. -
srMilestone: array
Milestones
Title:
Milestones
Indicates the milestone associated with the service request. -
srReferences: array
References
Title:
References
The list of other objects associated to the service request. E.g. Knowledge articles. -
srTags: array
Tags
Title:
Tags
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request. -
StatusCd: string
Title:
Status
Maximum Length:30
The status code of the service request. -
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:
Subject
Maximum Length:400
The 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.
Nested Schema : Activities
Type:
array
Title:
Activities
The activities resource is used to view, create, update, and delete an activity.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Communications
Type:
array
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Contact Members
Type:
array
Title:
Contact Members
The list of contacts associated to the serivce request.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The list of service request messages.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The list of resources associated to the service request.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : Interaction References
Type:
array
Title:
Interaction References
Indicates the list of interaction references for a service request.
Show Source
Nested Schema : Milestones
Type:
array
Title:
Milestones
Indicates the milestone associated with the service request.
Show Source
Nested Schema : References
Type:
array
Title:
References
The list of other objects associated to the service request. E.g. Knowledge articles.
Show Source
Nested Schema : Tags
Type:
array
Title:
Tags
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.
Show Source
Nested Schema : internalServiceRequests-activities-item-patch-request
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account ID
The unique identifier of the account. -
AccountIdAttr: integer
The internal attribute for the account Id.
-
AccountName: string
Title:
Account
The name of the account associated to activity. -
AccountNameOsn: string
Title:
Social Account Name
The account name displayed in Oracle Social Network. -
ActivityDescription: string
(byte)
Title:
Description
A text field for capturing some descriptive information about the activity. -
ActivityEndDate: string
(date-time)
Title:
End Date
The end date and time of an appointment, or the completion time of a task. -
ActivityFunctionCodeTrans: string
Title:
Activity
Maximum Length:255
The activity function code. -
ActivityMtgMinutes: string
(byte)
Title:
Meeting Minutes
The activity meeting minutes. -
ActivityPartialDescription: string
Title:
Short Description
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivityPriority: string
Title:
Priority
Indicates the priority of the activity (Internal Usage). -
ActivityStartDate: string
(date-time)
Title:
Start Date
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task. -
ActivitySubtypeCode: string
Title:
Subtype
Maximum Length:30
Displays a list of subtype values that are dependent on the value of the activity. -
ActivityTimezone: string
Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.
-
ActivityType: string
Title:
Activity Type
The type of the activity. -
ActivityTypeCode: string
Title:
Type
Maximum Length:30
The type or category of the activity. -
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Default Value:false
Designates that an appointment is the entire day. -
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. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of the asset. -
AssetName: string
Title:
Asset
The name of the asset. -
AssetNumber: string
Title:
Asset Number
The alternate identifier of the asset. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:ZMM_ACTY_ACTIVITIES
The name of the attachment entity. -
AutoLogSource: string
Title:
Source System
Maximum Length:30
For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity. -
BpId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BuOrgId: integer
(int64)
Title:
Business Unit
The unique identifier for the Business Unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business Plan
The business plan name associated to the activity. -
BusinessPlanNumber: string
Title:
Business Plan Number
The business plan number of the business plan associated with the activity. -
CalendarAccess: boolean
The access rights to calendar. (Internal Usage)
-
CalendarRecurType: string
The activity recurrence type.
-
CalendarSubject: string
The activity subject.
-
CalendarSubjectDay: string
The title of the calendar.
-
CalendarTimeType: string
Indicates all day appointment. (Internal Usage)
-
CallReportCount: integer
(int32)
Title:
Call Report Count
Default Value:0
A count of the number of call reports. -
CallReportUpcomingYN: string
Indicates Y,N,M for upcoming appointments.
-
CallReportYN: string
Flag to Check if this activity has a Call Report
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign
The name of the campaign associated to the activity. -
CampaignNumber: string
Title:
Campaign Number
The campaign number 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 alternate identifier of the case. -
CheckedInBy: string
Title:
Checked-In By
Maximum Length:64
The name of the person who checks-in to a location. -
CheckedOutBy: string
Title:
Checked-Out By
Maximum Length:64
The name of the person who checks-out to a location. -
CheckinDate: string
(date-time)
Title:
Check-In Time
Stores the date and time when a user checks in to an appointment. -
CheckinLatitude: number
Title:
Check-In Latitude
Stores the latitude of a location where a user checks in to an appointment. -
CheckinLongitude: number
Title:
Check-In Longitude
Stores the longitude of a location where a user checks in to an appointment. -
CheckoutDate: string
(date-time)
Title:
Check-Out Time
Stores the date and time when a user checks out of an appointment. -
CheckoutLatitude: number
Title:
Check-Out Latitude
Stores the latitude of a location where a user checks out of an appointment. -
CheckoutLongitude: number
Title:
Check-Out Longitude
Stores the longitude of a location where a user checks out of an appointment. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the claim. -
ClaimName: string
Title:
MDF Claim
The name associated to the activity. -
ClaimNumber: string
Title:
Claim Number
The number of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0
The unique internal identifier of the conflict -
ContactIDAttr: integer
The internal contact identifier.
-
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code from profile. -
CurcyConvRateType: string
Title:
Currency Conversion Rate
Maximum Length:30
Holds the currency code of a record. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Holds the currency conversion rate type from profile. -
CurrentDateForCallReport: string
(date-time)
The current date for the call report.
-
CurrentDateForCallReportAttr: string
(date-time)
The internal attribute for the current date for the call report.
-
CustomerAccountId: integer
(int64)
Title:
Customer Account ID
The unique identifier of the customer account. -
DealId: integer
(int64)
Title:
Deal ID
The unique identifier of the related deal. -
DealNumber: string
Title:
Deal Registration
The deal number associated to the activity. -
DelegatorId: integer
(int64)
Title:
Delegator ID
The activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated By
The name of activity resource that delegated activity ownership to another resource. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
Direction
Maximum Length:30
The inbound or outbound. It's optional. The default is null. -
DismissAssignee: string
Title:
Dismissed
Indicates whether the assignees is dismissed. Valid values are Y and N. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Indicates whether this activity is dismissed. -
DueDate: string
(date)
Title:
Due Date
The date the task activity is due to be completed. -
Duration: number
Title:
Duration
The duration of an appointment or task. -
EmailSentDate: string
(date-time)
This field is used to capture the Activity Email Notification shared date for Outlook integration.
-
EndDateForCallReport: string
(date-time)
The end date of the call report.
-
EndDateForCallReportAttr: string
(date-time)
The internal attribute for end date of the call report.
-
EndDtRFAttr: string
(date-time)
The internal attribute for activity start date.
-
ExternalContactEmail: string
Title:
Primary Email
Maximum Length:320
The email 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 that the activity isn't created by an internal resource. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the fund request. -
FundRequestName: string
Title:
MDF Request
The fund request name associated to the activity. -
FundRequestNumber: string
Title:
Fund Request Number
The fund request number 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. -
InstNumDerivedFrom: string
Default Value:
Y
The internal attribute to identify recurrence mode. -
IsClientService: string
Default Value:
Y
The obsolete internal attribute. -
LeadId: integer
(int64)
Title:
Lead ID
Indicates the related lead to the activity. -
LeadIdAttr: integer
The internal attribute for the lead Id.
-
LeadName: string
Title:
Lead
Indicates the lead name. -
LeadNameOsn: string
Title:
Social Lead Name
The lead name displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead Number
The lead number of lead associated with the activity. -
Location: string
Title:
Location
Maximum Length:200
Indicates the location of an appointment. -
LocationId: integer
(int64)
Title:
Location ID
The location or address ID of the activity account or primary contact. -
LoginUserRFAttr: integer
The internal attribute for activity login user.
-
MdfRequestId: integer
The identifier for fund request.
-
MobileActivityCode: string
Title:
Mobile Activity Code
Maximum Length:50
The unique identifier of external mobile device. -
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 internal attribute for the opportunity Id.
-
OpportunityName: string
Title:
Opportunity
The name of opportunity associated to the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity Name
The opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity Number
The opportunity number 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. -
OtherPartyPhoneNumber: string
Title:
Other Party Phone Number
Maximum Length:40
For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called. -
OutcomeCode: string
Title:
Outcome
Maximum Length:30
The code of the outcome of the activity. -
OutlookFlag: boolean
Title:
Outlook
Maximum Length:1
Default Value:false
Indicates whether the activity was created from Outlook and synced. -
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 from outlook activity. -
OwnerId: integer
(int64)
Title:
Owner ID
The primary resource on the activity. Supports resources only. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of primary resource of activity. -
OwnerNameOsn: string
Title:
Social Owner Name
The owner name displayed in Oracle Social Network. -
ParentActivityId: integer
(int64)
Title:
Parent ID
The related activity identifier, only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The internal attribute for the parent activity Id.
-
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 partner enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment Number
The surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party ID
The party identifier of the partner organization. -
PartnerPartyName: string
Title:
Partner
Maximum Length:80
The party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner Number
The partner party number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The related partner program. -
PartnerProgramName: string
Title:
Program
The name of partner program associated to the activity. -
PartnerProgramNumber: string
Title:
Program Number
The partner program number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner Usage
Maximum Length:1
Default Value:false
Flag to indicate that the Activity has been created for an Organization Account with usage as Partner. -
PercentageComplete: number
Title:
Percentage Complete
Default Value:0
The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The primary contact of the activity. -
PrimaryContactName: string
Title:
Primary Contact
The name of the primary contact. -
PrimaryContactNameOsn: string
Title:
Social Primary Contact Name
The primary contact name displayed in Oracle Social Network. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The priority of the activity. Default to 2. Possible values: 1, 2, 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
Repeat on specified day of month for monthly appointments. -
RecurEndDate: string
(date-time)
Title:
Ends
Ends on a specified date. -
RecurEveryOptionFlag: boolean
Title:
Recurrence Option
Maximum Length:1
It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N. -
RecurExceptionFlag: boolean
Title:
Recurrence Exception
Maximum Length:1
Indicates if appointment instance has been updated outside of recurring appointment series. -
RecurFrequency: number
Title:
Repeat
Frequency that the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
Friday
Maximum Length:1
Repeat on Friday. -
RecurMonFlag: boolean
Title:
Monday
Maximum Length:1
Repeat on Monday. -
RecurMonth: string
Title:
Month
Maximum Length:30
Repeat on specified month (for yearly appointments). -
RecurNumberOfInstances: number
Title:
Number of Instances
Designates specific number of occurrences for the series to end after. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance Date
Original date of a recurring appointment instance. -
RecurPattern: string
Title:
Pattern
Maximum Length:30
Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last. -
RecurRecType: string
Title:
Recurrence Record Type
Maximum Length:1
Default Value:N
For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task. -
RecurSatFlag: boolean
Title:
Saturday
Maximum Length:1
Repeat on Saturday. -
RecurSunFlag: boolean
Title:
Sunday
Maximum Length:1
Repeat on Sunday. -
RecurThuFlag: boolean
Title:
Thursday
Maximum Length:1
Repeat on Thursday. -
RecurTueFlag: boolean
Title:
Tuesday
Maximum Length:1
Repeat on Tuesday. -
RecurTypeCode: string
Title:
Recurrence Type
Maximum Length:30
Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, 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
Repeat on Wednesday. -
RecurWeekday: string
Title:
Pattern Type
Maximum Length:30
It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day. -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity Type
Maximum Length:30
The activity type for a reference customer activity. To be used as an extension only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference Customer
The identifier of the reference customer party associated with the activity. -
ReminderPeriod: string
Title:
Set Reminder
The reminder period. -
ResponseCode: string
Title:
Response
The response code. -
SalesObjectiveName: string
Title:
Sales Objective
The sales objective name associated to the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective Number
The sales objective number of the 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
Indicates whether the activity is open, complete, or all activities. -
ShowTimeAs: string
Title:
Show Time As
The show time of the 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
This is an internal column which is used to sort the activity based on the due date for task and start date for activity. -
SourceObjectCode: string
The code of the object to which activity will get related to.
-
SourceObjectId: integer
The identifier of the object to which activity will get related to.
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request
The service request number. -
StartDateForCallReport: string
(date-time)
The start date of the call report.
-
StartDateForCallReportAttr: string
(date-time)
The internal attribute for start date of the call report.
-
StartDtRFAttr: string
(date-time)
The internal attribute for Activity Start Date.
-
StatusCode: string
Title:
Status
Maximum Length:30
Status of the activity. Defaulted to NOT_STARTED. -
Subject: string
Title:
Subject
Maximum Length:500
The subject of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted By
The call report submitter. -
SubmittedByName: string
Title:
Submitted By
Maximum Length:255
The name of the call report submitter. -
SubmittedDate: string
(date-time)
Title:
Submitted Date
The call report submission date. -
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 task reminder period. -
TemplateDuration: number
Title:
Template Duration
The duration in days of the template activity. This attribute is used with the start date when generating an activity from a template 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
The unique identifier of the template. -
TemplateLeadTime: number
Title:
Lead Time
The lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time. -
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 : internalServiceRequests-Attachment-item-patch-request
Type:
Show Source
object
-
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 category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 error code, 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 expiration date of the contents in the attachment. -
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 URI of the file. -
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 size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type 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 : internalServiceRequests-Attachment-AttachmentsDFFVL-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AttachedDocumentId: integer
(int64)
Nested Schema : internalServiceRequests-Attachment-AttachmentsPreview-item-patch-request
Type:
Show Source
object
Nested Schema : internalServiceRequests-channelCommunication-item-patch-request
Type:
Show Source
object
-
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. -
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's 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. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request. -
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. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the person who's being communicated with. -
PartyViaEndPoint: string
Title:
Party Endpoint
Maximum Length:1000
The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
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. -
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.
Nested Schema : internalServiceRequests-contacts-item-patch-request
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The access level granted to the service request contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request 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 of the contact. -
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 person ID of the contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
Nested Schema : internalServiceRequests-messages-item-patch-request
Type:
Show Source
object
-
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
channelCommunication: array
Service Request Communications
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include 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 channel type, such a email, phone, social, and so on. -
CollabResource: string
Title:
Collaboration Resource
The unique identifier of the collaboration network user that the internal users are communicating with. -
MessageContent: string
(byte)
Title:
Message Content
The content of the service request 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
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 date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdatedBy: string
Title:
Last Updated By
Maximum Length:64
The user who last updated 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 updated the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageSubTypeCd: string
Title:
Message Subtype
Maximum Length:30
The service request message subtype. -
MessageTypeCd: string
Title:
Message Type Code
Maximum Length:30
The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. -
NotificationProcessingStatusCd: string
Title:
Notification Processing Status Code
Maximum Length:30
The notification processing status code. -
NotificationRetryCount: integer
(int32)
Title:
Notification Retry Count
The notification retry count. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The unique 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 message. -
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. -
PrivateInformationFlag: boolean
Title:
Contains PII Data
Maximum Length:1
Indicates whether the message contains personally identifiable information. -
ProcessingStatusCd: string
Title:
Processing Status
Maximum Length:30
Default Value:ORA_SVC_READY
The processing status of the message. The accepted values are Ready, Processing, Error, and Success. -
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. -
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 service request was created from a private social post. -
SourceCd: string
Title:
Source Code
Maximum Length:30
The source of the message. -
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 -
StatusCd: string
Title:
Status Code
Maximum Length:30
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 that's used for outbound communication of the message. -
VisibilityCd: string
Title:
Visibility Code
Maximum Length:30
The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Communications
Type:
array
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : internalServiceRequests-messages-Attachment-item-patch-request
Type:
Show Source
object
-
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 category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 error code, 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 expiration date of the contents in the attachment. -
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 URI of the file. -
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 size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type 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 : internalServiceRequests-messages-Attachment-AttachmentsDFFVL-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AttachedDocumentId: integer
(int64)
Nested Schema : internalServiceRequests-messages-Attachment-AttachmentsPreview-item-patch-request
Type:
Show Source
object
Nested Schema : internalServiceRequests-messages-channelCommunication-item-patch-request
Type:
Show Source
object
-
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. -
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's 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 while the contact point of a person for twitter would be the twitter handle. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request. -
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. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the person who's being communicated with. -
PartyViaEndPoint: string
Title:
Party Endpoint
Maximum Length:1000
The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
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. -
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.
Nested Schema : internalServiceRequests-resourceMembers-item-patch-request
Type:
Show Source
object
-
MemberId: integer
(int64)
Title:
Member ID
A unique identifier of the service request resource member. -
ObjectId: integer
(int64)
Title:
Service Request Team Member Resource ID
The unique identifier of the service request resource member. -
OwnerFlag: boolean
Title:
Assigned To
Indicates whether the service request is assigned to the resource member. If yes, the value is True, else the value is False. -
ResourceName: string
Title:
Name
Maximum Length:360
The name of the service request resource member.
Nested Schema : internalServiceRequests-smartActions-item-patch-request
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
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the 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 if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : internalServiceRequests-smartActions-UserActionRequestPayload-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
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
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : internalServiceRequests-smartActions-UserActionURLBinding-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : internalServiceRequests-srInteractionReferences-item-patch-request
Type:
Show Source
object
Nested Schema : internalServiceRequests-srMilestone-item-patch-request
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates whether the service request milestone is active. -
AgentCompletedFlag: boolean
Title:
Agent Completed
Maximum Length:1
Default Value:false
Indicates whether agent marked the milestone as complete. -
Comments: string
Title:
Comments
Maximum Length:400
The customer or agent comments. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone is to be completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
The compliance status of the milestone. -
CoverageSourceCd: string
Title:
Coverage Source
Maximum Length:120
Coverage Source -
DelayTime: integer
(int64)
Title:
Delay Time
The time between the due date and the completion date. -
DueDate: string
(date-time)
The due date of the milestone.
-
EntitlementId: integer
The unique identifier of the entitlement record.
-
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The status of the milestone. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique party object identifier of the service request assignee. -
SrMilestoneHistory: array
Milestones History
Title:
Milestones History
The list of changes in the service request milestone status. -
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Subscription Number -
TimeLeftOnceUnpaused: integer
Title:
Paused Minutes Remaining
The time left, in minutes, to complete the milestone after it's restored from the paused state. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether milestone passed the warning threshold. -
WarningDate: string
(date-time)
Title:
Warning Date
The date and time when the milestone passed the warning threshold.
Nested Schema : Milestones History
Type:
array
Title:
Milestones History
The list of changes in the service request milestone status.
Show Source
Nested Schema : internalServiceRequests-srMilestone-SrMilestoneHistory-item-patch-request
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 of the agent. -
EndTime: string
(date-time)
The date and time when the milestone exited the status.
-
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The status of the milestone. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
The milestone overridden due date. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone record. -
StartTime: string
(date-time)
Title:
Date
The date and time when the milestone status was changed.
Nested Schema : internalServiceRequests-srReferences-item-patch-request
Type:
Show Source
object
-
ArticleId: string
Title:
Article ID
Maximum Length:64
The unique identifier of the referenced article. -
ArticleLocale: string
Title:
Article Locale
Maximum Length:10
The locale of the knowledge management article. -
HelpfulFlag: boolean
Title:
Helpful
Maximum Length:1
Indicates whether the service request reference was helpful. -
LinkedFlag: boolean
Title:
Linked
Maximum Length:1
Indicates whether the reference is linked with the service request. -
ObjectId: integer
(int64)
Title:
Object ID
Indicates whether the object is referenced to the service request. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The object type of the reference object. -
RelationTypeCd: string
Title:
Relation Type
Maximum Length:30
The relationship type between the service request and the referenced object. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
Indicates whether the referenced object helps in resolving the service request. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
Subject: string
Title:
Title
Maximum Length:1000
The title of the referenced object.
Nested Schema : internalServiceRequests-srTags-item-patch-request
Type:
Show Source
object
-
TagId: integer
(int64)
Title:
Tag ID
The unique identifier of the tag.
Response
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 : internalServiceRequests-item-response
Type:
Show Source
object
-
activities: array
Activities
Title:
Activities
The activities resource is used to view, create, update, and delete an activity. -
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 party person. -
AffectedPartyPersonName: string
Title:
Affected Party Person Name
Read Only:true
The display name of the affected party person in 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 SR 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 assignee party. -
AssigneePersonName: string
Title:
Assigned To
Maximum Length:360
The email address of the assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource ID
The unique identifier of the assignee resource. -
AssigneeResourceNumber: string
Title:
Assigned to Resource Number
Read Only:true
Maximum Length:30
The alternative key for the resource identifier of the assignee. -
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BUOrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit associated to the service request. -
BusinessUnitName: string
Title:
Business Unit Name
Read Only:true
Maximum Length:255
The name of the business unit associated to 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 to the service request. -
channelCommunication: array
Service Request Communications
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include 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 channel type. -
ChannelTypeCdMeaning: string
Title:
Channel Type Value
Read Only:true
Maximum Length:255
The display value corresponding to the channel type lookup code for the service request. -
ClosedDate: string
(date-time)
Title:
Date Closed
The date when the service request was closed, if closed. -
ComplianceFlag: boolean
Title:
Compliance
Read Only:true
The compliance status of the milestone. -
contacts: array
Contact Members
Title:
Contact Members
The list of contacts associated to the serivce request. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code. -
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 corporate currency conversion rate type. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the user has access to delete the record -
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 current milestone should be saved on the service request header. -
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 associated install base asset record. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The installed base asset number of the service request. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The install base asset serial number of the service request. -
InternalPriorityCd: string
Title:
Internal Priority Code
Maximum Length:30
The internal priority of the service request. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated to the service request. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that's associated with the service request. -
LanguageCd: string
Title:
Language Code
Maximum Length:30
The customer's preferred language for the service request. -
LastReopenDate: string
(date-time)
Title:
Date Reopened
The date and time when the service request was last reopened. -
LastResolvedDate: string
(date-time)
Title:
Resolution Date
The date and time when the service request was resolved. -
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 updated 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)
The unique party identifier of the person who last updated the service request.
-
LastUpdatedByPartyNumber: string
Title:
Last Updated by Party Number
Read Only:true
Maximum Length:30
The alternative key for the party identifier of the person who last updated the service request. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messages: array
Messages
Title:
Messages
The list of service request messages. -
MilestoneConfigId: integer
(int64)
Title:
Configuration ID
Read Only:true
The unique identifier of the milestone configuration associated with the service request. -
MilestoneLabel: string
Title:
Milestone Name
Read Only:true
The name of the milestone. -
MilestoneStatusCd: string
Title:
Milestone Status
Read Only:true
Maximum Length:255
The status of the milestone. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The type of social network. -
OpenDate: string
(date-time)
Title:
Date Reported
The date when the service request was reported by the customer. -
OriginalSystemReference: string
Maximum Length:
255
The reference to the service request record in the original system from which service request was imported. -
OwnerTypeCd: string
Title:
Owner Type
Maximum Length:30
The type of the service request owner. For example, the owner of the service request may be a customer or a partner. -
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
The primary contact of the service request doesn't want to be contacted. -
PrimaryContactEmailAddress: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
The e-mail 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 service request primary contact's formatted phone number -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the primary contact of the service request. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the service request primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Number
Read Only:true
Maximum Length:30
The alternative key for the primary contact identifier. -
PrimaryContactPersonId: integer
(int64)
Title:
Primary Contact Person ID
The unique identifier of the primary contact of the service request. -
PrimaryContactPersonIdTransient: string
Title:
Primary Point of Contact
The unique identifier of the primary contact of the service request. -
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 problem code of the service request. -
ProblemDescription: string
Title:
Detailed Description
Maximum Length:1000
The service request's problem description or statement and the steps to reproduce the issue. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated to the service request. -
ProdGroupName: string
Title:
Product Group
The name of the product group associated to the service request. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
The alternative key for the product group identifier. -
ProductItemDescription: string
Title:
Product Description
The description of the product associated with the service request. -
ProductItemNumber: string
Title:
Product Number
Read Only:true
Maximum Length:255
The product number or code of the product associated with the service request. -
ProductItemOrgId: integer
(int64)
Title:
Product Organization
Read Only:true
The unique identifier of the product organization. -
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 to the service request. -
QueueNumber: string
Title:
Queue Number
Read Only:true
Maximum Length:30
The alternative key for the queue identifier. -
RecordSet: string
Title:
Search Filter
Read Only:true
The record set used by REST API to run saved searches. -
ReferenceObjectId: integer
(int64)
Title:
Reference Object ID
API response attribute that maps to ref_obj_id in SVC_SERVICE_REQUESTS table -
ReferenceObjectPuid: string
Title:
Reference ID
Maximum Length:100
API response attribute that maps to ref_obj_puid in SVC_SERVICE_REQUESTS table -
ReferenceObjectType: string
Title:
Reference Object Type
Maximum Length:50
Reference Object Type -
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 request. -
ReportedByPartyName: string
Title:
Reported By
Read Only:true
Maximum Length:360
The name of the reported party. -
ReportedByPartyNumber: string
Title:
Reported by Party Number
Read Only:true
Maximum Length:30
The alternative key for the party identifier of the person reporting 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 resolution code of the service request. -
ResolutionCdMeaning: string
Title:
Resolution Value
Read Only:true
The display value corresponding to the resolution lookup code for the service request. -
ResolvedBy: string
Title:
Resolved By
Maximum Length:64
The user who resolved the service request. -
ResolveDescription: string
Title:
Solution Description
Maximum Length:1000
The description of how the service request has been resolved. -
ResolveOutcomeCd: string
Title:
Outcome
Maximum Length:30
The outcome of a service request resolution. -
ResolveOutcomeCdMeaning: string
Title:
Outcome Value
Read Only:true
The display value corresponding to the resolution outcome lookup code for the service request. -
resourceMembers: array
Resources
Title:
Resources
The list of resources associated to 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 severity of the service request. -
SeverityCdMeaning: string
Title:
Severity Value
Read Only:true
The display value corresponding to the severity lookup code for the service request. -
SeverityCdTransient: string
Title:
Severity
The severity of the service request. -
SeverityColorCd: string
Title:
Severity Color Code
Read Only:true
The color code for the severity of the service request. -
SeverityRank: integer
Title:
Severity Rank
Read Only:true
The numeric code of the service request severity. -
smartActions: array
Smart Actions
Title:
Smart Actions
This VO stores the endpoint and security details for every user action. -
SourceCd: string
Title:
Source Code
Maximum Length:30
Indicates how the service request was created in the application. -
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
Indicates the list of interaction references for 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. -
SrLastUpdateLogin: string
Title:
Source System SR Last Updated by User Login ID
Maximum Length:32
The login of the user who last updated the service request. -
srMilestone: array
Milestones
Title:
Milestones
Indicates the milestone associated with the service request. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the milestone associated to the service request. -
SrNumber: string
Title:
Request Number
Maximum Length:30
The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements. -
srReferences: array
References
Title:
References
The list of other objects associated to the service request. E.g. Knowledge articles. -
srTags: array
Tags
Title:
Tags
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request. -
StatusCd: string
Title:
Status
Maximum Length:30
The status code of the service request. -
StatusCdMeaning: string
Title:
Status Value
Read Only:true
The display value corresponding to the status lookup code for the service request. -
StatusTypeCd: string
Title:
Status Type
Read Only:true
Maximum Length:30
The status type of the service request. -
StatusTypeCdMeaning: string
Title:
Status Type Value
Read Only:true
The display value corresponding to the status type lookup code for the service request. -
StripeCd: string
Maximum Length:
30
Default Value:ORA_SVC_ISR
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. -
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:
Subject
Maximum Length:400
The 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 whether the user has access to update the record. -
WarnedFlag: boolean
Title:
Warned
Read Only:true
Indicates whether the milestone passed the warning threshold.
Nested Schema : Activities
Type:
array
Title:
Activities
The activities resource is used to view, create, update, and delete an activity.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Communications
Type:
array
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Contact Members
Type:
array
Title:
Contact Members
The list of contacts associated to the serivce request.
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 list of service request messages.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The list of resources associated to the service request.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : Interaction References
Type:
array
Title:
Interaction References
Indicates the list of interaction references for a service request.
Show Source
Nested Schema : Milestones
Type:
array
Title:
Milestones
Indicates the milestone associated with the service request.
Show Source
Nested Schema : References
Type:
array
Title:
References
The list of other objects associated to the service request. E.g. Knowledge articles.
Show Source
Nested Schema : Tags
Type:
array
Title:
Tags
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.
Show Source
Nested Schema : internalServiceRequests-activities-item-response
Type:
Show Source
object
-
AccountAddress: string
Title:
Account Address
Read Only:true
The address associated with the account. -
AccountId: integer
(int64)
Title:
Account ID
The unique identifier of the account. -
AccountIdAttr: integer
The internal attribute for the account Id.
-
AccountName: string
Title:
Account
The name of the account associated to 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 account number of the account associated with the activity. -
AccountPhoneNumber: string
Title:
Account Phone Number
Read Only:true
The phone number associated with the account. -
AccountStatus: string
Read Only:
true
Maximum Length:1
The status of the account. -
AccountType: string
Read Only:
true
Maximum Length:30
The type of the account. -
ActivityCreatedBy: string
Title:
Activity Created By
Read Only:true
Maximum Length:64
The activity user who created the activity. -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation Date
Read Only:true
The date when the activity was created. -
ActivityDescription: string
(byte)
Title:
Description
A text field for capturing some descriptive information about the activity. -
ActivityDirection: string
Read Only:
true
The direction of the interaction. -
ActivityEndDate: string
(date-time)
Title:
End Date
The end date and time of an appointment, or the completion time of a task. -
ActivityFilter: string
Read Only:
true
An internal attribute to add additional activity filter. -
ActivityFunctionCode: string
Title:
Activity
Maximum Length:30
The task vs appointment. This is for system use only. -
ActivityFunctionCodeTrans: string
Title:
Activity
Maximum Length:255
The activity function code. -
ActivityId: integer
(int64)
Title:
Activity ID
System generated nonnullable primary key of the table. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update Login
Read Only:true
Maximum Length:32
Original Activity Last Update Login -
ActivityMtgMinutes: string
(byte)
Title:
Meeting Minutes
The activity meeting minutes. -
ActivityNumber: string
Title:
Activity Number
Maximum Length:64
The alternate identifier of the activity. -
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
Indicates the priority of the activity (Internal Usage). -
ActivityStartDate: string
(date-time)
Title:
Start Date
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task. -
ActivityStatus: string
Title:
Status
Read Only:true
The status of the activity. -
ActivitySubtypeCode: string
Title:
Subtype
Maximum Length:30
Displays a list of subtype values that are dependent on the value of the activity. -
ActivityTimezone: string
Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.
-
ActivityType: string
Title:
Activity Type
The type of the activity. -
ActivityTypeCode: string
Title:
Type
Maximum Length:30
The type or category of the activity. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated Date
Read Only:true
The date when the activity was updated. -
ActivityUpdatedBy: string
Title:
Activity Updated By
Read Only:true
Maximum Length:64
The user who updated the activity. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated Date
Read Only:true
The date when the activity was last updated. -
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Default Value:false
Designates that an appointment is the entire day. -
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. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of the asset. -
AssetName: string
Title:
Asset
The name of the asset. -
AssetNumber: string
Title:
Asset Number
The alternate identifier of the asset. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The serial number of the asset. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:ZMM_ACTY_ACTIVITIES
The name of the attachment entity. -
AutoLogSource: string
Title:
Source System
Maximum Length:30
For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity. -
BpId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BuOrgId: integer
(int64)
Title:
Business Unit
The unique identifier for the Business Unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business Plan
The business plan name associated to the activity. -
BusinessPlanNumber: string
Title:
Business Plan Number
The business plan number of the business plan associated with the activity. -
CalendarAccess: boolean
The access rights to calendar. (Internal Usage)
-
CalendarRecurType: string
The activity recurrence type.
-
CalendarSubject: string
The activity subject.
-
CalendarSubjectDay: string
The title of the calendar.
-
CalendarTimeType: string
Indicates all day appointment. (Internal Usage)
-
CallReportCount: integer
(int32)
Title:
Call Report Count
Default Value:0
A count of the number of call reports. -
CallReportUpcomingYN: string
Indicates Y,N,M for upcoming appointments.
-
CallReportYN: string
Flag to Check if this activity has a Call Report
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign
The name of the campaign associated to the activity. -
CampaignNumber: string
Title:
Campaign Number
The campaign number 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 alternate identifier of the case. -
CaseTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The title of the case. -
CheckedInBy: string
Title:
Checked-In By
Maximum Length:64
The name of the person who checks-in to a location. -
CheckedOutBy: string
Title:
Checked-Out By
Maximum Length:64
The name of the person who checks-out to a location. -
CheckinDate: string
(date-time)
Title:
Check-In Time
Stores the date and time when a user checks in to an appointment. -
CheckinLatitude: number
Title:
Check-In Latitude
Stores the latitude of a location where a user checks in to an appointment. -
CheckinLongitude: number
Title:
Check-In Longitude
Stores the longitude of a location where a user checks in to an appointment. -
CheckoutDate: string
(date-time)
Title:
Check-Out Time
Stores the date and time when a user checks out of an appointment. -
CheckoutLatitude: number
Title:
Check-Out Latitude
Stores the latitude of a location where a user checks out of an appointment. -
CheckoutLongitude: number
Title:
Check-Out Longitude
Stores the longitude of a location where a user checks out of an appointment. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the claim. -
ClaimName: string
Title:
MDF Claim
The name associated to the activity. -
ClaimNumber: string
Title:
Claim Number
The number of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0
The unique internal identifier of the conflict -
ContactIDAttr: integer
The internal contact identifier.
-
ContactNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The contact number of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code from profile. -
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
Attribute to capture the Date and Time the activity was created. This is defaulted by the application. -
CurcyConvRateType: string
Title:
Currency Conversion Rate
Maximum Length:30
Holds the currency code of a record. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Holds the currency conversion rate type from profile. -
CurrentDateForCallReport: string
(date-time)
The current date for the call report.
-
CurrentDateForCallReportAttr: string
(date-time)
The internal attribute for the current date for the call report.
-
CurrentSystemDtTransient: string
(date)
Read Only:
true
The current system date, -
CustomerAccountId: integer
(int64)
Title:
Customer Account ID
The unique identifier of the customer account. -
DealId: integer
(int64)
Title:
Deal ID
The unique identifier of the related deal. -
DealNumber: string
Title:
Deal Registration
The deal number associated to the activity. -
DelegatorId: integer
(int64)
Title:
Delegator ID
The activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated By
The name of activity resource that delegated activity ownership to another resource. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the user has access to delete the record. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
Direction
Maximum Length:30
The inbound or outbound. It's optional. The default is null. -
DismissAssignee: string
Title:
Dismissed
Indicates whether the assignees is dismissed. Valid values are Y and N. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Indicates whether this activity is dismissed. -
DoNotCallFlag: boolean
Read Only:
true
Flag to indicate if primary Contact can be called. -
DueDate: string
(date)
Title:
Due Date
The date the task activity is due to be completed. -
Duration: number
Title:
Duration
The duration of an appointment or task. -
DynamicClaimLOVSwitcher: string
Read Only:
true
The unique identifier of the account. -
EmailSentDate: string
(date-time)
This field is used to capture the Activity Email Notification shared date for Outlook integration.
-
EndDateForCallReport: string
(date-time)
The end date of the call report.
-
EndDateForCallReportAttr: string
(date-time)
The internal attribute for end date of the call report.
-
EndDtRFAttr: string
(date-time)
The internal attribute for activity start date.
-
ExternalContactEmail: string
Title:
Primary Email
Maximum Length:320
The email 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 that the activity isn't created by an internal resource. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the fund request. -
FundRequestName: string
Title:
MDF Request
The fund request name associated to the activity. -
FundRequestNumber: string
Title:
Fund Request Number
The fund request number 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 internal attribute to identify recurrence mode. -
IsClientService: string
Default Value:
Y
The obsolete internal attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The attribute to capture the date and time the activity was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The attribute to capture the identifier of the user who last updated the activity. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The attribute to capture the identifiers of the user who last updated the activity. -
LeadId: integer
(int64)
Title:
Lead ID
Indicates the related lead to the activity. -
LeadIdAttr: integer
The internal attribute for the lead Id.
-
LeadName: string
Title:
Lead
Indicates the lead name. -
LeadNameOsn: string
Title:
Social Lead Name
The lead name displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead Number
The lead number of 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
Indicates the location of an appointment. -
LocationId: integer
(int64)
Title:
Location ID
The location or address ID of the activity account or primary contact. -
LoginUserRFAttr: integer
The internal attribute for activity login user.
-
MdfRequestId: integer
The identifier for fund request.
-
MobileActivityCode: string
Title:
Mobile Activity Code
Maximum Length:50
The unique identifier of external mobile device. -
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 internal attribute for the opportunity Id.
-
OpportunityName: string
Title:
Opportunity
The name of opportunity associated to the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity Name
The opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity Number
The opportunity number 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 activity identifier.
-
OtherPartyPhoneNumber: string
Title:
Other Party Phone Number
Maximum Length:40
For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called. -
OutcomeCode: string
Title:
Outcome
Maximum Length:30
The code of the outcome of the activity. -
OutlookAutoSyncFlag: boolean
Title:
Microsoft Auto-Synchronization
Maximum Length:1
Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365. -
OutlookFlag: boolean
Title:
Outlook
Maximum Length:1
Default Value:false
Indicates whether the activity was created from Outlook and synced. -
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 from outlook activity. -
OwnerAddress: string
Title:
Activity Owner Address
Read Only:true
The activity owner's address. -
OwnerEmailAddress: string
Title:
Activity Owner Email
Read Only:true
Maximum Length:320
The activity owner's email address. -
OwnerId: integer
(int64)
Title:
Owner ID
The primary resource on the activity. Supports resources only. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of primary resource of 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 activity owner's phone number. -
ParentActivityId: integer
(int64)
Title:
Parent ID
The related activity identifier, only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The internal attribute for the parent activity Id.
-
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 partner enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment Number
The surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party ID
The party identifier of the partner organization. -
PartnerPartyName: string
Title:
Partner
Maximum Length:80
The party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner Number
The partner party number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The related partner program. -
PartnerProgramName: string
Title:
Program
The name of partner program associated to the activity. -
PartnerProgramNumber: string
Title:
Program Number
The partner program number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner Usage
Maximum Length:1
Default Value:false
Flag to indicate that the Activity has been created for an Organization Account with usage as Partner. -
PercentageComplete: number
Title:
Percentage Complete
Default Value:0
The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end. -
PrimaryContactEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
Hold the email identifier of the primary contact. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The primary contact of the activity. -
PrimaryContactName: string
Title:
Primary Contact
The name of the primary contact. -
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 address of the primary contact. -
PrimaryFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the primary contact. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The priority of the activity. Default to 2. Possible values: 1, 2, 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
Repeat on specified day of month for monthly appointments. -
RecurEndDate: string
(date-time)
Title:
Ends
Ends on a specified date. -
RecurEveryOptionFlag: boolean
Title:
Recurrence Option
Maximum Length:1
It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N. -
RecurExceptionFlag: boolean
Title:
Recurrence Exception
Maximum Length:1
Indicates if appointment instance has been updated outside of recurring appointment series. -
RecurFrequency: number
Title:
Repeat
Frequency that the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
Friday
Maximum Length:1
Repeat on Friday. -
RecurMonFlag: boolean
Title:
Monday
Maximum Length:1
Repeat on Monday. -
RecurMonth: string
Title:
Month
Maximum Length:30
Repeat on specified month (for yearly appointments). -
RecurNumberOfInstances: number
Title:
Number of Instances
Designates specific number of occurrences for the series to end after. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance Date
Original date of a recurring appointment instance. -
RecurPattern: string
Title:
Pattern
Maximum Length:30
Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last. -
RecurRecType: string
Title:
Recurrence Record Type
Maximum Length:1
Default Value:N
For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task. -
RecurSatFlag: boolean
Title:
Saturday
Maximum Length:1
Repeat on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series ID
Series Id that links instances of a series together. -
RecurSunFlag: boolean
Title:
Sunday
Maximum Length:1
Repeat on Sunday. -
RecurThuFlag: boolean
Title:
Thursday
Maximum Length:1
Repeat on Thursday. -
RecurTueFlag: boolean
Title:
Tuesday
Maximum Length:1
Repeat on Tuesday. -
RecurTypeCode: string
Title:
Recurrence Type
Maximum Length:30
Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, 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
Repeat on Wednesday. -
RecurWeekday: string
Title:
Pattern Type
Maximum Length:30
It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day. -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity Type
Maximum Length:30
The activity type for a reference customer activity. To be used as an extension only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference Customer
The identifier of the reference customer party associated with the activity. -
ReminderPeriod: string
Title:
Set Reminder
The reminder period. -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
The resource number of owner associated with the activity. -
ResponseCode: string
Title:
Response
The response code. -
SalesObjectiveName: string
Title:
Sales Objective
The sales objective name associated to the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective Number
The sales objective number of the 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
Indicates whether the activity is open, complete, or all activities. -
ShowTimeAs: string
Title:
Show Time As
The show time of the 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
This is an internal column which is used to sort the activity based on the due date for task and start date for activity. -
SourceObjectCode: string
The code of the object to which activity will get related to.
-
SourceObjectId: integer
The identifier of the object to which activity will get related to.
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request
The service request number. -
StartDateForCallReport: string
(date-time)
The start date of the call report.
-
StartDateForCallReportAttr: string
(date-time)
The internal attribute for start date of the call report.
-
StartDtRFAttr: string
(date-time)
The internal attribute for Activity Start Date.
-
StatusCode: string
Title:
Status
Maximum Length:30
Status of the activity. Defaulted to NOT_STARTED. -
Subject: string
Title:
Subject
Maximum Length:500
The subject of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted By
The call report submitter. -
SubmittedByName: string
Title:
Submitted By
Maximum Length:255
The name of the call report submitter. -
SubmittedDate: string
(date-time)
Title:
Submitted Date
The call report submission date. -
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 task reminder period. -
TemplateDuration: number
Title:
Template Duration
The duration in days of the template activity. This attribute is used with the start date when generating an activity from a template 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
The unique identifier of the template. -
TemplateLeadTime: number
Title:
Lead Time
The lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the user has access to update the record. -
UpgSourceObjectId: string
Read Only:
true
Maximum Length:64
The primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
UpgSourceObjectType: string
Read Only:
true
Maximum Length:30
The source object type could be Appointment, Task or Interaction to indicate 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 : internalServiceRequests-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading 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 category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 error code, 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 expiration date of the contents in the attachment. -
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 URI of the file. -
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 record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
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 size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created 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 : internalServiceRequests-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 : internalServiceRequests-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 : internalServiceRequests-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 the account name would be the inbound mailbox for support. -
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 or phone. A list of accepted values are 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, such as Slack Id. -
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's 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. -
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 whether the channel communication has been deleted. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request. -
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's being communicated with. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the person who's being communicated with. -
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 customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
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. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the channel communication has been updated. -
ViaId: integer
(int64)
Title:
ID
Read Only:true
The unique identifier of the service request channel communication record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-contacts-item-response
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The access level granted to the service request 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 contact. -
ContactFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of 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 alternative key for the contact identifier. -
ContactPreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of 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 of the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the contact as a member of the service request. -
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 whether the user has access to delete the record. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates whether the contact of the service request doesn't want to be contacted. -
FormattedAddress: string
Title:
Formatted Address
Read Only:true
Indicates 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 service request contact member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last update the contact's 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 person ID of the contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The 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 alternative key for the service request number. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the user has access to update the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-messages-item-response
Type:
Show Source
object
-
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
channelCommunication: array
Service Request Communications
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include 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 channel type, such a email, phone, social, and so on. -
CollabResource: string
Title:
Collaboration Resource
The unique identifier of the collaboration network user that the internal users are communicating with. -
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 email Id of the person who created the service request message. -
CreatedByPartyId: string
Title:
Created by Party ID
Read Only:true
Maximum Length:80
The unique party identifier of the person 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 whether the user has access to delete the record. -
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 login of 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 service request 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
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 date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdatedBy: string
Title:
Last Updated By
Maximum Length:64
The user who last updated 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 updated 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 message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The type of social network. -
NotificationProcessingStatusCd: string
Title:
Notification Processing Status Code
Maximum Length:30
The notification processing status code. -
NotificationRetryCount: integer
(int32)
Title:
Notification Retry Count
The notification retry count. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. -
ObjectTypeCd: string
Title:
Object Type Code
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. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The unique 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 message. -
PartyName: string
Title:
Posted By
Read Only:true
Maximum Length:360
The party name of the user who 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 alternative key for the party identifier of the person posting the service request message. -
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 processing status of the message. The accepted values are Ready, Processing, Error, and Success. -
ReplyToMessageId: integer
(int64)
Title:
Reply to Message ID
Read Only:true
The unique identifier of the customer message to which the agent is replying to. -
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 last 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 service request was created from a private social post. -
SourceCd: string
Title:
Source Code
Maximum Length:30
The source of the message. -
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 alternative key for the service request number. -
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 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 that's used for outbound communication of the message. -
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 thread hierarchy level. -
ThreadId: integer
Title:
Thread Identifier
Read Only:true
The unique identifier of the service request message thread. -
ThreadLastUpdateDate: string
(date-time)
Title:
Thread Last Updated Date
Read Only:true
The date when the thread 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 whether the user has access to update the record. -
VisibilityCd: string
Title:
Visibility Code
Maximum Length:30
The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Communications
Type:
array
Title:
Service Request Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include 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 : internalServiceRequests-messages-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading 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 category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 error code, 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 expiration date of the contents in the attachment. -
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 URI of the file. -
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 record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
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 size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created 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 : internalServiceRequests-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 : internalServiceRequests-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 : internalServiceRequests-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 the account name would be the inbound mailbox for support. -
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's 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 while 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. -
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's being communicated with. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the person who's being communicated with. -
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 customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
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. -
ViaId: integer
(int64)
Title:
ID
Read Only:true
The unique identifier of the service request channel communication record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-resourceMembers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the service request resource member. -
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 whether the user has access to delete the record. -
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 login of 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 of the service request resource member. -
ObjectId: integer
(int64)
Title:
Service Request Team Member Resource ID
The unique identifier of the service request resource member. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_RESOURCE
Indicates whether the resource is an individual or a team. -
OwnerFlag: boolean
Title:
Assigned To
Indicates whether 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 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
The formatted address of the SR 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 service request resource member. -
ResourcePartyNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
The alternative key for the service request resource. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The alternative key for the service request number. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the user has access to update the record. -
UserGUID: string
Title:
User GUID
Read Only:true
Maximum Length:64
The global unique identifier of the service request resource member. -
UserId: integer
(int64)
Title:
User ID
Read Only:true
The unique user identifier of 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 : internalServiceRequests-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
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the 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 if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
Uniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action Name
Maximum Length:256
Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
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
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : internalServiceRequests-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
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
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-srInteractionReferences-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the account associated with the interaction. -
AccountPartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The account name associated with the interaction. -
ChannelDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:400
The display name of the channel that's populated in the interaction. -
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 channel type of the interaction. -
ContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the contact person with whom the agent is interacting. -
ContactPartyUniqueName: string
Title:
Contact
Read Only:true
Maximum Length:900
The name of the customer contact for the interaction. -
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 whether the record can be deleted. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the interaction. -
DirectionCd: string
Title:
Direction
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_INBOUND
The direction of the interaction. -
EndTime: string
(date-time)
Title:
End Time
Read Only:true
The time when the interaction ended. -
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 reference for the interaction. -
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 resource, which is an internal interaction owner such as a service agent, associated with the interaction. -
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 of 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 queue in the interaction. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the reference relationship. -
StartTime: string
(date-time)
Title:
Start Time
Read Only:true
The start time of the interaction. -
StatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_OPEN
The interaction status. -
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 whether the interaction is a top level interaction. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the record can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-srMilestone-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates whether the service request 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 customer or agent comments. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone is to be completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
The compliance status of the milestone. -
CoverageId: integer
(int64)
Title:
Coverage ID
The unique identifier for the coverage record. -
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 record was created. -
DelayTime: integer
(int64)
Title:
Delay Time
The time between the due date and the completion date. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the user has access to delete the record. -
DueDate: string
(date-time)
The due date of the milestone.
-
EntitlementId: integer
The unique identifier of the entitlement record.
-
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 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 record. -
MilestoneLabel: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the milestone. -
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The status of the milestone. -
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 time when the milestone pauses. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique party object identifier of the service request assignee. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request record. -
SrMilestoneHistory: array
Milestones History
Title:
Milestones History
The list of changes in the service request milestone status. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the service request milestone record. -
StartConditionLabel: string
Title:
Starts When
Read Only:true
Maximum Length:1000
The time when the milestone 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, in minutes, to complete the milestone after it's restored from the 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 whether the user has access to update the record. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether milestone 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 : Milestones History
Type:
array
Title:
Milestones History
The list of changes in the service request milestone status.
Show Source
Nested Schema : internalServiceRequests-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 of the agent. -
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. -
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 record. -
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 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 status of the milestone. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
The milestone overridden due date. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone record. -
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 : internalServiceRequests-srReferences-item-response
Type:
Show Source
object
-
ArticleId: string
Title:
Article ID
Maximum Length:64
The unique identifier of the referenced article. -
ArticleLocale: string
Title:
Article Locale
Maximum Length:10
The locale of the knowledge management article. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the reference to the service request. -
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 whether the user has access to delete the record. -
DocumentId: string
Title:
Document ID
Read Only:true
Maximum Length:50
The unique document identifier 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 record 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
Indicates whether the object is referenced to the service request. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The object type of the reference object. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the current reference record. -
RelationTypeCd: string
Title:
Relation Type
Maximum Length:30
The relationship type between the service request and the referenced object. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
Indicates whether the referenced object helps in resolving the service request. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The alternative key for the service request number. -
Subject: string
Title:
Title
Maximum Length:1000
The title of the referenced object. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the user has access to update the record
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-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
- Attachment
-
Parameters:
- SrId:
$request.path.SrId
The attachments resource is used to view, create, and update attachments. - SrId:
- BusinessUnitsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BUOrgId; Target Attribute: BusinessUnitId
- Display Attribute: Name
- ChannelLOV
-
Operation: /crmRestApi/resources/11.13.18.05/channelsParameters:
- finder:
EnabledChannelByBUAndStripeAndTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}%2CStripeCd%3D{StripeCd}%2CBUOrgId%3D{BUOrgId}
The following properties are defined on the LOV link relation:- Source Attribute: ChannelId; Target Attribute: ChannelId
- Display Attribute: DisplayName, ChannelTypeCd, BusinessUnitName, StripeCd
- finder:
- ChannelTypeCdLookup
-
Parameters:
- finder:
IsActiveIsEnabledFinder
The following properties are defined on the LOV link relation:- Source Attribute: ChannelTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- GeographyLovPVO
-
Operation: /crmRestApi/resources/11.13.18.05/geoZonesThe following properties are defined on the LOV link relation:
- Source Attribute: ServiceZoneId; Target Attribute: GeographyId
- Display Attribute: GeographyId
- InternalPriorityLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_INT_PRIORITY_CD
The following properties are defined on the LOV link relation:- Source Attribute: InternalPriorityCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LanguageCdLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: LanguageCd; Target Attribute: LanguageCode
- Display Attribute: LanguageCode, Description
- NetworkTypeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: NetworkTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OwnerTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_OWNER_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: OwnerTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProblemCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_PROBLEM_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: ProblemCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductGroupLOV_ISR
-
The following properties are defined on the LOV link relation:
- Source Attribute: ProdGroupName; Target Attribute: ProdGroupName
- Display Attribute: ProdGroupName, ProdGroupDescTxt, UsageName
- ProductInventoryItemLOV_ISR
-
The following properties are defined on the LOV link relation:
- Source Attribute: ProductItemDescription; Target Attribute: Description
- Display Attribute: Description, ItemNumber, ProdGroupName, UsageCode
- QueueVO
-
Operation: /crmRestApi/resources/11.13.18.05/queuesParameters:
- finder:
QueueEnabledFinder
The following properties are defined on the LOV link relation:- Source Attribute: QueueName; Target Attribute: QueueName
- Display Attribute: QueueName
- finder:
- ResolutionCdLookupISR
-
Parameters:
- finder:
SrResolutionCdFinderISR%3BBindChildLookupType%3DORA_SVC_ISR_RESOLUTION_CD%2CBindParentLookupType%3DORA_SVC_ISR_RESOLVE_OUTCOME%2CBindParentLookupCode%3D{ResolveOutcomeCd}
The following properties are defined on the LOV link relation:- Source Attribute: ResolutionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResolveOutcomeCdLookupISR
-
The following properties are defined on the LOV link relation:
- Source Attribute: ResolveOutcomeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- ResourcePickerLOV
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe following properties are defined on the LOV link relation:
- Source Attribute: AssigneePersonName; Target Attribute: PartyName
- Display Attribute: PartyName, EmailAddress
- SearchFilterLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_SEARCH_REC_SET_CD
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SeverityCdLookupISR
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_ISR_SEVERITY_CD
The following properties are defined on the LOV link relation:- Source Attribute: SeverityCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
The following properties are defined on the LOV link relation:- Source Attribute: SourceCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SrCategoryLOV
-
Operation: /crmRestApi/resources/11.13.18.05/categoriesParameters:
- finder:
CategoryEnabledFinder
The following properties are defined on the LOV link relation:- Source Attribute: CategoryId; Target Attribute: CategoryId
- Display Attribute: CategoryName, CategoryShortName, BusinessUnitName, StripeCd
- finder:
- SrStatusCdLookupISR
-
Parameters:
- finder:
IsEnabledFinder%3BBindChildLookupType%3DORA_SVC_ISR_STATUS_CD%2CBindParentLookupType%3DORA_SVC_SR_STATUS_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: StatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_STATUS_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: StatusTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TimezoneVO
-
Parameters:
- finder:
EnabledFinder
The following properties are defined on the LOV link relation:- Source Attribute: TimezoneCode; Target Attribute: TimezoneCode
- Display Attribute: TimezoneCode
- finder:
- TransferReasonCdLookupISR
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_ISR_TRANSFER_REASON
The following properties are defined on the LOV link relation:- Source Attribute: TransferReasonCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: CriticalFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- activities
-
Parameters:
- SrId:
$request.path.SrId
The activities resource is used to view, create, update, and delete an activity. - SrId:
- channelCommunication
-
Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunicationParameters:
- SrId:
$request.path.SrId
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers. - SrId:
- contacts
-
Parameters:
- SrId:
$request.path.SrId
The list of contacts associated to the serivce request. - SrId:
- getSrMilestoneDiagnostics
-
Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/getSrMilestoneDiagnosticsParameters:
- SrId:
$request.path.SrId
Evaluates service request and applies any required changes to its milestones. - SrId:
- messages
-
Parameters:
- SrId:
$request.path.SrId
The list of service request messages. - SrId:
- processSrMilestones
-
Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/processSrMilestonesParameters:
- SrId:
$request.path.SrId
Returns the service request milestone diagnostics report results for the specified service request. - SrId:
- resourceMembers
-
Parameters:
- SrId:
$request.path.SrId
The list of resources associated to the service request. - SrId:
- sendEmailForSrMessage
-
Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/sendEmailForSrMessageParameters:
- SrId:
$request.path.SrId
This method lets you send an email to the recipients of the service request message for the specified message identifier. - SrId:
- smartActions
-
Parameters:
- SrId:
$request.path.SrId
This VO stores the endpoint and security details for every user action. - SrId:
- srInteractionReferences
-
Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferencesParameters:
- SrId:
$request.path.SrId
Indicates the list of interaction references for a service request. - SrId:
- srMilestone
-
Parameters:
- SrId:
$request.path.SrId
Indicates the milestone associated with the service request. - SrId:
- srReferences
-
Parameters:
- SrId:
$request.path.SrId
The list of other objects associated to the service request. E.g. Knowledge articles. - SrId:
- srTags
-
Parameters:
- SrId:
$request.path.SrId
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request. - SrId: