Create a child interaction and interaction reference
post
/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions
Request
Path Parameters
-
InteractionId(required): integer(int64)
The unique identifier of the interaction.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account associated with the interaction. -
AgentHTTPSessionId: string
Title:
Session ID
Maximum Length:100
The unique identifier for the http session. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the interaction channel. -
ChannelTypeCd: string
Title:
Channel Type
Maximum Length:30
The code indicating the type of the interaction channel. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact associated with the interaction. -
Description: string
Title:
Description
Maximum Length:1000
The description of the child interaction. -
DirectionCd: string
Title:
Direction
Maximum Length:30
Default Value:ORA_SVC_INBOUND
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. -
EndInteractionFlag: boolean
Title:
End Interaction
This 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 Time
The time when the interaction ended. -
InteractionNumber: string
Title:
Interaction Number
Maximum Length:30
The alternate key identifier for the interaction. -
ManuallyLoggedFlag: boolean
Maximum Length:
1
Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N. -
MarketingReferenceId: integer
(int64)
Title:
Marketing Reference ID
A unique identifier used to store a reference to a marketing system deployment number. -
MediaItemId: string
Title:
Media Item ID
Maximum Length:255
The unique identifier for the media item. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The system reference used by the interaction. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
The unique identifier of the owner of the interaction. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction ID
The unique identifier of the parent interaction. -
Payload: string
(byte)
Title:
Payload
The payload associated with the interaction. -
QueueId: integer
(int64)
Title:
Queue ID
The unique identifier of the interaction queue. -
QueueNumber: string
Title:
Queue Number
Maximum Length:30
The alternate key identifier for the queue. -
SourceCd: string
Title:
Source CD
Maximum Length:30
A unique identifier used to store a source code reference within the child interaction object. -
StartInteractionFlag: boolean
Title:
Start Interaction
Default Value:true
Indicates if the interaction should be started if it hasn???t already been started. The default value is True. -
StartTime: string
(date-time)
Title:
Start Time
The time when the interaction started. -
StatusCd: string
Title:
Status
Maximum Length:30
Default Value:ORA_SVC_OPEN
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
Title:
Stripe Code
Maximum Length:30
The 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 Code
Maximum Length:30
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : interactions-childInteractions-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account associated with the interaction. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The alternate key for the account identifier. -
AccountPartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The unique account name of the account associated with the interaction. -
AgentHTTPSessionId: string
Title:
Session ID
Maximum Length:100
The unique identifier for the http session. -
ChannelDisplayName: string
Title:
Channel Display Name
Read Only:true
Maximum Length:400
The name of the interaction channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the interaction channel. -
ChannelShortName: string
Title:
Channel Code
Read Only:true
Maximum Length:450
The interaction channel short name. -
ChannelTypeCd: string
Title:
Channel Type
Maximum Length:30
The code indicating the type of the interaction channel. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact associated with the interaction. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The alternate key identifier for the contact party. -
ContactPartyUniqueName: string
Title:
Contact
Read Only:true
Maximum Length:900
The unique contact name of the contact associated with the interaction. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the interaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the interaction was created. -
DeleteFlag: boolean
Read Only:
true
Indicates if the interaction can be deleted by the current user. The default value is false. -
Description: string
Title:
Description
Maximum Length:1000
The description of the child interaction. -
DirectionCd: string
Title:
Direction
Maximum Length:30
Default Value:ORA_SVC_INBOUND
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. -
EndInteractionFlag: boolean
Title:
End Interaction
This 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 Time
The time when the interaction ended. -
InteractionId: integer
(int64)
Title:
Interaction ID
Read Only:true
The unique identifier of the interaction. -
InteractionNumber: string
Title:
Interaction Number
Maximum Length:30
The alternate key identifier for the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the interaction was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the interaction. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the interaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManuallyLoggedFlag: boolean
Maximum Length:
1
Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N. -
MarketingReferenceId: integer
(int64)
Title:
Marketing Reference ID
A unique identifier used to store a reference to a marketing system deployment number. -
MediaItemId: string
Title:
Media Item ID
Maximum Length:255
The unique identifier for the media item. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The system reference used by the interaction. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
The unique identifier of the owner of the interaction. -
OwnerResourcePartyNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
The alternate key identifier of the owner of the interaction. -
OwnerResourcePartyUniqueName: string
Title:
Resource Name
Read Only:true
Maximum Length:900
The unique name of the owner of the interaction. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction ID
The unique identifier of the parent interaction. -
ParentInteractionNumber: string
Title:
Interaction Number
Read Only:true
Maximum Length:30
The alternate key identifier of the parent interaction. -
Payload: string
(byte)
Title:
Payload
The payload associated with the interaction. -
QueueId: integer
(int64)
Title:
Queue ID
The unique identifier of the interaction queue. -
QueueName: string
Title:
Queue Name
Read Only:true
Maximum Length:400
The name of the interaction queue. -
QueueNumber: string
Title:
Queue Number
Maximum Length:30
The alternate key identifier for the queue. -
SourceCd: string
Title:
Source CD
Maximum Length:30
A unique identifier used to store a source code reference within the child interaction object. -
StartInteractionFlag: boolean
Title:
Start Interaction
Default Value:true
Indicates if the interaction should be started if it hasn???t already been started. The default value is True. -
StartTime: string
(date-time)
Title:
Start Time
The time when the interaction started. -
StatusCd: string
Title:
Status
Maximum Length:30
Default Value:ORA_SVC_OPEN
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
Title:
Stripe Code
Maximum Length:30
The 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 Code
Maximum Length:30
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
Title:
Top Level
Read Only:true
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. -
UpdateFlag: boolean
Read Only:
true
Indicates 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ChannelIdByChannelType
-
Operation: /crmRestApi/resources/11.13.18.05/channelsParameters:
- finder:
DefaultChannelByTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}
The list of values indicating the channel type.
The following properties are defined on the LOV link relation:- Source Attribute: ChannelTypeCd; Target Attribute: ChannelTypeCd
- Display Attribute: ChannelTypeCd
- finder:
- DirectionCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_DIRECTION_CD
The list of values indicating the interaction direction.
The following properties are defined on the LOV link relation:- Source Attribute: DirectionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_INTERACT_SOURCE_CD
The list of values indicating the child interaction source.
The following properties are defined on the LOV link relation:- Source Attribute: SourceCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_STATUS_CD
The list of values indicating the interaction status.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StripeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
The list of values indicating the interaction stripe.
The following properties are defined on the LOV link relation:- Source Attribute: StripeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SubStatusCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_CLOSED_SUBSTATUS_CD
The list of values indicating the interaction substatus.
The following properties are defined on the LOV link relation:- Source Attribute: SubstatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: ManuallyLoggedFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to create a child interaction by submitting a POST request on the REST resource.
Request Header Example
The following shows an example of the request header.
POST /crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions
Response Header Example
The following shows an example of the response header.
HTTP/1.1 200 Created Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Request Body Example
The following shows an example of the request body in JSON format.
{ "ChannelTypeCd" : "ORA_SVC_SOCIAL" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "InteractionId" : 300100097737929, "ParentInteractionId" : 300100096307925, "TopLevelFlag" : "false", "Description" : null, "ChannelId" : 100100052667990, "ChannelDisplayName" : "Social (Seeded)", "ChannelTypeCd" : "ORA_SVC_SOCIAL", "AccountPartyId" : null, "AccountPartyUniqueName" : null, "ContactPartyId" : null, "ContactPartyUniqueName" : null, "QueueId" : null, "QueueName" : null, "OwnerResourceId" : null, "OwnerResourcePartyUniqueName" : null, "StartTime" : "2017-03-06T01:15:09-08:00", "EndTime" : null, "StatusCd" : "ORA_SVC_OPEN", "OriginalSystemReference" : null, "CreatedBy" : "SALES_ADMIN", "CreationDate" : "2017-03-06T01:15:09-08:00", "LastUpdatedBy" : "SALES_ADMIN", "LastUpdateDate" : "2017-03-06T01:15:09-08:00", "LastUpdateLogin" : "4A0BD041F81345D7E05307B3F20ACD5E", "DirectionCd" : "ORA_SVC_INBOUND", "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/child/childInteractions/300100097737929", "name" : "childInteractions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929", "name" : "childInteractions", "kind" : "item" }, { "rel" : "parent", "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/child/childInteractions/300100097737929/lov/DirectionCdLookup", "name" : "DirectionCdLookup", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/StatusCdLookup", "name" : "StatusCdLookup", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/ChannelIdByChannelType", "name" : "ChannelIdByChannelType", "kind" : "collection" }, { "rel" : "enclosure", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/enclosure/Payload", "name" : "Payload", "kind" : "other" } ] }