1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Interactions

Update an interaction

patch

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}

Request

Path Parameters
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Child Interactions
Type: array
Title: Child Interactions
The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
Show Source
Nested Schema : Interaction Participants
Type: array
Title: Interaction Participants
The 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: array
Title: Interaction References
The 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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : interactions-childInteractions-item-patch-request
Type: object
Show Source
Nested Schema : interactions-InteractionParticipants-item-patch-request
Type: object
Show Source
Nested Schema : interactions-interactionReferences-item-patch-request
Type: object
Show Source
  • Title: Object ID
    The unique identifier of the object associated with the interaction reference.
  • Title: Object Type
    Maximum Length: 30
    The 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.
Nested Schema : interactions-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : interactions-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : interactions-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : interactions-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : interactions-item-response
Type: object
Show Source
  • Title: Account ID
    The unique identifier of the account associated with the interaction.
  • Title: Account Number
    Read Only: true
    Maximum Length: 30
    The alternate key for the account identifier.
  • Title: Account
    Read Only: true
    Maximum Length: 900
    The unique account name of the account associated with the interaction.
  • Title: Session ID
    Maximum Length: 100
    The unique identifier for the http session.
  • Title: Channel Display Name
    Read Only: true
    Maximum Length: 400
    The name of the interaction channel.
  • Title: Channel ID
    The unique identifier of the interaction channel.
  • Title: Channel Code
    Read Only: true
    Maximum Length: 450
    The interaction channel short name.
  • Title: Channel Type
    Maximum Length: 30
    The code indicating the type of the interaction channel.
  • Child Interactions
    Title: Child Interactions
    The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
  • Title: Contact ID
    The unique identifier of the contact associated with the interaction.
  • Title: Contact Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier for the contact party.
  • Title: Contact
    Read Only: true
    Maximum Length: 900
    The unique contact name of the contact associated with the interaction.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the interaction.
  • Title: Creation Date
    Read Only: true
    The date and time when the interaction was created.
  • Read Only: true
    Indicates if the interaction can be deleted by the current user. The default value is false.
  • Title: Description
    Maximum Length: 1000
    The description of the child interaction.
  • 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.
  • 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.
  • Title: End Time
    The time when the interaction ended.
  • Title: Interaction ID
    Read Only: true
    The unique identifier of the interaction.
  • Title: Interaction Number
    Maximum Length: 30
    The alternate key identifier for the interaction.
  • Interaction Participants
    Title: Interaction Participants
    The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.
  • Interaction References
    Title: Interaction References
    The 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).
  • Title: Last Updated Date
    Read Only: true
    The date when the interaction was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the interaction.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the interaction.
  • Links
  • Maximum Length: 1
    Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.
  • Title: Marketing Reference ID
    A unique identifier used to store a reference to a marketing system deployment number.
  • Title: Media Item ID
    Maximum Length: 255
    The unique identifier for the media item.
  • Title: Original System
    Maximum Length: 255
    The system reference used by the interaction.
  • Title: Owner Resource ID
    The unique identifier of the owner of the interaction.
  • Title: Resource Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the owner of the interaction.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 900
    The unique name of the owner of the interaction.
  • Title: Parent Interaction ID
    The unique identifier of the parent interaction.
  • Title: Interaction Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the parent interaction.
  • Title: Payload
    The payload associated with the interaction.
  • Title: Queue ID
    The unique identifier of the interaction queue.
  • Title: Queue Name
    Read Only: true
    Maximum Length: 400
    The name of the interaction queue.
  • Title: Queue Number
    Maximum Length: 30
    The alternate key identifier for the queue.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Source CD
    Maximum Length: 30
    A unique identifier used to store a source code reference within the child interaction object.
  • 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.
  • Title: Start Time
    The time when the interaction started.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 : Child Interactions
