Get all interactions
get
/crmRestApi/resources/11.13.18.05/interactions
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:- InteractionRowFinderById: Finds an interactions with the interaction identifier.
Finder Variables:- BindInteractionId; integer; The unique interaction identifier.
- BindStripeCd; string; The interactions stripe code.
- InteractionRowFinderByMediaItemId: Finds an interaction by the media item identifier
Finder Variables:- BindMediaItemId; string; The media item identifier of the interaction.
- InteractionRowFinderByObject: Finds interactions associated with an object.
Finder Variables:- ObjectId; integer; The unique identifier of the object.
- ObjectTypeCd; string; The code indicating the type of the object.
- InteractionRowFinderByOwnerCustomerTime: Finds interactions by Owner Identifier, Customer Identifier and Time.
Finder Variables:- BindAccountPartyId; integer.
- BindContactPartyId; integer.
- BindCreationDate; string.
- BindInteractionId; integer.
- BindLastUpdateDate; string.
- BindOwnerResourceId; integer.
- BindStatusCd; string.
- InteractionRowFinderByOwnerCustomerTimeObject: Finds child interactions with the specified primary key, such as Owner Identifier, Customer Identifier, Time and Object
Finder Variables:- BindAccountPartyId; integer.
- BindContactPartyId; integer.
- BindCreationDate; string.
- BindInteractionId; integer.
- BindLastUpdateDate; string.
- BindOwnerResourceId; integer.
- BindStatusCd; string.
- ObjectId; integer.
- ObjectTypeCd; string.
- OpenChildInteractionRowFinderByChannelCustomerOwner: Finds interactions by Channel and Customers.
Finder Variables:- BindAccountPartyId; integer; The unique identifier of the account associated with the interaction.
- BindChannelId; integer; The unique identifier of the interaction channel.
- BindContactPartyId; integer; The unique identifier of the contact associated with the interaction.
- BindOwnerResourceId; integer; The unique identifier of the owner of the interaction.
- BindParentInteractionId; integer; The unique identifier of the parent interaction.
- PrimaryKey: Finds an interaction with the specified primary key.
Finder Variables:- InteractionId; integer; The unique identifier of the interaction.
- InteractionRowFinderById: Finds an interactions with the interaction identifier.
-
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:- APPClassificationCd; string; Application classification of the interaction such as sales, service, human resources, help desk, and so on.
- APPInterfaceTypeCd; string; Application interface used for interaction creation such as Redwood and ADF.
- AccountPartyId; integer; The unique identifier of the account associated with the interaction.
- AccountPartyNumber; string; The alternate key for the account identifier.
- AccountPartyUniqueName; string; The unique account name of the account associated with the interaction.
- AgentHTTPSessionId; string; The unique identifier for the http session.
- ChannelDisplayName; string; The name of the interaction channel.
- ChannelId; integer; The unique identifier of the interaction channel.
- ChannelShortName; string; The interaction channel short name.
- ChannelTypeCd; string; The code indicating the type of the interaction channel.
- ContactPartyId; integer; The unique identifier of the contact associated with the interaction.
- ContactPartyNumber; string; The alternate key identifier for the contact party.
- ContactPartyUniqueName; string; The unique contact name of the contact associated with the interaction.
- ContactPersonId; integer; The unique identifier of the contact person.
- CreatedBy; string; The user who created the interaction.
- CreationDate; string; The date and time when the interaction was created.
- Description; string; The description of the child interaction.
- DirectionCd; string; The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.
- EndTime; string; The time when the interaction ended.
- InteractionId; integer; The unique identifier of the interaction.
- InteractionNumber; string; The alternate key identifier for the interaction.
- LastUpdateDate; string; The date when the interaction was last updated.
- LastUpdateLogin; string; The session login of the user who last updated the interaction.
- LastUpdatedBy; string; The user who last updated the interaction.
- ManuallyLoggedFlag; boolean; Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.
- MarketingReferenceId; integer; A unique identifier used to store a reference to a marketing system deployment number.
- MediaItemId; string; The unique identifier for the media item.
- OriginalSystemReference; string; The system reference used by the interaction.
- OwnerResourceId; integer; The unique identifier of the owner of the interaction.
- OwnerResourcePartyNumber; string; The alternate key identifier of the owner of the interaction.
- OwnerResourcePartyUniqueName; string; The unique name of the owner of the interaction.
- ParentInteractionId; integer; The unique identifier of the parent interaction.
- ParentInteractionNumber; string; The alternate key identifier of the parent interaction.
- PartnerAccountPartyId; integer; Unique identifier for the child interaction of the partner account.
- QueueId; integer; The unique identifier of the interaction queue.
- QueueName; string; The name of the interaction queue.
- QueueNumber; string; The alternate key identifier for the queue.
- SourceCd; string; A unique identifier used to store a source code reference within the child interaction object.
- SourceCdMeaning; string; Indicates the display value corresponding to the source code lookup for the interaction.
- StartTime; string; The time when the interaction started.
- StatusCd; string; The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.
- StripeCd; string; The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.
- SubstatusCd; string; The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.
- TopLevelFlag; boolean; Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.
-
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 : interactions
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 : interactions-item-response
Type:
Show Source
object-
AccountPartyId: integer
(int64)
Title:
Account IDThe unique identifier of the account associated with the interaction. -
AccountPartyNumber: string
Title:
Account NumberRead Only:trueMaximum Length:30The alternate key for the account identifier. -
AccountPartyUniqueName: string
Title:
AccountRead Only:trueMaximum Length:900The unique account name of the account associated with the interaction. -
AgentHTTPSessionId: string
Title:
Session IDMaximum Length:100The unique identifier for the http session. -
APPClassificationCd: string
Title:
Application Classification CodeMaximum Length:30Application classification of the interaction such as sales, service, human resources, help desk, and so on. -
APPInterfaceTypeCd: string
Title:
Application Interface Type CodeMaximum Length:30Application interface used for interaction creation such as Redwood and ADF. -
ChannelDisplayName: string
Title:
Channel Display NameRead Only:trueMaximum Length:400The name of the interaction channel. -
ChannelId: integer
(int64)
Title:
Channel IDThe unique identifier of the interaction channel. -
ChannelShortName: string
Title:
Channel CodeRead Only:trueMaximum Length:450The interaction channel short name. -
ChannelTypeCd: string
Title:
Channel TypeMaximum Length:30The code indicating the type of the interaction channel. -
childInteractions: array
Child Interactions
Title:
Child InteractionsThe child interaction resource is used to view, create, and update all the child interactions associated with the current interaction. -
ContactPartyId: integer
(int64)
Title:
Contact IDThe unique identifier of the contact associated with the interaction. -
ContactPartyNumber: string
Title:
Contact NumberRead Only:trueMaximum Length:30The alternate key identifier for the contact party. -
ContactPartyUniqueName: string
Title:
ContactRead Only:trueMaximum Length:900The unique contact name of the contact associated with the interaction. -
ContactPersonId: integer
(int64)
Title:
Contact Person IDThe unique identifier of the contact person. -
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
Read Only:
trueIndicates if the interaction can be deleted by the current user. The default value is false. -
Description: string
Title:
DescriptionMaximum Length:1000The description of the child interaction. -
DirectionCd: string
Title:
DirectionMaximum Length:30Default Value:ORA_SVC_INBOUNDThe code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions. -
EndInteractionFlag: boolean
Title:
End InteractionThis will set the Endtime attribute ( to the current time) without changing the interaction status to closed. The default value is false. -
EndTime: string
(date-time)
Title:
End TimeThe time when the interaction ended. -
InteractionData: array
Interaction Data
Title:
Interaction DataThe interaction data is used to add contextual data for an interaction. -
InteractionId: integer
(int64)
Title:
Interaction IDRead Only:trueThe unique identifier of the interaction. -
InteractionNumber: string
Title:
Interaction NumberMaximum Length:30The alternate key identifier for the interaction. -
InteractionParticipants: array
Interaction Participants
Title:
Interaction ParticipantsThe interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference. -
interactionReferences: array
Interaction References
Title:
Interaction ReferencesThe interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS). -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date 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 session login of the user who last updated the interaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManuallyLoggedFlag: boolean
Maximum Length:
1Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N. -
MarketingReferenceId: integer
(int64)
Title:
Marketing Reference IDA unique identifier used to store a reference to a marketing system deployment number. -
MediaItemId: string
Title:
Media Item IDMaximum Length:255The unique identifier for the media item. -
OriginalSystemReference: string
Title:
Original SystemMaximum Length:255The system reference used by the interaction. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource IDThe unique identifier of the owner of the interaction. -
OwnerResourcePartyNumber: string
Title:
Resource NumberRead Only:trueMaximum Length:30The alternate key identifier of the owner of the interaction. -
OwnerResourcePartyUniqueName: string
Title:
Resource NameRead Only:trueMaximum Length:900The unique name of the owner of the interaction. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction IDThe unique identifier of the parent interaction. -
ParentInteractionNumber: string
Title:
Interaction NumberRead Only:trueMaximum Length:30The alternate key identifier of the parent interaction. -
PartnerAccountPartyId: integer
(int64)
Title:
Partner Account Party IdUnique identifier for the child interaction of the partner account. -
Payload: string
(byte)
Title:
PayloadThe payload associated with the interaction. -
QueueId: integer
(int64)
Title:
Queue IDThe unique identifier of the interaction queue. -
QueueName: string
Title:
Queue NameRead Only:trueMaximum Length:400The name of the interaction queue. -
QueueNumber: string
Title:
Queue NumberMaximum Length:30The alternate key identifier for the queue. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
SourceCd: string
Title:
Source CDMaximum Length:30A unique identifier used to store a source code reference within the child interaction object. -
SourceCdMeaning: string
Title:
Source Code MeaningRead Only:trueMaximum Length:255Indicates the display value corresponding to the source code lookup for the interaction. -
StartInteractionFlag: boolean
Title:
Start InteractionDefault Value:trueIndicates if the interaction should be started if it hasn???t already been started. The default value is True. -
StartTime: string
(date-time)
Title:
Start TimeThe time when the interaction started. -
StatusCd: string
Title:
StatusMaximum Length:30Default Value:ORA_SVC_OPENThe code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD. -
StripeCd: string
Title:
Stripe CodeMaximum Length:30The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD. -
SubstatusCd: string
Title:
Substatus CodeMaximum Length:30The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD. -
TopLevelFlag: boolean
Title:
Top LevelRead Only:trueIndicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier. -
UpdateFlag: boolean
Read Only:
trueIndicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.
Nested Schema : Child Interactions
Type:
arrayTitle:
Child InteractionsThe child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
Show Source
Nested Schema : Interaction Data
Type:
arrayTitle:
Interaction DataThe interaction data is used to add contextual data for an interaction.
Show Source
Nested Schema : Interaction Participants
Type:
arrayTitle:
Interaction ParticipantsThe interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.
Show Source
Nested Schema : Interaction References
Type:
arrayTitle:
Interaction ReferencesThe interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
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 : interactions-childInteractions-item-response
Type:
Show Source
object-
AccountPartyId: integer
(int64)
Title:
Account IDThe unique identifier of the account associated with the interaction. -
AccountPartyNumber: string
Title:
Account NumberRead Only:trueMaximum Length:30The alternate key for the account identifier. -
AccountPartyUniqueName: string
Title:
AccountRead Only:trueMaximum Length:900The unique account name of the account associated with the interaction. -
AgentHTTPSessionId: string
Title:
Session IDMaximum Length:100The unique identifier for the http session. -
APPClassificationCd: string
Title:
Application Classification CodeMaximum Length:30Application classification of the interaction such as sales, service, human resources, help desk, and so on. -
APPInterfaceTypeCd: string
Title:
Application Interface Type CodeMaximum Length:30Application interface used for interaction creation such as Redwood and ADF. -
ChannelDisplayName: string
Title:
Channel Display NameRead Only:trueMaximum Length:400The name of the interaction channel. -
ChannelId: integer
(int64)
Title:
Channel IDThe unique identifier of the interaction channel. -
ChannelShortName: string
Title:
Channel CodeRead Only:trueMaximum Length:450The interaction channel short name. -
ChannelTypeCd: string
Title:
Channel TypeMaximum Length:30The code indicating the type of the interaction channel. -
ContactPartyId: integer
(int64)
Title:
Contact IDThe unique identifier of the contact associated with the interaction. -
ContactPartyNumber: string
Title:
Contact NumberRead Only:trueMaximum Length:30The alternate key identifier for the contact party. -
ContactPartyUniqueName: string
Title:
ContactRead Only:trueMaximum Length:900The unique contact name of the contact associated with the interaction. -
ContactPersonId: integer
(int64)
Title:
Contact Person IDThe unique identifier of the contact person. -
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
Read Only:
trueIndicates if the interaction can be deleted by the current user. The default value is false. -
Description: string
Title:
DescriptionMaximum Length:1000The description of the child interaction. -
DirectionCd: string
Title:
DirectionMaximum Length:30Default Value:ORA_SVC_INBOUNDThe code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions. -
EndInteractionFlag: boolean
Title:
End InteractionThis will set the Endtime attribute ( to the current time) without changing the interaction status to closed. The default value is false. -
EndTime: string
(date-time)
Title:
End TimeThe time when the interaction ended. -
InteractionId: integer
(int64)
Title:
Interaction IDRead Only:trueThe unique identifier of the interaction. -
InteractionNumber: string
Title:
Interaction NumberMaximum Length:30The alternate key identifier for the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date 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 session login of the user who last updated the interaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManuallyLoggedFlag: boolean
Maximum Length:
1Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N. -
MarketingReferenceId: integer
(int64)
Title:
Marketing Reference IDA unique identifier used to store a reference to a marketing system deployment number. -
MediaItemId: string
Title:
Media Item IDMaximum Length:255The unique identifier for the media item. -
OriginalSystemReference: string
Title:
Original SystemMaximum Length:255The system reference used by the interaction. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource IDThe unique identifier of the owner of the interaction. -
OwnerResourcePartyNumber: string
Title:
Resource NumberRead Only:trueMaximum Length:30The alternate key identifier of the owner of the interaction. -
OwnerResourcePartyUniqueName: string
Title:
Resource NameRead Only:trueMaximum Length:900The unique name of the owner of the interaction. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction IDThe unique identifier of the parent interaction. -
ParentInteractionNumber: string
Title:
Interaction NumberRead Only:trueMaximum Length:30The alternate key identifier of the parent interaction. -
PartnerAccountPartyId: integer
(int64)
Title:
Partner Account Party IdUnique identifier for the child interaction of the partner account. -
Payload: string
(byte)
Title:
PayloadThe payload associated with the interaction. -
QueueId: integer
(int64)
Title:
Queue IDThe unique identifier of the interaction queue. -
QueueName: string
Title:
Queue NameRead Only:trueMaximum Length:400The name of the interaction queue. -
QueueNumber: string
Title:
Queue NumberMaximum Length:30The alternate key identifier for the queue. -
SourceCd: string
Title:
Source CDMaximum Length:30A unique identifier used to store a source code reference within the child interaction object. -
SourceCdMeaning: string
Title:
Source Code MeaningRead Only:trueMaximum Length:255Indicates the display value corresponding to the source code lookup for the interaction. -
StartInteractionFlag: boolean
Title:
Start InteractionDefault Value:trueIndicates if the interaction should be started if it hasn???t already been started. The default value is True. -
StartTime: string
(date-time)
Title:
Start TimeThe time when the interaction started. -
StatusCd: string
Title:
StatusMaximum Length:30Default Value:ORA_SVC_OPENThe code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD. -
StripeCd: string
Title:
Stripe CodeMaximum Length:30The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD. -
SubstatusCd: string
Title:
Substatus CodeMaximum Length:30The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD. -
TopLevelFlag: boolean
Title:
Top LevelRead Only:trueIndicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier. -
UpdateFlag: boolean
Read Only:
trueIndicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.
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 : interactions-InteractionData-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByMaximum Length:64The user who created the interaction data. -
CreationDate: string
(date-time)
Title:
Creation DateThe date when the interaction data was created. -
DeletedFlag: boolean
Title:
Deleted FlagMaximum Length:1Indicates whether the interaction data was deleted. -
InteractionDataId: integer
(int64)
Title:
Interaction Data IdThe unique identifier of the interaction data. -
InteractionDataNumber: string
Title:
Interaction Data NumberMaximum Length:30The alternate identifier of the interaction data. -
InteractionId: integer
(int64)
Title:
Interaction IdUnique identifier of interaction. -
InteractionNumber: string
Title:
Interaction NumberRead Only:trueMaximum Length:30The alternate unique identifier of the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateThe date when the interaction data was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByMaximum Length:64The user who last updated the interaction data. -
LastUpdateLogin: string
Title:
Last Update LoginMaximum Length:32The login of the user who last updated the interaction data. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TokenId: integer
(int64)
Title:
Token IdThe unique identifier of the token. -
Value: string
Title:
Data ValueMaximum Length:4000Value of the token.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : interactions-InteractionParticipants-item-response
Type:
Show Source
object-
ContactPartyId: integer
(int64)
Title:
Contact Party IDThe PartyId of the contact if the participant is a contact. -
ContactPartyNumber: string
Title:
Contact Party NumberRead Only:trueMaximum Length:30The party number of the contact if the participant was a contact. -
ContactPartyUniqueName: string
Title:
Contact Unique NameRead Only:trueMaximum Length:900The unique name of the contact if the participant was a contact. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who added the participant. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the participant was added. -
DurationMinutes: integer
(int32)
Title:
MinutesThe number of minutes the participant was on the conference. You can join, drop, and rejoin the conference. -
Email: string
Title:
EmailMaximum Length:128The email of the participant. -
EndTime: string
(date-time)
Title:
End TimeThe time when the participant left the interaction. -
InteractionId: integer
(int64)
Title:
Interaction IDThe interaction id of the interaction to which the participant belongs. -
InteractionNumber: string
Title:
Interaction NumberRead Only:trueMaximum Length:30 -
InteractionParticipantId: integer
(int64)
Title:
Participant IDRead Only:trueThe auto-generated number and primary key for this participant. -
InteractionParticipantNumber: string
Title:
Participant NumberMaximum Length:30The public unique identifier for the Interaction Participant. -
Json: string
(byte)
Title:
JSONThe JSON String used for customization. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the participant was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the participant. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The system login reference of the last user to update the participant. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version NumberThe version of the participant record. -
OriginalSystemReference: string
Title:
Original System ReferenceMaximum Length:255Specifies the original system reference if record was imported. -
ParticipantName: string
Title:
NameMaximum Length:128The name from the web conference. Does not necessarily tie to Fusion data. -
ParticipantTypeCd: string
Title:
Participant Type CodeMaximum Length:30The type of participant. The value is sourced from the lookup ORA_SVC_PARTICIPANT_TYPE_CD. -
Phone: string
Title:
PhoneMaximum Length:128The phone number of the participant. -
ResourcePartyId: integer
(int64)
Title:
Resource Party IDThe party Id of the resource if the participant is a resource. -
ResourcePartyNumber: string
Title:
Resource Party NumberRead Only:trueMaximum Length:30The party number of the resource if the participant was a resource. -
ResourcePartyUniqueName: string
Title:
Resource Unique NameRead Only:trueMaximum Length:900The unique name of the resource if the participant was a resource. -
StartTime: string
(date-time)
Title:
Start TimeThe time when the participant joined the interaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : interactions-interactionReferences-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the reference. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the reference was created. -
DeleteFlag: boolean
Read Only:
trueIndicates if the interaction reference can be deleted by the current user. The default value is false. -
InteractionId: integer
(int64)
Title:
Interaction IDThe unique identifier of the interaction reference. -
InteractionNumber: string
Title:
Interaction NumberMaximum Length:30The alternate key identifier for the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the reference was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the reference. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The session login of the user who last updated the reference. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object IDThe unique identifier of the object associated with the interaction reference. -
ObjectNumber: string
Title:
Reference NumberRead Only:trueMaximum Length:255The alternate key identifier of the object associated with the interaction reference. -
ObjectTypeCd: string
Title:
Object TypeMaximum Length:30The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD. -
ReferenceId: integer
(int64)
Title:
Reference IDRead Only:trueThe unique identifier used for integration with external systems. -
UpdateFlag: boolean
Read Only:
trueIndicates if the interaction reference can be updated by the current user. The default value is true if the user has access to update the interaction reference.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : interactions-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 : interactions-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 : interactions-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
Examples
The following example shows how to get all interactions by submitting a GET request on the REST resource.
Request Header Example
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/interactions
Response Header Example
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Fri, 03 Mar 2017 07:54:53 GMT Server : Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourcecollection+json Content-Language: en
Response Body Example
The following shows an example of the response body in JSON format.
{
"items": [
{
"InteractionId": 300100096307925,
"ParentInteractionId": 300100096307925,
"TopLevelFlag": "true",
"Description": "Sent SrMessage 300100096307628",
"ChannelId": 300100092273686,
"ChannelDisplayName": "ditdevacisvcfib_qa.extservice.incoming",
"ChannelTypeCd": "ORA_SVC_EMAIL",
"AccountPartyId": null,
"AccountPartyUniqueName": null,
"ContactPartyId": null,
"ContactPartyUniqueName": null,
"QueueId": null,
"QueueName": null,
"OwnerResourceId": null,
"OwnerResourcePartyUniqueName": null,
"StartTime": "2017-02-20T04:09:17-08:00",
"EndTime": "2017-02-20T04:09:17-08:00",
"StatusCd": "ORA_SVC_CLOSED",
"OriginalSystemReference": null,
"CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
"CreationDate": "2017-02-20T04:09:17-08:00",
"LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
"LastUpdateDate": "2017-02-20T04:09:17-08:00",
"LastUpdateLogin": "48F584F941357435E05307B3F20AB8E8",
"DirectionCd": "ORA_SVC_OUTBOUND",
"StripeCd": "ORA_SVC_CRM",
"MediaItemId": null,
"SubstatusCd": null,
"NotifyFlag": null,
"UpdateFlag": "true",
"DeleteFlag": "true",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
"name": "interactions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
"name": "interactions",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/DirectionCdLookup",
"name": "DirectionCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/StatusCdLookup",
"name": "StatusCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/ChannelIdByChannelType",
"name": "ChannelIdByChannelType",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions",
"name": "childInteractions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences",
"name": "interactionReferences",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/enclosure/Payload",
"name": "Payload",
"kind": "other"
}
]
}
...
}