Get all service requests
get
/crmRestApi/resources/11.13.18.05/internalServiceRequests
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- MyCriticalSRsFinder :Finds critical service requests assigned to a user.
Finder Variables:- AssigneeResourceId :The unique identifier of the assignee resource.
- MySRsByStatusFinder :Finds a service requests with a specific status that are assigned to a user.
Finder Variables:- AssigneeResourceId :The unique identifier of the assignee resource.
- StatusCd :The status code of the service request.
- MySRsFinder :Finds a service requests assigned to the user.
Finder Variables:- AssigneeResourceId :The unique identifier of the assignee resource.
- PrimaryKey :Finds a service request with the specified primary key.
Finder Variables:- SrId :The unique identifier of the service request.
- SRListMySRTeamSRsFinder :Finds service requests for the team.
Finder Variables: - SRsCreatedByMeFinder :Find a service request created by a user.
Finder Variables:- CreatedBy :The user who created the service request.
- SRsListByResource :Finds a service requests by resource ID.
Finder Variables:- ResourceId :The resource ID passed as parameter to the service request finder service.
- ServiceRequestByNumber :Finds a service request by SR number.
Finder Variables:- SrNumber :The service request number passed as parameter to the finder service.
- ServiceRequestByStripeCd :Finds a service requests by stripe code.
Finder Variables:- StripeCd :The stripe code passed as parameter to the service request finder service.
- MyCriticalSRsFinder :Finds critical service requests assigned to a user.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AffectedPartyAssignmentNumber; string; The unique assignment number of the affected party person for the service request.
- AffectedPartyPersonName; string; The display name of the affected party person in the service request.
- AssigneePersonName; string; The email address of the assignee.
- AssigneeResourceId; integer; The unique identifier of the assignee resource.
- AssigneeResourceNumber; string; The alternative key for the resource identifier of the assignee.
- AssigneeTimezone; string; The time zone of the assignee associated with the service request.
- AssistedByHumanFlag; boolean; Indicates whether human agents worked on the service request at any stage of its lifecycle.
- BUOrgId; integer; The unique identifier of the business unit associated to the service request.
- CategoryCode; string; Indicates the alternate key of the category associated to the service request.
- CategoryId; integer; The unique identifier of the service request category.
- CategoryName; string; The name of the category associated to the service request.
- ChannelTypeCd; string; The channel type.
- ChannelTypeCdMeaning; string; The display value corresponding to the channel type lookup code for the service request.
- ClosedDate; string; The date when the service request was closed, if closed.
- ComplianceFlag; boolean; The compliance status of the milestone.
- CreatedBy; string; The user who created the service request.
- CreationDate; string; The date and time when the service request was created.
- CriticalFlag; boolean; Indicates whether the service request is critical. If critical, the value is Y, else the value is N.
- DueDate; string; The date when the milestone is due.
- FirstTransferDate; string; The date when the service request was first transferred.
- HandledByAIFlag; boolean; Indicates whether automation agents acted upon the service request at any point in its lifecycle.
- HeaderFlag; boolean; Indicates whether the current milestone should be saved on the service request header.
- IBAssetDescription; string; The description of the installed base asset associated with the service request.
- IBAssetId; integer; The unique identifier of the associated install base asset record.
- IBAssetNumber; string; The installed base asset number of the service request.
- IBAssetSerialNumber; string; The install base asset serial number of the service request.
- InternalPriorityCd; string; The internal priority of the service request.
- InventoryItemId; integer; The unique identifier of the product associated to the service request.
- InventoryOrgId; integer; The unique identifier of the organization of the product that's associated with the service request.
- LanguageCd; string; The customer's preferred language for the service request.
- LastReopenDate; string; The date and time when the service request was last reopened.
- LastResolvedDate; string; The date and time when the service request was resolved.
- LastTransferDate; string; Indicates the date and time of the last transfer of the service request.
- LastTransferredBy; string; The user who last transferred the service request.
- LastUpdateDate; string; The date and time when the service request was last updated.
- LastUpdatedBy; string; The user who last updated the service request.
- LastUpdatedByDisplayName; string; The display name of the user who last updated the service request.
- LastUpdatedByEmailAddress; string; The e-mail address of the person who last updated the service request.
- LastUpdatedByPartyId; integer; The unique party identifier of the person who last updated the service request.
- MilestoneConfigId; integer; The unique identifier of the milestone configuration associated with the service request.
- MilestoneLabel; string; The name of the milestone.
- MilestoneStatusCd; string; The status of the milestone.
- OpenDate; string; The date when the service request was reported by the customer.
- OriginalSystemReference; string; The reference to the service request record in the original system from which service request was imported.
- PrimaryContactAssignmentNumber; string; The unique assignment number of the primary contact of the service request.
- PrimaryContactDoNotContactFlag; boolean; The primary contact of the service request doesn't want to be contacted.
- PrimaryContactPartyId; integer; The unique identifier of the primary contact of the service request.
- PrimaryContactPartyName; string; The name of the service request primary contact.
- PrimaryContactPartyNumber; string; The alternative key for the primary contact identifier.
- PrimaryContactPersonId; integer; The unique identifier of the primary contact of the service request.
- PrimaryContactPersonIdTransient; string; The unique identifier of the primary contact of the service request.
- PrimaryContactPreferredContactMethod; string; The preferred contact method of the primary contact of the service request.
- ProblemCd; string; The problem code of the service request.
- ProblemDescription; string; The service request's problem description or statement and the steps to reproduce the issue.
- ProdGroupName; string; The name of the product group associated to the service request.
- ProductGroupReferenceNumber; string; The alternative key for the product group identifier.
- ProductItemDescription; string; The description of the product associated with the service request.
- ProductItemNumber; string; The product number or code of the product associated with the service request.
- QueueId; integer; The unique identifier of the queue to which the service request is assigned.
- QueueName; string; The name of the queue associated to the service request.
- QueueNumber; string; The alternative key for the queue identifier.
- RecordSet; string; The record set used by REST API to run saved searches.
- ReferenceObjectId; integer; API response attribute that maps to ref_obj_id in SVC_SERVICE_REQUESTS table
- ReferenceObjectPuid; string; API response attribute that maps to ref_obj_puid in SVC_SERVICE_REQUESTS table
- ReferenceObjectType; string; Reference Object Type
- ReportedByEmailAddress; string; The e-mail address of the person who reported the service request.
- ReportedByPartyId; integer; The user who created the request.
- ReportedByPartyName; string; The name of the reported party.
- ReportedByPartyNumber; string; The alternative key for the party identifier of the person reporting the service request.
- ReportedByPartyUniqueName; string; The unique name of the user who created the service request.
- ResolutionCd; string; The resolution code of the service request.
- ResolutionCdMeaning; string; The display value corresponding to the resolution lookup code for the service request.
- ResolveDescription; string; The description of how the service request has been resolved.
- ResolveOutcomeCd; string; The outcome of a service request resolution.
- ResolveOutcomeCdMeaning; string; The display value corresponding to the resolution outcome lookup code for the service request.
- ResolvedBy; string; The user who resolved the service request.
- ResolvedByAIFlag; boolean; Indicates whether the service request was resolved with the assistance of automation agents.
- ResolvedByPartyId; integer; The unique identifier of the user who resolved this service request.
- ScheduleId; integer; The unique identifier of the current schedule associated with the service request.
- ServiceZoneId; integer; The unique identifier of the service request region.
- ServiceZoneName; string; The name of the service request region.
- SeverityCd; string; The severity of the service request.
- SeverityCdMeaning; string; The display value corresponding to the severity lookup code for the service request.
- SeverityCdTransient; string; The severity of the service request.
- SeverityRank; integer; The numeric code of the service request severity.
- SourceCd; string; Indicates how the service request was created in the application.
- SrId; integer; The unique identifier of the service request record.
- SrLastUpdatedByPartyId; integer; The unique identifier of the user who last updated the service request.
- SrLastUpdatedByPartyName; string; The name of the party who last updated the service request.
- SrMilestoneId; integer; The unique identifier of the milestone associated to the service request.
- SrNumber; string; 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.
- StatusCd; string; The status code of the service request.
- StatusCdMeaning; string; The display value corresponding to the status lookup code for the service request.
- StatusTypeCd; string; The status type of the service request.
- StatusTypeCdMeaning; string; The display value corresponding to the status type lookup code for the service request.
- StripeCd; string; The application stripe of the service request.
- SurveyResponseDate; string; The date and time when the response to this survey was submitted.
- SurveySentDate; string; The date and time when survey was last sent for this service request.
- TimeRemaining; string; The time remaining in the milestone.
- TimezoneCode; string; The service request time zone optionally used for computing the milestone due date.
- Title; string; The brief title of the service request.
- TransferCount; integer; The count showing how many times a service request has been transferred.
- TransferNote; string; This field contains information about transfer note.
- TransferReasonCd; string; The lookup code that indicates the transfer reason.
- UniqueExternalSystemReference; string; 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.
- WarnedFlag; boolean; Indicates whether the milestone passed the warning threshold.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context: string
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: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : internalServiceRequests
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-item-response
Type:
Show Source
object-
activities: array
Activities
Title:
ActivitiesThe activities resource is used to view, create, update, and delete an activity. -
AffectedPartyAssignmentNumber: string
Title:
Affected Party Person Assignment NumberMaximum Length:50The unique assignment number of the affected party person for the service request. -
AffectedPartyPersonId: string
Title:
Affected PartyThe unique identifier of the affected party person. -
AffectedPartyPersonName: string
Title:
Affected Party Person NameRead Only:trueThe display name of the affected party person in the service request. -
AssigneeEmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the assignee. -
AssigneeFormattedAddress: string
Title:
Assignee Formatted AddressRead Only:trueThe formatted address of the SR assignee. -
AssigneeFormattedPhoneNumber: string
Title:
Assignee PhoneRead Only:trueThe phone number of the resource to whom the service request is assigned. -
AssigneePartyId: integer
(int64)
Title:
Assigned to Party IDRead Only:trueThe unique identifier of the assignee party. -
AssigneePersonName: string
Title:
Assigned ToMaximum Length:360The email address of the assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource IDThe unique identifier of the assignee resource. -
AssigneeResourceNumber: string
Title:
Assigned to Resource NumberRead Only:trueMaximum Length:30The alternative key for the resource identifier of the assignee. -
AssigneeTimezone: string
Title:
Assignee Time ZoneRead Only:trueMaximum Length:255The time zone of the assignee associated with the service request. -
AssistedByHumanFlag: boolean
Title:
Assisted by Human FlagMaximum Length:1Default Value:falseIndicates whether human agents worked on the service request at any stage of its lifecycle. -
Attachment: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
BUOrgId: integer
(int64)
Title:
Business UnitThe unique identifier of the business unit associated to the service request. -
BusinessUnitName: string
Title:
Business Unit NameRead Only:trueMaximum Length:255The name of the business unit associated to the service request -
CategoryCode: string
Title:
Category CodeMaximum Length:290Indicates the alternate key of the category associated to the service request. -
CategoryId: integer
(int64)
Title:
CategoryThe unique identifier of the service request category. -
CategoryName: string
Title:
Category NameRead Only:trueMaximum Length:400The name of the category associated to the service request. -
channelCommunication: array
Service Request Communications
Title:
Service Request CommunicationsThe 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:
ChannelThe unique identifier of the service request channel. -
ChannelTypeCd: string
Title:
Channel TypeMaximum Length:30The channel type. -
ChannelTypeCdMeaning: string
Title:
Channel Type ValueRead Only:trueMaximum Length:255The display value corresponding to the channel type lookup code for the service request. -
ClosedDate: string
(date-time)
Title:
Date ClosedThe date when the service request was closed, if closed. -
ComplianceFlag: boolean
Title:
ComplianceRead Only:trueThe compliance status of the milestone. -
contacts: array
Contact Members
Title:
Contact MembersThe list of contacts associated to the serivce request. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the service request. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the service request was created. -
CriticalFlag: boolean
Title:
CriticalMaximum Length:1Default Value:falseIndicates whether the service request is critical. If critical, the value is Y, else the value is N. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The corporate currency conversion rate type. -
CurrencyCode: string
Title:
Currency CodeMaximum Length:15The currency code. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record -
DueDate: string
(date-time)
Title:
Due DateRead Only:trueThe date when the milestone is due. -
FirstTransferDate: string
(date-time)
Title:
First Transfer DateThe date when the service request was first transferred. -
HandledByAIFlag: boolean
Title:
Handled by AI FlagMaximum Length:1Default Value:falseIndicates whether automation agents acted upon the service request at any point in its lifecycle. -
HeaderFlag: boolean
Title:
HeaderRead Only:trueMaximum Length:1Indicates whether the current milestone should be saved on the service request header. -
IBAssetDescription: string
Title:
Installed Base Asset DescriptionRead Only:trueMaximum Length:240The description of the installed base asset associated with the service request. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset IDThe unique identifier of the associated install base asset record. -
IBAssetNumber: string
Title:
Installed Base Asset NumberRead Only:trueMaximum Length:80The installed base asset number of the service request. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial NumberRead Only:trueMaximum Length:80The install base asset serial number of the service request. -
InternalPriorityCd: string
Title:
Internal Priority CodeMaximum Length:30The internal priority of the service request. -
InventoryItemId: integer
(int64)
Title:
Inventory Item IDThe unique identifier of the product associated to the service request. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization IDThe unique identifier of the organization of the product that's associated with the service request. -
LanguageCd: string
Title:
Language CodeMaximum Length:30The customer's preferred language for the service request. -
LastReopenDate: string
(date-time)
Title:
Date ReopenedThe date and time when the service request was last reopened. -
LastResolvedDate: string
(date-time)
Title:
Resolution DateThe date and time when the service request was resolved. -
LastTransferDate: string
(date-time)
Title:
Last Transfer DateIndicates the date and time of the last transfer of the service request. -
LastTransferredBy: string
Title:
Last Transferred ByMaximum Length:64The user who last transferred the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the service request was last updated. -
LastUpdatedBy: string
Title:
Last Updated by Login IDRead Only:trueMaximum Length:64The user who last updated the service request. -
LastUpdatedByDisplayName: string
Title:
Last Updated ByRead Only:trueMaximum Length:3600The display name of the user who last updated the service request. -
LastUpdatedByEmailAddress: string
Title:
Last Updated by Email AddressRead Only:trueMaximum Length:255The e-mail address of the person who last updated the service request. -
LastUpdatedByPartyId: integer
(int64)
Title:
Last Updated by Party IDThe unique party identifier of the person who last updated the service request. -
LastUpdatedByPartyNumber: string
Title:
Last Updated by Party NumberRead Only:trueMaximum Length:30The alternative key for the party identifier of the person who last updated the service request. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the service request. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
messages: array
Messages
Title:
MessagesThe list of service request messages. -
MilestoneConfigId: integer
(int64)
Title:
Configuration IDRead Only:trueThe unique identifier of the milestone configuration associated with the service request. -
MilestoneLabel: string
Title:
Milestone NameRead Only:trueThe name of the milestone. -
MilestoneStatusCd: string
Title:
Milestone StatusRead Only:trueMaximum Length:255The status of the milestone. -
NetworkTypeCd: string
Title:
NetworkRead Only:trueMaximum Length:30The type of social network. -
OpenDate: string
(date-time)
Title:
Date ReportedThe date when the service request was reported by the customer. -
OriginalSystemReference: string
Title:
Original SystemMaximum Length:255The reference to the service request record in the original system from which service request was imported. -
OwnerTypeCd: string
Title:
Owner TypeMaximum Length:30The 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 NumberMaximum Length:50The unique assignment number of the primary contact of the service request. -
PrimaryContactDoNotContactFlag: boolean
Title:
Primary Contact Do Not ContactRead Only:trueMaximum Length:1The primary contact of the service request doesn't want to be contacted. -
PrimaryContactEmailAddress: string
Title:
Primary Contact EmailRead Only:trueMaximum Length:320The e-mail of the primary contact associated with the service request. -
PrimaryContactFormattedAddress: string
Title:
Primary Contact Formatted AddressRead Only:trueThe formatted address of the primary contact of the service request. -
PrimaryContactFormattedPhoneNumber: string
Title:
Primary Contact PhoneRead Only:trueThe service request primary contact's formatted phone number -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact IDThe unique identifier of the primary contact of the service request. -
PrimaryContactPartyName: string
Title:
Primary ContactRead Only:trueMaximum Length:360The name of the service request primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact NumberRead Only:trueMaximum Length:30The alternative key for the primary contact identifier. -
PrimaryContactPersonId: integer
(int64)
Title:
Primary Contact Person IDThe unique identifier of the primary contact of the service request. -
PrimaryContactPersonIdTransient: string
Title:
Primary Point of ContactThe unique identifier of the primary contact of the service request. -
PrimaryContactPreferredContactMethod: string
Title:
Primary Contact Preferred Contact MethodRead Only:trueMaximum Length:30The preferred contact method of the primary contact of the service request. -
ProblemCd: string
Title:
Problem Type CodeMaximum Length:30The problem code of the service request. -
ProblemDescription: string
Title:
Detailed DescriptionMaximum Length:1000The service request's problem description or statement and the steps to reproduce the issue. -
ProdGroupId: integer
(int64)
Title:
Product Group IDThe unique identifier of the product group associated to the service request. -
ProdGroupName: string
Title:
Product GroupThe name of the product group associated to the service request. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference NumberThe alternative key for the product group identifier. -
ProductItemDescription: string
Title:
Product DescriptionThe description of the product associated with the service request. -
ProductItemNumber: string
Title:
Product NumberRead Only:trueMaximum Length:255The product number or code of the product associated with the service request. -
ProductItemOrgId: integer
(int64)
Title:
Product OrganizationRead Only:trueThe unique identifier of the product organization. -
QueueId: integer
(int64)
Title:
Assigned Queue IDThe unique identifier of the queue to which the service request is assigned. -
QueueName: string
Title:
QueueMaximum Length:400The name of the queue associated to the service request. -
QueueNumber: string
Title:
Queue NumberRead Only:trueMaximum Length:30The alternative key for the queue identifier. -
RecordSet: string
Title:
Search FilterRead Only:trueThe record set used by REST API to run saved searches. -
ReferenceObjectId: integer
(int64)
Title:
Reference Object IDAPI response attribute that maps to ref_obj_id in SVC_SERVICE_REQUESTS table -
ReferenceObjectPuid: string
Title:
Reference IDMaximum Length:100API response attribute that maps to ref_obj_puid in SVC_SERVICE_REQUESTS table -
ReferenceObjectType: string
Title:
Reference Object TypeMaximum Length:50Reference Object Type -
ReportedByEmailAddress: string
Title:
Reported by Email IDRead Only:trueMaximum Length:320The e-mail address of the person who reported the service request. -
ReportedByFormattedPhoneNumber: string
Title:
Reported by Phone NumberRead Only:trueThe formatted phone number of the person who reported the service request. -
ReportedByPartyId: integer
(int64)
Title:
Reported by Party IDThe user who created the request. -
ReportedByPartyName: string
Title:
Reported ByRead Only:trueMaximum Length:360The name of the reported party. -
ReportedByPartyNumber: string
Title:
Reported by Party NumberRead Only:trueMaximum Length:30The alternative key for the party identifier of the person reporting the service request. -
ReportedByPartyUniqueName: string
Title:
Reported by Unique NameRead Only:trueMaximum Length:900The unique name of the user who created the service request. -
ResolutionCd: string
Title:
Resolution CodeMaximum Length:30The resolution code of the service request. -
ResolutionCdMeaning: string
Title:
Resolution ValueRead Only:trueThe display value corresponding to the resolution lookup code for the service request. -
ResolvedBy: string
Title:
Resolved ByMaximum Length:64The user who resolved the service request. -
ResolvedByAIFlag: boolean
Title:
Resolved by AI FlagMaximum Length:1Default Value:falseIndicates whether the service request was resolved with the assistance of automation agents. -
ResolvedByPartyId: integer
(int64)
Title:
Resolved by Party IDThe unique identifier of the user who resolved this service request. -
ResolveDescription: string
Title:
Solution DescriptionMaximum Length:1000The description of how the service request has been resolved. -
ResolveOutcomeCd: string
Title:
OutcomeMaximum Length:30The outcome of a service request resolution. -
ResolveOutcomeCdMeaning: string
Title:
Outcome ValueRead Only:trueThe display value corresponding to the resolution outcome lookup code for the service request. -
resourceMembers: array
Resources
Title:
ResourcesThe list of resources associated to the service request. -
ScheduleId: integer
(int64)
Title:
Schedule IdentifierThe unique identifier of the current schedule associated with the service request. -
ServiceZoneId: integer
(int64)
Title:
Region IdentifierThe unique identifier of the service request region. -
ServiceZoneName: string
Title:
Service RegionRead Only:trueMaximum Length:360The name of the service request region. -
SeverityCd: string
Title:
SeverityMaximum Length:30The severity of the service request. -
SeverityCdMeaning: string
Title:
Severity ValueRead Only:trueThe display value corresponding to the severity lookup code for the service request. -
SeverityCdTransient: string
Title:
SeverityThe severity of the service request. -
SeverityColorCd: string
Title:
Severity Color CodeRead Only:trueThe color code for the severity of the service request. -
SeverityRank: integer
Title:
Severity RankRead Only:trueThe numeric code of the service request severity. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
SourceCd: string
Title:
Source CodeMaximum Length:30Indicates how the service request was created in the application. -
SrCreatedBy: string
Title:
Source System SR Created ByMaximum Length:64The user who created the service request. -
SrId: integer
(int64)
Title:
Service Request IDRead Only:trueThe unique identifier of the service request record. -
srInteractionReferences: array
Interaction References
Title:
Interaction ReferencesIndicates the list of interaction references for a service request. -
SrLastUpdateDate: string
(date-time)
Title:
Last Update Date in Source SystemThe date and time when the service request was last updated. -
SrLastUpdatedBy: string
Title:
Source System SR Last Updated ByMaximum Length:64The user who last updated the service request. -
SrLastUpdatedByPartyId: integer
(int64)
Title:
Source System SR Last Updated ByThe unique identifier of the user who last updated the service request. -
SrLastUpdatedByPartyName: string
Title:
Source System SR Last Updated by Party NameRead Only:trueMaximum Length:360The name of the party who last updated the service request. -
SrLastUpdateLogin: string
Title:
Source System SR Last Updated by User Login IDMaximum Length:32The login of the user who last updated the service request. -
srMilestone: array
Milestones
Title:
MilestonesIndicates the milestone associated with the service request. -
SrMilestoneId: integer
(int64)
Title:
Milestone IDRead Only:trueThe unique identifier of the milestone associated to the service request. -
SrNumber: string
Title:
Request NumberMaximum Length:30The 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:
ReferencesThe list of other objects associated to the service request. E.g. Knowledge articles. -
srTags: array
Tags
Title:
TagsThe 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:
StatusMaximum Length:30The status code of the service request. -
StatusCdMeaning: string
Title:
Status ValueRead Only:trueThe display value corresponding to the status lookup code for the service request. -
StatusTypeCd: string
Title:
Status TypeRead Only:trueMaximum Length:30The status type of the service request. -
StatusTypeCdMeaning: string
Title:
Status Type ValueRead Only:trueThe display value corresponding to the status type lookup code for the service request. -
StripeCd: string
Title:
Stripe CodeMaximum Length:30Default Value:ORA_SVC_ISRThe application stripe of the service request. -
SurveyResponseDate: string
(date-time)
Title:
Survey Response DateRead Only:trueThe date and time when the response to this survey was submitted. -
SurveySentDate: string
(date-time)
Title:
Survey Sent DateRead Only:trueThe date and time when survey was last sent for this service request. -
TimeRemaining: string
Title:
Time RemainingRead Only:trueThe time remaining in the milestone. -
TimezoneCode: string
Title:
Time Zone CodeMaximum Length:50The service request time zone optionally used for computing the milestone due date. -
Title: string
Title:
SubjectMaximum Length:400The brief title of the service request. -
TransferCount: integer
(int64)
Title:
Transfer CountThe count showing how many times a service request has been transferred. -
TransferNote: string
Title:
Transfer NoteMaximum Length:1500This field contains information about transfer note. -
TransferReasonCd: string
Title:
Transfer ReasonMaximum Length:30The lookup code that indicates the transfer reason. -
UniqueExternalSystemReference: string
Title:
Unique External System Reference NumberMaximum Length:255The 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 UpdateRead Only:trueIndicates whether the user has access to update the record. -
WarnedFlag: boolean
Title:
WarnedRead Only:trueIndicates whether the milestone passed the warning threshold.
Nested Schema : Activities
Type:
arrayTitle:
ActivitiesThe activities resource is used to view, create, update, and delete an activity.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Communications
Type:
arrayTitle:
Service Request CommunicationsThe 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:
arrayTitle:
Contact MembersThe list of contacts associated to the serivce request.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
arrayTitle:
MessagesThe list of service request messages.
Show Source
Nested Schema : Resources
Type:
arrayTitle:
ResourcesThe list of resources associated to the service request.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : Interaction References
Type:
arrayTitle:
Interaction ReferencesIndicates the list of interaction references for a service request.
Show Source
Nested Schema : Milestones
Type:
arrayTitle:
MilestonesIndicates the milestone associated with the service request.
Show Source
Nested Schema : References
Type:
arrayTitle:
ReferencesThe list of other objects associated to the service request. E.g. Knowledge articles.
Show Source
Nested Schema : Tags
Type:
arrayTitle:
TagsThe 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 AddressRead Only:trueThe address associated with the account. -
AccountId: integer
(int64)
Title:
Account IDThe unique identifier of the account. -
AccountIdAttr: integer
The internal attribute for the account Id.
-
AccountName: string
Title:
AccountThe name of the account associated to activity. -
AccountNameOsn: string
Title:
Social Account NameThe account name displayed in Oracle Social Network. -
AccountNumber: string
Title:
Account NumberRead Only:trueMaximum Length:30The account number of the account associated with the activity. -
AccountPhoneNumber: string
Title:
Account Phone NumberRead Only:trueThe phone number associated with the account. -
AccountStatus: string
Read Only:
trueMaximum Length:1The status of the account. -
AccountType: string
Read Only:
trueMaximum Length:30The type of the account. -
ActivityCreatedBy: string
Title:
Activity Created ByRead Only:trueMaximum Length:64The activity user who created the activity. -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation DateRead Only:trueThe date when the activity was created. -
ActivityDescription: string
(byte)
Title:
DescriptionA text field for capturing some descriptive information about the activity. -
ActivityDirection: string
Read Only:
trueThe direction of the interaction. -
ActivityEndDate: string
(date-time)
Title:
End DateThe end date and time of an appointment, or the completion time of a task. -
ActivityFilter: string
Read Only:
trueAn internal attribute to add additional activity filter. -
ActivityFunctionCode: string
Title:
ActivityMaximum Length:30The task vs appointment. This is for system use only. -
ActivityFunctionCodeTrans: string
Title:
ActivityMaximum Length:255The activity function code. -
ActivityId: integer
(int64)
Title:
Activity IDSystem generated nonnullable primary key of the table. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update LoginRead Only:trueMaximum Length:32Original Activity Last Update Login -
ActivityMtgMinutes: string
(byte)
Title:
Meeting MinutesThe activity meeting minutes. -
ActivityNumber: string
Title:
Activity NumberMaximum Length:64The alternate identifier of the activity. -
ActivityOutcome: string
Read Only:
trueThe outcome of the activity. -
ActivityPartialDescription: string
Title:
Short DescriptionMaximum Length:4000A column that stores the first 4000 characters of activity description. -
ActivityPriority: string
Title:
PriorityIndicates the priority of the activity (Internal Usage). -
ActivityStartDate: string
(date-time)
Title:
Start DateThe 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:
StatusRead Only:trueThe status of the activity. -
ActivitySubtypeCode: string
Title:
SubtypeMaximum Length:30Displays 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 TypeThe type of the activity. -
ActivityTypeCode: string
Title:
TypeMaximum Length:30The type or category of the activity. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated DateRead Only:trueThe date when the activity was updated. -
ActivityUpdatedBy: string
Title:
Activity Updated ByRead Only:trueMaximum Length:64The user who updated the activity. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated DateRead Only:trueThe date when the activity was last updated. -
AllDayFlag: boolean
Title:
All DayMaximum Length:1Default Value:falseDesignates that an appointment is the entire day. -
AppointmentStatus: string
Title:
Appointment StatusMaximum Length:30The status of the appointment. -
ApptEndTime: string
(date-time)
Title:
End TimeThe time when the activity ends. -
ApptStartTime: string
(date-time)
Title:
Start TimeThe time when the activity starts. -
ArticleVersionId: string
Title:
Article Version IDMaximum Length:64The unique identifier of the article version. -
AssessmentId: integer
(int64)
Title:
Assessment IDThe unique identifier of the assessment. -
AssetId: integer
(int64)
Title:
Asset IDThe unique identifier of the asset. -
AssetName: string
Title:
AssetThe name of the asset. -
AssetNumber: string
Title:
Asset NumberThe alternate identifier of the asset. -
AssetSerialNumber: string
Title:
Asset Serial NumberRead Only:trueMaximum Length:100The serial number of the asset. -
AttachmentEntityName: string
Maximum Length:
255Default Value:ZMM_ACTY_ACTIVITIESThe name of the attachment entity. -
AutoLogSource: string
Title:
Source SystemMaximum Length:30For 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 IDThe unique identifier of the business plan. -
BuOrgId: integer
(int64)
Title:
Business UnitThe unique identifier for the Business Unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business PlanThe business plan name associated to the activity. -
BusinessPlanNumber: string
Title:
Business Plan NumberThe 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 CountDefault Value:0A 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 IDThe unique identifier of the campaign. -
CampaignName: string
Title:
CampaignThe name of the campaign associated to the activity. -
CampaignNumber: string
Title:
Campaign NumberThe campaign number of the campaign associated with the activity. -
CaseId: integer
(int64)
Title:
Case IDThe unique identifier of the case. -
CaseNumber: string
Title:
Case NumberThe alternate identifier of the case. -
CaseTitle: string
Title:
TitleRead Only:trueMaximum Length:400The title of the case. -
CheckedInBy: string
Title:
Checked-In ByMaximum Length:64The name of the person who checks-in to a location. -
CheckedOutBy: string
Title:
Checked-Out ByMaximum Length:64The name of the person who checks-out to a location. -
CheckinDate: string
(date-time)
Title:
Check-In TimeStores the date and time when a user checks in to an appointment. -
CheckinLatitude: number
Title:
Check-In LatitudeStores the latitude of a location where a user checks in to an appointment. -
CheckinLongitude: number
Title:
Check-In LongitudeStores the longitude of a location where a user checks in to an appointment. -
CheckoutDate: string
(date-time)
Title:
Check-Out TimeStores the date and time when a user checks out of an appointment. -
CheckoutLatitude: number
Title:
Check-Out LatitudeStores the latitude of a location where a user checks out of an appointment. -
CheckoutLongitude: number
Title:
Check-Out LongitudeStores the longitude of a location where a user checks out of an appointment. -
ClaimId: integer
(int64)
Title:
Claim IDThe unique identifier of the claim. -
ClaimName: string
Title:
MDF ClaimThe name associated to the activity. -
ClaimNumber: string
Title:
Claim NumberThe number of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0The unique internal identifier of the conflict -
ContactIDAttr: integer
The internal contact identifier.
-
ContactNumber: string
Title:
Contact NumberRead Only:trueMaximum Length:30The contact number of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate CurrencyMaximum Length:15The corporate currency code from profile. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the activity. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueAttribute to capture the Date and Time the activity was created. This is defaulted by the application. -
CurcyConvRateType: string
Title:
Currency Conversion RateMaximum Length:30Holds the currency code of a record. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Holds 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:
trueThe current system date, -
CustomerAccountId: integer
(int64)
Title:
Customer Account IDThe unique identifier of the customer account. -
DealId: integer
(int64)
Title:
Deal IDThe unique identifier of the related deal. -
DealNumber: string
Title:
Deal RegistrationThe deal number associated to the activity. -
DelegatorId: integer
(int64)
Title:
Delegator IDThe activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated ByThe name of activity resource that delegated activity ownership to another resource. -
DeleteFlag: boolean
Read Only:
trueIndicates whether the user has access to delete the record. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
DirectionMaximum Length:30The inbound or outbound. It's optional. The default is null. -
DismissAssignee: string
Title:
DismissedIndicates whether the assignees is dismissed. Valid values are Y and N. -
DismissFlag: boolean
Title:
DismissedMaximum Length:1Indicates whether this activity is dismissed. -
DoNotCallFlag: boolean
Read Only:
trueFlag to indicate if primary Contact can be called. -
DueDate: string
(date)
Title:
Due DateThe date the task activity is due to be completed. -
Duration: number
Title:
DurationThe duration of an appointment or task. -
DynamicClaimLOVSwitcher: string
Read Only:
trueThe 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 EmailMaximum Length:320The email address of an external contact. -
ExternalContactName: string
Title:
External Contact NameMaximum Length:360The name of an external contact. -
ExternallyOwnedFlag: boolean
Title:
Externally OwnedMaximum Length:1Default Value:falseIndicates that the activity isn't created by an internal resource. -
FundRequestId: integer
(int64)
Title:
Fund Request IDThe unique identifier of the fund request. -
FundRequestName: string
Title:
MDF RequestThe fund request name associated to the activity. -
FundRequestNumber: string
Title:
Fund Request NumberThe fund request number of the fund request associated with the activity. -
IbAssetId: integer
(int64)
Title:
IB Asset IDThe unique identifier of the installed base asset associated with the activity. -
IbAssetNumber: string
Title:
Installed Base AssetThe number of the installed base asset associated with the activity. -
IbAssetSerialNumber: string
Title:
Installed Base Asset Serial NumberRead Only:trueMaximum Length:80The serial number of the installed base asset associated with the activity. -
InstNumDerivedFrom: string
Default Value:
YThe internal attribute to identify recurrence mode. -
IsClientService: string
Default Value:
YThe obsolete internal attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe attribute to capture the date and time the activity was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The attribute to capture the identifier of the user who last updated the activity. -
LastUpdateLogin: string
Title:
Last Updated LoginRead Only:trueMaximum Length:32The attribute to capture the identifiers of the user who last updated the activity. -
LeadId: integer
(int64)
Title:
Lead IDIndicates the related lead to the activity. -
LeadIdAttr: integer
The internal attribute for the lead Id.
-
LeadName: string
Title:
LeadIndicates the lead name. -
LeadNameOsn: string
Title:
Social Lead NameThe lead name displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead NumberThe lead number of lead associated with the activity. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Location: string
Title:
LocationMaximum Length:200Indicates the location of an appointment. -
LocationId: integer
(int64)
Title:
Location IDThe 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 CodeMaximum Length:50The unique identifier of external mobile device. -
NotesLinkSourceCodeTransient: string
Read Only:
trueThe note source object. -
ObjectiveId: integer
(int64)
Title:
Objective IDThe unique identifier of the objective. -
OpportunityId: integer
(int64)
Title:
Opportunity IDThe unique identifier of the related opportunity. -
OpportunityIdAttr: integer
The internal attribute for the opportunity Id.
-
OpportunityName: string
Title:
OpportunityThe name of opportunity associated to the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity NameThe opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity NumberThe opportunity number of the opportunity associated with the activity. -
OrchestrationId: integer
(int64)
Title:
Orchestration IDThe unique identifier to identify the orchestration process. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step IDThe unique identifier to identify the orchestration step. -
OrigEntityCode: string
Maximum Length:
30Default Value:ACTIVITYThe column to store the source of activity record during upgrade. -
OrigEntityNumber: string
Maximum Length:
64The 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 NumberMaximum Length:40For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called. -
OutcomeCode: string
Title:
OutcomeMaximum Length:30The code of the outcome of the activity. -
OutlookAutoSyncFlag: boolean
Title:
Microsoft Auto-SynchronizationMaximum Length:1Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365. -
OutlookFlag: boolean
Title:
OutlookMaximum Length:1Default Value:falseIndicates whether the activity was created from Outlook and synced. -
OutlookGlobalId: string
Title:
Outlook Global IDMaximum Length:1024The unique identifier of an appointment created from Microsoft 365. -
OutlookIdentifier: string
Title:
Outlook IdentifierMaximum Length:1024The unique identifier from outlook activity. -
OwnerAddress: string
Title:
Activity Owner AddressRead Only:trueThe activity owner's address. -
OwnerEmailAddress: string
Title:
Activity Owner EmailRead Only:trueMaximum Length:320The activity owner's email address. -
OwnerId: integer
(int64)
Title:
Owner IDThe primary resource on the activity. Supports resources only. -
OwnerName: string
Title:
OwnerMaximum Length:360The name of primary resource of activity. -
OwnerNameOsn: string
Title:
Social Owner NameThe owner name displayed in Oracle Social Network. -
OwnerPhoneNumber: string
Title:
Activity Owner Phone NumberRead Only:trueThe activity owner's phone number. -
ParentActivityId: integer
(int64)
Title:
Parent IDThe 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 MinutesMaximum Length:4000A column that stores a truncated string of the meeting minutes. -
PartnerEnrollmentId: integer
(int64)
Title:
Enrollment IDThe unique identifier of the partner enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment NumberThe surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party IDThe party identifier of the partner organization. -
PartnerPartyName: string
Title:
PartnerMaximum Length:80The party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner NumberThe partner party number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program IDThe related partner program. -
PartnerProgramName: string
Title:
ProgramThe name of partner program associated to the activity. -
PartnerProgramNumber: string
Title:
Program NumberThe partner program number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner UsageMaximum Length:1Default Value:falseFlag to indicate that the Activity has been created for an Organization Account with usage as Partner. -
PercentageComplete: number
Title:
Percentage CompleteDefault Value:0The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end. -
PrimaryContactEmailAddress: string
Title:
Primary EmailRead Only:trueMaximum Length:320Hold the email identifier of the primary contact. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact IDThe primary contact of the activity. -
PrimaryContactName: string
Title:
Primary ContactThe name of the primary contact. -
PrimaryContactNameOsn: string
Title:
Social Primary Contact NameThe primary contact name displayed in Oracle Social Network. -
PrimaryFormattedAddress: string
Title:
Primary Contact AddressRead Only:trueThe address of the primary contact. -
PrimaryFormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe phone number of the primary contact. -
PriorityCode: string
Title:
PriorityMaximum Length:30The priority of the activity. Default to 2. Possible values: 1, 2, 3. -
PrivateFlag: boolean
Title:
PrivateMaximum Length:1Indicates whether the activity is private. -
RecordSet: string
Title:
Record SetMaximum Length:255The set of records to display in activity search. -
RecurDay: integer
(int64)
Title:
DayRepeat on specified day of month for monthly appointments. -
RecurEndDate: string
(date-time)
Title:
EndsEnds on a specified date. -
RecurEveryOptionFlag: boolean
Title:
Recurrence OptionMaximum Length:1It'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 ExceptionMaximum Length:1Indicates if appointment instance has been updated outside of recurring appointment series. -
RecurFrequency: number
Title:
RepeatFrequency that the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
FridayMaximum Length:1Repeat on Friday. -
RecurMonFlag: boolean
Title:
MondayMaximum Length:1Repeat on Monday. -
RecurMonth: string
Title:
MonthMaximum Length:30Repeat on specified month (for yearly appointments). -
RecurNumberOfInstances: number
Title:
Number of InstancesDesignates specific number of occurrences for the series to end after. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance DateOriginal date of a recurring appointment instance. -
RecurPattern: string
Title:
PatternMaximum Length:30Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last. -
RecurRecType: string
Title:
Recurrence Record TypeMaximum Length:1Default Value:NFor 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:
SaturdayMaximum Length:1Repeat on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series IDSeries Id that links instances of a series together. -
RecurSunFlag: boolean
Title:
SundayMaximum Length:1Repeat on Sunday. -
RecurThuFlag: boolean
Title:
ThursdayMaximum Length:1Repeat on Thursday. -
RecurTueFlag: boolean
Title:
TuesdayMaximum Length:1Repeat on Tuesday. -
RecurTypeCode: string
Title:
Recurrence TypeMaximum Length:30Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly. -
RecurUpdatedAttributes: string
Title:
Recurrence Updated AttributesMaximum Length:4000The updated field references for recurring appointment exception records. -
RecurWedFlag: boolean
Title:
WednesdayMaximum Length:1Repeat on Wednesday. -
RecurWeekday: string
Title:
Pattern TypeMaximum Length:30It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day. -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity TypeMaximum Length:30The activity type for a reference customer activity. To be used as an extension only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference CustomerThe identifier of the reference customer party associated with the activity. -
ReminderPeriod: string
Title:
Set ReminderThe reminder period. -
ResourceNumber: string
Title:
Resource NumberRead Only:trueMaximum Length:30The resource number of owner associated with the activity. -
ResponseCode: string
Title:
ResponseThe response code. -
SalesObjectiveName: string
Title:
Sales ObjectiveThe sales objective name associated to the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective NumberThe 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:
falseThe records selected for Mass Update (Internal Usage). -
ShowStatus: string
Title:
ShowMaximum Length:255Indicates whether the activity is open, complete, or all activities. -
ShowTimeAs: string
Title:
Show Time AsThe show time of the activity. -
SmartActionContext: string
Title:
Smart Action ContextMaximum Length:4000Stores metadata needed for smart action. -
SmartActionId: integer
(int64)
Title:
Smart Action IDThe smart action Identifier. Foreign key from zca_user_action. -
SortDate: string
(date-time)
Title:
DateThis 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 IDThe unique identifier of the service request. -
SrNumber: string
Title:
Service RequestThe 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:
StatusMaximum Length:30Status of the activity. Defaulted to NOT_STARTED. -
Subject: string
Title:
SubjectMaximum Length:500The subject of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted ByThe call report submitter. -
SubmittedByName: string
Title:
Submitted ByMaximum Length:255The name of the call report submitter. -
SubmittedDate: string
(date-time)
Title:
Submitted DateThe call report submission date. -
SwitchCallId: string
Title:
Switch Call IDMaximum Length:128The unique identifier of the call on the external phone system. -
TaskReminderPeriod: string
Title:
Due Date ReminderThe task reminder period. -
TemplateDuration: number
Title:
Template DurationThe 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:
TemplateMaximum Length:1Default Value:NIndicates whether this is a template activity. -
TemplateId: integer
(int64)
Title:
Template IDThe unique identifier of the template. -
TemplateLeadTime: number
Title:
Lead TimeThe 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:
trueIndicates whether the user has access to update the record. -
UpgSourceObjectId: string
Read Only:
trueMaximum Length:64The primary key value of the record in the source table that is upgraded to Rel9 Activity record. -
UpgSourceObjectType: string
Read Only:
trueMaximum Length:30The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record -
WebConferenceDetails: string
(byte)
Title:
Web Conference DetailsThe web conference details. -
WebConferenceId: string
Title:
Web Conference IDMaximum Length:255The unique identifier of the web conference. -
WebConferenceURL: string
Title:
Web Conference URLMaximum Length:2000The web conference join URL. -
WebconfSyncStatusFlag: boolean
Title:
Web Conference SynchronizationMaximum Length:1The appointment interaction status.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
AttachmentsDFFVL: array
AttachmentsDFFVL
-
AttachmentsPreview: array
Attachments Preview
Title:
Attachments PreviewThe attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Attachments Preview
Type:
arrayTitle:
Attachments PreviewThe attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-Attachment-AttachmentsPreview-item-response
Type:
Show Source
object-
ImageHeight: integer
Title:
Image HeightRead Only:trueThe height of the previewed image. -
ImageSource: string
Title:
Image SourceRead Only:trueThe preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image WidthRead Only:trueThe width of the previewed image. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PageNum: integer
Title:
Page NumberRead Only:trueThe number of the page in the preview.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-channelCommunication-item-response
Type:
Show Source
object-
ChannelAccountName: string
Title:
Account NameRead Only:trueMaximum Length:400The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support. -
ChannelDisplayName: string
Title:
Display NameMaximum Length:400The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel IDThe unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short NameMaximum Length:450The public unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel TypeRead Only:trueMaximum Length:30The 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 IDRead Only:trueMaximum Length:255The unique identifier of the collaboration network user in the corresponding network, such as Slack Id. -
CollabName: string
Title:
Resource NameRead Only:trueMaximum Length:400The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource IdentifierThe unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point IDThe 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 ByRead Only:trueMaximum Length:64The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the communication channel was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the channel communication has been deleted. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object IdentifierThe unique identifier of the inbound object that resulted in the creation of the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated ByRead Only:trueMaximum Length:64The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update LoginRead Only:trueMaximum Length:32The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NetworkTypeCd: string
Title:
NetworkRead Only:trueMaximum Length:30The 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 IDThe 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 TypeRead Only:trueMaximum Length:30Default Value:SVC_SERVICE_REQUESTSThe 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 IDThe unique party identifier of the person who's being communicated with. -
PartyName: string
Title:
Party NameRead Only:trueMaximum Length:360The party name of the person who's being communicated with. -
PartyNumber: string
Title:
Party NumberRead Only:trueMaximum Length:30The public unique identifier of the contact associated with the service request communication. -
PartyViaEndPoint: string
Title:
Party EndpointMaximum Length:1000The 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 IDThe unique person ID of the contact. -
PostIdentifier: string
Title:
Post IdentifierMaximum Length:1000The 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 IDRead Only:trueThe 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 TypeRead Only:trueMaximum Length:30The 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 CodeMaximum Length:30The 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 UpdateRead Only:trueIndicates whether the channel communication has been updated. -
ViaId: integer
(int64)
Title:
IDRead Only:trueThe unique identifier of the service request channel communication record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-contacts-item-response
Type:
Show Source
object-
AccessLevelCd: string
Title:
Access LevelMaximum Length:30The access level granted to the service request contact. -
AccountName: string
Title:
Account NameRead Only:trueMaximum Length:900The primary account of the service request contact. -
ContactEmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the contact. -
ContactFormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe formatted phone number of the contact. -
ContactPartyName: string
Title:
NameMaximum Length:360The name of a service request contact. -
ContactPartyNumber: string
Title:
Contact NumberRead Only:trueMaximum Length:30The alternative key for the contact identifier. -
ContactPreferredContactMethod: string
Title:
Preferred Contact MethodRead Only:trueMaximum Length:30The preferred contact method of the contact. -
ContactTypeCd: string
Title:
Contact TypeMaximum Length:30The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique NameMaximum Length:900The unique party name of the contact. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who added the contact as a member of the service request. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record. -
DoNotContactFlag: boolean
Title:
Do Not ContactRead Only:trueMaximum Length:1Indicates whether the contact of the service request doesn't want to be contacted. -
FormattedAddress: string
Title:
Formatted AddressRead Only:trueIndicates the formatted address of the service request contact. -
JobTitle: string
Title:
Job TitleRead Only:trueMaximum Length:100The job title of the service request contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the service request contact member record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last update the contact's object associated with the service request. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member IDThe unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party IDThe unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person IDThe unique person ID of the contact. -
PrimaryContactFlag: boolean
Title:
PrimaryIndicates 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 CodeMaximum Length:30The 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 IDThe unique identifier of the associated service request. -
SrNumber: string
Title:
Service Request NumberMaximum Length:30The alternative key for the service request number. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the user has access to update the record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-messages-item-response
Type:
Show Source
object-
AILogLevelCd: string
Title:
AI Log Level CodeMaximum Length:30Default Value:ORA_SVC_NONEIndicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE. -
Attachment: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
channelCommunication: array
Service Request Communications
Title:
Service Request CommunicationsThe 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:
ChannelThe unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel TypeMaximum Length:30The channel type, such a email, phone, social, and so on. -
CollabResource: string
Title:
Collaboration ResourceThe unique identifier of the collaboration network user that the internal users are communicating with. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the message. -
CreatedByEmailAddress: string
Title:
Created by Email IDRead Only:trueMaximum Length:320The email Id of the person who created the service request message. -
CreatedByPartyId: string
Title:
Created by Party IDRead Only:trueMaximum Length:80The unique party identifier of the person who created the service request message. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the message was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record. -
FeedFlag: boolean
Title:
Feed FlagMaximum Length:1Default Value:trueIndicates whether the SR Message should be pushed to the SR Feed. Values are Y and N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the message was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the message. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the message. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageContent: string
(byte)
Title:
Message ContentThe content of the service request message. -
MessageCreatedBy: string
Title:
Created ByMaximum Length:64The 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 StateThe message expanding state. -
MessageId: integer
(int64)
Title:
Message IDThe unique identifier of the service request message. -
MessageLastUpdateDate: string
(date-time)
Title:
Last Updated DateThe 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 ByMaximum Length:64The 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 LoginMaximum Length:32The 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 NumberMaximum Length:30The public unique identifier of the service request message. -
MessageSubTypeCd: string
Title:
Message SubtypeMaximum Length:30The service request message subtype. -
MessageTypeCd: string
Title:
Message Type CodeMaximum Length:30The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. -
NetworkTypeCd: string
Title:
NetworkRead Only:trueMaximum Length:30The type of social network. -
NotificationProcessingStatusCd: string
Title:
Notification Processing Status CodeMaximum Length:30The notification processing status code. -
NotificationRetryCount: integer
(int32)
Title:
Notification Retry CountThe notification retry count. -
ObjectId: integer
(int64)
Title:
Object IDThe unique identifier of the object. -
ObjectTypeCd: string
Title:
Object Type CodeMaximum Length:30Default Value:SVC_SR_MESSAGESThe 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 SystemMaximum Length:255The 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 DateThe 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 IDThe unique identifier of the parent message. -
PartyName: string
Title:
Posted ByRead Only:trueMaximum Length:360The 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 IDThe 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 NumberRead Only:trueMaximum Length:30The alternative key for the party identifier of the person posting the service request message. -
PrivateInformationFlag: boolean
Title:
Contains PII DataMaximum Length:1Indicates whether the message contains personally identifiable information. -
ProcessingId: integer
(int64)
Title:
Processing IDRead Only:trueThe unique identifier of the processing. -
ProcessingStatusCd: string
Title:
Processing StatusMaximum Length:30Default Value:ORA_SVC_READYThe processing status of the message. The accepted values are Ready, Processing, Error, and Success. -
ReplyToMessageId: integer
(int64)
Title:
Reply to Message IDRead Only:trueThe unique identifier of the customer message to which the agent is replying to. -
RichTextFlag: boolean
Title:
Rich TextMaximum Length:1Default Value:trueIndicates 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 IdentifierRead Only:trueThe identifier of the root message in the message hierarchy. -
RootThreadCount: integer
Title:
Root Message Thread CountRead Only:trueThe number of messages under a root message in a service request. -
RootThreadLastUpdateDate: string
(date-time)
Title:
Root Message Thread Last Updated DateRead Only:trueThe last updated date for all messages under the root message in a service request. -
RootThreadMessageLastUpdateDate: string
(date-time)
Title:
Root Thread Message Last Updated DateRead Only:trueThe date when all messages under the root message in a service request were last updated. -
SentDate: string
(date-time)
Title:
Sent DateThe date and time when the message was sent. -
SocialPrivateFlag: boolean
Title:
Private MessageMaximum Length:1Indicates whether the service request was created from a private social post. -
SourceCd: string
Title:
Source CodeMaximum Length:30The source of the message. -
SrBUOrgId: integer
(int64)
Title:
Service Request Business UnitRead Only:trueThe identifier of the business unit associated with the service request. -
SrId: integer
(int64)
Title:
Service Request IDThe unique identifier of the service request to which the message is associated. -
SrInlineAttachmentIds: string
Title:
Inline Attachment IdentifiersMaximum Length:1000The list of inline attachment identifiers associated with the service request -
SrNumber: string
Title:
Service Request NumberMaximum Length:30The alternative key for the service request number. -
SrStripeCd: string
Title:
Service Request Application StripeRead Only:trueMaximum Length:30The application stripe of the service request. -
StatusCd: string
Title:
Status CodeMaximum Length:30The status of the message. The accepted values are Draft, Committed, and Corrected. -
Subject: string
Title:
SubjectMaximum Length:1000The subject of the service request message. -
TemplateName: string
Title:
Template NameMaximum Length:240The name of the template that's used for outbound communication of the message. -
ThreadCount: integer
Title:
Thread CountRead Only:trueThe number of threads in a service request message. -
ThreadHierarchyLevel: integer
Title:
Thread Hierarchy LevelRead Only:trueThe thread hierarchy level. -
ThreadId: integer
Title:
Thread IdentifierRead Only:trueThe unique identifier of the service request message thread. -
ThreadLastUpdateDate: string
(date-time)
Title:
Thread Last Updated DateRead Only:trueThe date when the thread was last updated. -
ThreadMessageLastUpdateDate: string
(date-time)
Title:
Thread Message Last Updated DateRead Only:trueThe date when the thread message was last updated. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the user has access to update the record. -
VisibilityCd: string
Title:
Visibility CodeMaximum Length:30The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Communications
Type:
arrayTitle:
Service Request CommunicationsThe 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:
arrayTitle:
LinksThe 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 IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
AttachmentsDFFVL: array
AttachmentsDFFVL
-
AttachmentsPreview: array
Attachments Preview
Title:
Attachments PreviewThe attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Attachments Preview
Type:
arrayTitle:
Attachments PreviewThe attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 HeightRead Only:trueThe height of the previewed image. -
ImageSource: string
Title:
Image SourceRead Only:trueThe preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image WidthRead Only:trueThe width of the previewed image. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PageNum: integer
Title:
Page NumberRead Only:trueThe number of the page in the preview.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-messages-channelCommunication-item-response
Type:
Show Source
object-
ChannelAccountName: string
Title:
Account NameRead Only:trueMaximum Length:400The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support. -
ChannelDisplayName: string
Title:
Display NameMaximum Length:400The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel IDThe unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short NameMaximum Length:450The public unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel TypeRead Only:trueMaximum Length:30The 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 IDRead Only:trueMaximum Length:255The 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 NameRead Only:trueMaximum Length:400The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource IdentifierThe unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point IDThe 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 ByRead Only:trueMaximum Length:64The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the communication channel was created. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object IdentifierThe unique identifier of the inbound object that resulted in the creation of the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated ByRead Only:trueMaximum Length:64The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update LoginRead Only:trueMaximum Length:32The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageNumber: string
Title:
Message NumberRead Only:trueMaximum Length:30The public unique identifier of the service request message. -
NetworkTypeCd: string
Title:
NetworkRead Only:trueMaximum Length:30The 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 IDThe 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 TypeRead Only:trueMaximum Length:30Default Value:SVC_SR_MESSAGESThe 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 IDThe unique party identifier of the person who's being communicated with. -
PartyName: string
Title:
Party NameRead Only:trueMaximum Length:360The party name of the person who's being communicated with. -
PartyNumber: string
Title:
Party NumberRead Only:trueMaximum Length:30The public unique identifier of the contact associated with the service request message. -
PartyViaEndPoint: string
Title:
Party EndpointMaximum Length:1000The 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 IDThe unique person ID of the contact. -
PostIdentifier: string
Title:
Post IdentifierMaximum Length:1000The 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 IDRead Only:trueThe 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 TypeRead Only:trueMaximum Length:30The 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 CodeMaximum Length:30The 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:
IDRead Only:trueThe unique identifier of the service request channel communication record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-resourceMembers-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who added the service request resource member. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the service request resource member was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the service request resource member record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the service request resource member record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the service request resource member. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member IDA unique identifier of the service request resource member. -
ObjectId: integer
(int64)
Title:
Service Request Team Member Resource IDThe unique identifier of the service request resource member. -
ObjectTypeCd: string
Title:
Object TypeRead Only:trueMaximum Length:30Default Value:ORA_SVC_RESOURCEIndicates whether the resource is an individual or a team. -
OwnerFlag: boolean
Title:
Assigned ToIndicates 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 NameRead Only:trueMaximum Length:900The unique name of the service request resource member. -
ResourceEmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the resource member. -
ResourceFormattedAddress: string
Title:
Resource Formatted AddressRead Only:trueThe formatted address of the SR resource member. -
ResourceFormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe formatted phone number of the resource member. -
ResourceName: string
Title:
NameMaximum Length:360The name of the service request resource member. -
ResourcePartyNumber: string
Title:
Resource NumberRead Only:trueMaximum Length:30The alternative key for the service request resource. -
SrId: integer
(int64)
Title:
Service Request IDThe unique identifier of the service request. -
SrNumber: string
Title:
Service Request NumberMaximum Length:30The alternative key for the service request number. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the user has access to update the record. -
UserGUID: string
Title:
User GUIDRead Only:trueMaximum Length:64The global unique identifier of the service request resource member. -
UserId: integer
(int64)
Title:
User IDRead Only:trueThe unique user identifier of the service request resource member. -
Username: string
Title:
User NameRead Only:trueMaximum Length:100The user name of the resource member.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf 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 DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf 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:
arrayTitle:
Smart Action User Interface DefinitionsBinding 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 TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean 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 NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-srInteractionReferences-item-response
Type:
Show Source
object-
AccountPartyId: integer
(int64)
Title:
Account IDRead Only:trueThe unique identifier of the account associated with the interaction. -
AccountPartyUniqueName: string
Title:
AccountRead Only:trueMaximum Length:900The account name associated with the interaction. -
ChannelDisplayName: string
Title:
Display NameRead Only:trueMaximum Length:400The display name of the channel that's populated in the interaction. -
ChannelId: integer
(int64)
Title:
Channel IDRead Only:trueThe unique identifier of the interaction channel. -
ChannelTypeCd: string
Title:
Channel TypeRead Only:trueMaximum Length:30The channel type of the interaction. -
ContactPartyId: integer
(int64)
Title:
Contact IDRead Only:trueThe unique identifier of the contact person with whom the agent is interacting. -
ContactPartyUniqueName: string
Title:
ContactRead Only:trueMaximum Length:900The name of the customer contact for the interaction. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the interaction. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the interaction was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the record can be deleted. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:1000The description of the interaction. -
DirectionCd: string
Title:
DirectionRead Only:trueMaximum Length:30Default Value:ORA_SVC_INBOUNDThe direction of the interaction. -
EndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the interaction ended. -
InteractionId: integer
(int64)
Title:
Interaction IDRead Only:trueThe unique identifier of the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the interaction was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the interaction. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the interaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginalSystemReference: string
Title:
Original SystemRead Only:trueMaximum Length:255The original system reference for the interaction. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource IDRead Only:trueThe unique identifier of the agent who owns the interaction. -
OwnerResourcePartyUniqueName: string
Title:
Resource NameRead Only:trueMaximum Length:900The resource, which is an internal interaction owner such as a service agent, associated with the interaction. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction IDRead Only:trueThe unique identifier of the parent interaction. -
Payload: string
(byte)
Title:
PayloadRead Only:trueThe payload of the interaction. -
QueueId: integer
(int64)
Title:
Queue IDRead Only:trueThe unique identifier of the interaction queue. -
QueueName: string
Title:
NameRead Only:trueMaximum Length:400The name of the queue in the interaction. -
ReferenceId: integer
(int64)
Title:
Reference IDRead Only:trueThe unique identifier of the reference relationship. -
StartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe start time of the interaction. -
StatusCd: string
Title:
StatusRead Only:trueMaximum Length:30Default Value:ORA_SVC_OPENThe interaction status. -
StripeCd: string
Title:
Stripe CodeRead Only:trueMaximum Length:30The application stripe of the interaction. -
TopLevelFlag: boolean
Title:
Top LevelRead Only:trueIndicates whether the interaction is a top level interaction. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the record can be updated.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-srMilestone-item-response
Type:
Show Source
object-
ActiveFlag: boolean
Title:
ActiveMaximum Length:1Default Value:falseIndicates whether the service request milestone is active. -
AgentCompletedFlag: boolean
Title:
Agent CompletedMaximum Length:1Default Value:falseIndicates whether agent marked the milestone as complete. -
AllowAgentCompletionFlag: boolean
Title:
Allow Agent CompletionRead Only:trueMaximum Length:1Default Value:falseIndicates whether an agent can mark the milestone as complete. -
AllowDueDateOverrideFlag: boolean
Title:
Allow Due Date OverrideRead Only:trueMaximum Length:1Default Value:falseIndicates whether an agent can override the milestone due date. -
Comments: string
Title:
CommentsMaximum Length:400The customer or agent comments. -
CompletionDate: string
(date-time)
Title:
Completion DateThe date when the milestone is to be completed. -
ComplianceFlag: boolean
Title:
ComplianceMaximum Length:1Default Value:trueThe compliance status of the milestone. -
CoverageId: integer
(int64)
Title:
Coverage IDThe unique identifier for the coverage record. -
CoverageSourceCd: string
Title:
Coverage SourceMaximum Length:120Coverage Source -
CoverageSourceCdMeaning: string
Title:
Coverage SourceRead Only:trueThe display value corresponding to the coverage source lookup code. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the milestone. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
DelayTime: integer
(int64)
Title:
Delay TimeThe time between the due date and the completion date. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record. -
DueDate: string
(date-time)
Title:
Due DateThe due date of the milestone. -
EntitlementId: integer
The unique identifier of the entitlement record.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the milestone. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the milestone. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MilestoneConfigId: integer
(int64)
Title:
Milestone Configuration IDThe unique identifier of the milestone configuration record. -
MilestoneLabel: string
Title:
NameRead Only:trueMaximum Length:255The name of the milestone. -
MilestoneStatusCd: string
Title:
StatusMaximum Length:30The status of the milestone. -
MilestoneStatusCdMeaning: string
Title:
Milestone StatusRead Only:trueMaximum Length:255The display value corresponding to the status lookup code for the milestone. -
PauseConditionLabel: string
Title:
Pauses WhenRead Only:trueMaximum Length:1000The time when the milestone pauses. -
SrAssigneePartyId: integer
Title:
Assigned to Party IDThe unique party object identifier of the service request assignee. -
SrId: integer
(int64)
Title:
Service Request IDThe unique identifier of the service request record. -
SrMilestoneHistory: array
Milestones History
Title:
Milestones HistoryThe list of changes in the service request milestone status. -
SrMilestoneId: integer
(int64)
Title:
Milestone IDRead Only:trueThe unique identifier of the service request milestone record. -
StartConditionLabel: string
Title:
Starts WhenRead Only:trueMaximum Length:1000The time when the milestone starts. -
SubscriptionCoveragePuid: string
Title:
Subscription Coverage PUIDMaximum Length:120Subscription Coverage PUID -
SubscriptionNumber: string
Title:
Subscription NumberMaximum Length:120Subscription Number -
TimeLeftOnceUnpaused: integer
Title:
Paused Minutes RemainingThe time left, in minutes, to complete the milestone after it's restored from the paused state. -
TimeRemaining: string
Title:
Time RemainingRead Only:trueThe time remaining in the milestone. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the user has access to update the record. -
WarnedFlag: boolean
Title:
WarnedMaximum Length:1Default Value:falseIndicates whether milestone passed the warning threshold. -
WarningDate: string
(date-time)
Title:
Warning DateThe date and time when the milestone passed the warning threshold.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Milestones History
Type:
arrayTitle:
Milestones HistoryThe 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 TimeThe total time the service request milestone spent in the status. -
Comments: string
Title:
CommentsMaximum Length:400The comments of the agent. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe 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 IDRead Only:trueThe unique identifier of the milestone history record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the milestone history. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the milestone history. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MilestoneStatusCd: string
Title:
StatusMaximum Length:30The status of the milestone. -
OverriddenDueDate: string
(date-time)
Title:
Due DateThe milestone overridden due date. -
SrMilestoneId: integer
(int64)
Title:
Milestone IDThe unique identifier of the service request milestone record. -
StartTime: string
(date-time)
Title:
DateThe date and time when the milestone status was changed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-srReferences-item-response
Type:
Show Source
object-
ArticleId: string
Title:
Article IDMaximum Length:64The unique identifier of the referenced article. -
ArticleLocale: string
Title:
Article LocaleMaximum Length:10The locale of the knowledge management article. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who added the reference to the service request. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the service request reference was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record. -
DocumentId: string
Title:
Document IDRead Only:trueMaximum Length:50The unique document identifier associated with the referenced article. -
HelpfulFlag: boolean
Title:
HelpfulMaximum Length:1Indicates whether the service request reference was helpful. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the service request reference. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login ID of the user who last updated the service request reference. -
LinkedFlag: boolean
Title:
LinkedMaximum Length:1Indicates whether the reference is linked with the service request. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object IDIndicates whether the object is referenced to the service request. -
ObjectTypeCd: string
Title:
Object TypeMaximum Length:30The object type of the reference object. -
ReferenceId: integer
(int64)
Title:
Reference IDRead Only:trueThe unique identifier of the current reference record. -
RelationTypeCd: string
Title:
Relation TypeMaximum Length:30The relationship type between the service request and the referenced object. -
ResolutionCd: string
Title:
Resolution CodeMaximum Length:30Indicates whether the referenced object helps in resolving the service request. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request IDThe unique identifier of the service request. -
SrNumber: string
Title:
Service Request NumberMaximum Length:30The alternative key for the service request number. -
Subject: string
Title:
TitleMaximum Length:1000The title of the referenced object. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the user has access to update the record
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : internalServiceRequests-srTags-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Tag: string
Maximum Length:
64The value of the tag associated with a service request. -
TagId: integer
(int64)
Title:
Tag IDThe unique identifier of the tag. -
TagRefId: integer
(int64)
Title:
Tag Reference IDRead Only:trueThe unique identifier of the tag associated with a service request.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- copyAttachmentsToMessage
-
Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/action/copyAttachmentsToMessageThis method lets you copy service request attachments to messages.
- copySRAttachments
-
Create an attachment for an internal service request from an existing set of attachments
- runQueueAssignment
-
This method lets you assign service requests to the appropriate queues.