Update a wrap up
patch
/crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}
Request
Path Parameters
-
SummaryId(required): integer(int64)
The unique identifier of the wrap up. This value is generated during creation.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CallNotes: string
(byte)
Title:
Call Notes
The call notes is used to store large content related to the call. -
CommReasonCd: string
Title:
Communication Reason Code
Maximum Length:30
The code indicating the reason for the occurrence of the interaction. A list of accepted values is defined in the lookup ORA_SVC_MCA_COMM_REASON_CD. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction. A wrap up is a child resource of the interaction. -
InteractionNotes: string
Title:
Interaction Notes
Maximum Length:4000
The notes associated with the interaction. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
The code indicating the resolution code of the interaction. A list of accepted values is defined in the lookup ORA_SVC_MCA_RESOLUTION_CODE. -
SrMessageId: integer
(int64)
Title:
Message ID
The unique identifier of the service request message. -
TransferReason: string
Title:
Transfer Reason
Maximum Length:400
The reason the interaction was transferred to another user. This is optional and typically provided only for a transferred interaction. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:1
Indicates if the associated contact has been verified. -
WrapupEndTime: string
(date-time)
Title:
Wrap Up End Time
The date and time when the wrap up ends. -
WrapupStartTime: string
(date-time)
Title:
Wrap Up Start Time
The date and time when the wrap up begins.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
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 : wrapUps-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the account associated with the interaction. -
AccountPartyNumber: string
Title:
Party Account Number
Read Only:true
Maximum Length:30
The public unique identifier for the account. -
AccountPartyUniqueName: string
Title:
Account Unique Name
Read Only:true
Maximum Length:900
The unique account name of the account associated with the interaction. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CallNotes: string
(byte)
Title:
Call Notes
The call notes is used to store large content related to the call. -
ChannelDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:400
The name displayed for this channel instance. -
ChannelId: integer
(int64)
Title:
Channel ID
Read Only:true
The unique identifier of the channel associated with the interaction. -
ChannelTypeCd: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The code indicating the type of the interaction channel. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ChannelTypeCdMeaning: string
Read Only:
true
The description of the channel type code. -
CommReasonCd: string
Title:
Communication Reason Code
Maximum Length:30
The code indicating the reason for the occurrence of the interaction. A list of accepted values is defined in the lookup ORA_SVC_MCA_COMM_REASON_CD. -
CommReasonCdMeaning: string
Read Only:
true
The description of the direction code. -
ContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the contact associated with the interaction. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The party name of the interaction contact. -
ContactPartyNumber: string
Title:
Party Contact Number
Read Only:true
Maximum Length:30
The unique identifier of the contact associated with the interaction. -
ContactPartyUniqueName: string
Title:
Contact Unique Name
Read Only:true
Maximum Length:900
The public unique identifier for the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the wrap up. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Read Only:
true
Indicates if the wrap up has been marked as deleted. The default value is true. -
DirectionCd: string
Title:
Direction
Read Only:true
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. -
InteractDirectionCdMeaning: string
Read Only:
true
The description of the interaction direction code. -
InteractionDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the interaction. -
InteractionEndTime: string
(date-time)
Title:
End Time
Read Only:true
The time when the interaction ended. -
InteractionFKId: integer
(int64)
Title:
Interaction ID
Read Only:true
The unique identifier of the interaction. The wrap up is a child resource of the interaction. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction. A wrap up is a child resource of the interaction. -
InteractionNotes: string
Title:
Interaction Notes
Maximum Length:4000
The notes associated with the interaction. -
InteractionNumber: string
Title:
Interaction Number
Maximum Length:30
The alternate identifier of the interaction. -
InteractionStartTime: string
(date-time)
Title:
Start Time
Read Only:true
The time when the interaction started. -
InteractionStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_OPEN
The predefined code used to indicate the status of the interaction. A list of accepted values is defined in the lookup ORA_SVC_IM_STATUS_CD. -
InteractionSubstatusCd: string
Title:
Substatus Code
Read Only:true
Maximum Length:30
The code indicates the substatus of the interaction. A list of accepted values is defined in ORA_SVC_IM_CLOSED_SUBSTATUS_CD . -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the wrap up was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the wrap up. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the wrap up. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MediaItemId: string
Title:
Media Item ID
Read Only:true
Maximum Length:255
The Event ID generated during interaction routed through third party tools. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
Read Only:true
The unique identifier of the owner for the interaction. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
The code indicating the resolution code of the interaction. A list of accepted values is defined in the lookup ORA_SVC_MCA_RESOLUTION_CODE. -
ResolutionCdMeaning: string
Read Only:
true
The description of the resolution code. -
ResourcePartyName: string
Title:
Resource Name
Read Only:true
Maximum Length:360
The party name of the owner resource. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The public unique identifier for the owner resource. -
ResourcePartyUniqueName: string
Title:
Resource Unique Name
Read Only:true
Maximum Length:900
A uniquely identified name for the owner resource. -
SrMessageId: integer
(int64)
Title:
Message ID
The unique identifier of the service request message. -
SummaryId: integer
(int64)
Title:
Summary ID
Read Only:true
The unique identifier of the wrap up. This value is generated during creation. -
SummaryNumber: string
Title:
Summary Number
Maximum Length:30
The summary number of the interaction. -
TransferReason: string
Title:
Transfer Reason
Maximum Length:400
The reason the interaction was transferred to another user. This is optional and typically provided only for a transferred interaction. -
UpdateFlag: boolean
Read Only:
true
Indicates if the wrap up has been updated. The default value is true. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:1
Indicates if the associated contact has been verified. -
WrapupEndTime: string
(date-time)
Title:
Wrap Up End Time
The date and time when the wrap up ends. -
WrapupStartTime: string
(date-time)
Title:
Wrap Up Start Time
The date and time when the wrap up begins.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : wrapUps-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : 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
- Attachments
-
Parameters:
- SummaryId:
$request.path.SummaryId
The attachments resource is used to view, create, and update attachments. - SummaryId:
- CommReasonLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_COMM_REASON_CD
The list of values indicating the reason for the interaction.
The following properties are defined on the LOV link relation:- Source Attribute: CommReasonCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- InteractionStatusCdLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_STATUS_CD
The list of values indicating the status of the interaction.
The following properties are defined on the LOV link relation:- Source Attribute: InteractionStatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- InteractionSubstatusCdLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_CLOSED_SUBSTATUS_CD
The list of values indicating the substatus of the interaction.
The following properties are defined on the LOV link relation:- Source Attribute: InteractionSubstatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResolutionCdLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_RESOLUTION_CD
The list of values indicating the resolution code of the interaction.
The following properties are defined on the LOV link relation:- Source Attribute: ResolutionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
Use PATCH with the following URI syntax to update a specific wrap up:
Example of Request URI
The following shows an example of the request header.
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192
Example of Request Header
The following shows an example of the request header.
PATCH /crmRestApi/resources/11.13.18.05/wrapUps/300100095286192 HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Request Body
The following shows an example of the request body in JSON format.
{ "CommReasonCd": "GENERAL_QUESTION", "InteractionId": 300100091808024, "InteractionNotes": "I like REST", "ResolutionCd": "ANSWERED_QUESTION" }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Mon, 16 Jan 2017 13:36:04 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following shows an example of the response body in JSON format.
Content type: { { "SummaryId": 300100095286192, "InteractionId": 300100091808024, "CommReasonCd": "GENERAL_QUESTION", "ResolutionCd": "ANSWERED_QUESTION", "TransferReason": null, "InteractionNotes": "I like REST", "InteractionDescription": null, "InteractionFKId": 300100091808024, "InteractionObjectVersionNumber": 4, "InteractionStatusCd": "ORA_SVC_CLOSED", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192", "name": "wrapUps", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192", "name": "wrapUps", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192/lov/ResolutionCdLov", "name": "ResolutionCdLov", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100095286192/lov/CommReasonLov", "name": "CommReasonLov", "kind": "collection" } ], } }