Jump to

• Request
• Response
• Examples

Get a wrap up

get

/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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : wrapUps-item-response

Type: object

Show Source

• 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.
• AiGeneratedFlag: boolean
  Title: AI-Generated

  Maximum Length: 1

  Indicates if the wrap up notes were automatically generated by AI.
• 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.
• Problem: string
  Title: Problem

  Maximum Length: 4000

  The problem summary generated at interaction wrap up.
• 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.
• Solution: string
  Title: Solution

  Maximum Length: 4000

  The solution summary generated at interaction wrap up.
• 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.
• TimerExpiredFlag: boolean
  Title: Timer Expired

  Maximum Length: 1

  Indicates if the wrap up timer has expired.
• 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.
• WrapupSavedFlag: boolean
  Title: Wrap Up Saved

  Maximum Length: 1

  Indicates if the wrap up was saved.
• WrapupStartTime: string (date-time)
  Title: Wrap Up Start Time

  The date and time when the wrap up begins.

{
    "type":"object",
    "properties":{
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Party Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique account name of the account associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AiGeneratedFlag":{
            "title":"AI-Generated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the wrap up notes were automatically generated by AI.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/wrapUps-Attachments-item-response"
            }
        },
        "CallNotes":{
            "title":"Call Notes",
            "type":"string",
            "description":"The call notes is used to store large content related to the call.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The name displayed for this channel instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the interaction channel.  A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelTypeCdMeaning":{
            "type":"string",
            "description":"The description of the channel type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommReasonCd":{
            "title":"Communication Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CommReasonCdMeaning":{
            "type":"string",
            "description":"The description of the direction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the interaction contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Party Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the contact associated with the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyUniqueName":{
            "title":"Contact Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The public unique identifier for the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the wrap up.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the wrap up has been marked as deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_INBOUND",
            "x-queryable":true
        },
        "InteractDirectionCdMeaning":{
            "type":"string",
            "description":"The description of the interaction direction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionFKId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction. The wrap up is a child resource of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction. A wrap up is a child resource of the interaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InteractionNotes":{
            "title":"Interaction Notes",
            "maxLength":4000,
            "type":"string",
            "description":"The notes associated with the interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "InteractionStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the interaction started.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InteractionSubstatusCd":{
            "title":"Substatus Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicates the substatus of the interaction. A list of accepted values is defined in ORA_SVC_IM_CLOSED_SUBSTATUS_CD .",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the wrap up was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the wrap up.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the wrap up.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaItemId":{
            "title":"Media Item ID",
            "maxLength":255,
            "type":"string",
            "description":"The Event ID generated during interaction routed through third party tools.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the owner for the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Problem":{
            "title":"Problem",
            "maxLength":4000,
            "type":"string",
            "description":"The problem summary generated at interaction wrap up.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the resolution code of the interaction. A list of accepted values is defined in the lookup ORA_SVC_MCA_RESOLUTION_CODE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResolutionCdMeaning":{
            "type":"string",
            "description":"The description of the resolution code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the owner resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for the owner resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyUniqueName":{
            "title":"Resource Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"A uniquely identified name for the owner resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Solution":{
            "title":"Solution",
            "maxLength":4000,
            "type":"string",
            "description":"The solution summary generated at interaction wrap up.",
            "nullable":true,
            "x-queryable":true
        },
        "SrMessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier of the service request message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SummaryId":{
            "title":"Summary ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up. This value is generated during creation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SummaryNumber":{
            "title":"Summary Number",
            "maxLength":30,
            "type":"string",
            "description":"The summary number of the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TimerExpiredFlag":{
            "title":"Timer Expired",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the wrap up timer has expired.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferReason":{
            "title":"Transfer Reason",
            "maxLength":400,
            "type":"string",
            "description":"The reason the interaction was transferred to another user. This is optional and typically provided only for a transferred interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the wrap up has been updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VerifiedFlag":{
            "title":"Verified",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the associated contact has been verified.",
            "nullable":true,
            "x-queryable":true
        },
        "WrapupEndTime":{
            "title":"Wrap Up End Time",
            "type":"string",
            "description":"The date and time when the wrap up ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WrapupSavedFlag":{
            "title":"Wrap Up Saved",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the wrap up was saved.",
            "nullable":true,
            "x-queryable":true
        },
        "WrapupStartTime":{
            "title":"Wrap Up Start Time",
            "type":"string",
            "description":"The date and time when the wrap up begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object wrapUps-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/wrapUps-Attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : wrapUps-Attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared
• 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.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Attachments

Operation: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments

Parameters:

• SummaryId: $request.path.SummaryId

The attachments resource is used to view, create, and update attachments.

CommReasonLov

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

InteractionStatusCdLov

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

InteractionSubstatusCdLov

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ResolutionCdLov

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Back to Top

Examples

Use GET with the following URI syntax to get details of 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.

GET /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 Response Header

The following shows an example of the response header.

HTTP/1.1 200: OK
Date: Mon, 16 Jan 2017 13:30: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 really 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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"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"
}
],
}

Back to Top