Type: array
Title: Child Interactions
The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
Show Source
Nested Schema : Interaction Participants
Type: array
Title: Interaction Participants
The 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: array
Title: Interaction References
The 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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : interactions-childInteractions-item-response
Type: object
Show Source
Nested Schema : interactions-InteractionParticipants-item-response
Type: object
Show Source
Nested Schema : interactions-interactionReferences-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the reference.
  • Title: Creation Date
    Read Only: true
    The date and time when the reference was created.
  • Read Only: true
    Indicates if the interaction reference can be deleted by the current user. The default value is false.
  • Title: Interaction ID
    The unique identifier of the interaction reference.
  • Title: Interaction Number
    Maximum Length: 30
    The alternate key identifier for the interaction.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the reference was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the reference.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the reference.
  • Links
  • Title: Object ID
    The unique identifier of the object associated with the interaction reference.
  • Title: Reference Number
    Read Only: true
    Maximum Length: 255
    The alternate key identifier of the object associated with the interaction reference.
  • Title: Object Type
    Maximum Length: 30
    The 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.
  • Title: Reference ID
    Read Only: true
    The unique identifier used for integration with external systems.
  • Read Only: true
    Indicates 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 : interactions-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : interactions-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : interactions-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : interactions-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
ChannelIdByChannelType
Parameters:
  • 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
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
InteractionParticipants
Parameters:
  • InteractionId: $request.path.InteractionId
The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.
SourceCdLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_INTERACT_SOURCE_CD
The list of values indicating the interaction source.

The following properties are defined on the LOV link relation:
  • Source Attribute: SourceCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
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
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
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
YesNoLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating whether the interaction was manually created such as Y and N.

The following properties are defined on the LOV link relation:
  • Source Attribute: ManuallyLoggedFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
childInteractions
Parameters:
  • InteractionId: $request.path.InteractionId
The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
interactionReferences
Parameters:
  • InteractionId: $request.path.InteractionId
The 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).
smartActions
Parameters:
  • InteractionId: $request.path.InteractionId
This VO stores the endpoint and security details for every user action.
Back to Top

Examples

The following example shows how to update an interaction by submitting a PATCH request on the REST resource.

Request Header Example

The following shows an example of the request header.

PATCH /crmRestApi/resources/11.13.18.05/interactions/300100095824217

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 03 Mar 2017 12:17:00 GMT
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.

{
"Description": "Sent SrMessage again"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
  "InteractionId" : 300100095824217,
  "ParentInteractionId" : 300100095824217,
  "TopLevelFlag" : "true",
  "Description" : "Sent SrMessage again",
  "ChannelId" : 1,
  "ChannelDisplayName" : "Web (Seeded)",
  "ChannelTypeCd" : "ORA_SVC_WEB",
  "AccountPartyId" : null,
  "AccountPartyUniqueName" : null,
  "ContactPartyId" : null,
  "ContactPartyUniqueName" : null,
  "QueueId" : null,
  "QueueName" : null,
  "OwnerResourceId" : null,
  "OwnerResourcePartyUniqueName" : null,
  "StartTime" : "2017-03-03T04:01:13-08:00",
  "EndTime" : null,
  "StatusCd" : "ORA_SVC_OPEN",
  "OriginalSystemReference" : null,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-03-03T04:01:13-08:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateDate" : "2017-03-03T04:17:00-08:00",
  "LastUpdateLogin" : "49D1E72BFAA41BD9E0530E8EF50AC119",
  "DirectionCd" : "ORA_SVC_INBOUND",
  "StripeCd" : "ORA_SVC_CRM",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217",
    "name" : "interactions",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217",
    "name" : "interactions",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217/lov/DirectionCdLookup",
    "name" : "DirectionCdLookup",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217/lov/StatusCdLookup",
    "name" : "StatusCdLookup",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217/lov/ChannelIdByChannelType",
    "name" : "ChannelIdByChannelType",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217/child/childInteractions",
    "name" : "childInteractions",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217/child/interactionReferences",
    "name" : "interactionReferences",
    "kind" : "collection"
  }, {
    "rel" : "enclosure",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100095824217/enclosure/Payload",
    "name" : "Payload",
    "kind" : "other"
  } ]
}
Back to Top