Get all wrap ups

get

/crmRestApi/resources/11.13.18.05/wrapUps

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a wrap up with the specified primary key.
      Finder Variables:
      • SummaryId; integer; The unique identifier of the wrap up.
    • WrapUpRowFinderByObject: Finds wrap ups with the specified key.
      Finder Variables:
      • ObjectId; string; The unique primary identifier of the object.
      • ObjectTypeCd; string.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AccountPartyId; integer; The unique identifier of the account associated with the interaction.
    • AccountPartyNumber; string; The public unique identifier for the account.
    • AccountPartyUniqueName; string; The unique account name of the account associated with the interaction.
    • ChannelDisplayName; string; The name displayed for this channel instance.
    • ChannelId; integer; The unique identifier of the channel associated with the interaction.
    • ChannelTypeCd; string; 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; The description of the channel type code.
    • CommReasonCd; string; 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; The description of the direction code.
    • ContactPartyId; integer; The unique identifier of the contact associated with the interaction.
    • ContactPartyName; string; The party name of the interaction contact.
    • ContactPartyNumber; string; The unique identifier of the contact associated with the interaction.
    • ContactPartyUniqueName; string; The public unique identifier for the contact.
    • CreatedBy; string; The user who created the wrap up.
    • CreationDate; string; The date and time when the record was created.
    • DirectionCd; string; The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.
    • InteractDirectionCdMeaning; string; The description of the interaction direction code.
    • InteractionDescription; string; The description of the interaction.
    • InteractionEndTime; string; The time when the interaction ended.
    • InteractionFKId; integer; The unique identifier of the interaction. The wrap up is a child resource of the interaction.
    • InteractionId; integer; The unique identifier of the interaction. A wrap up is a child resource of the interaction.
    • InteractionNotes; string; The notes associated with the interaction.
    • InteractionNumber; string; The alternate identifier of the interaction.
    • InteractionStartTime; string; The time when the interaction started.
    • InteractionStatusCd; string; 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; The code indicates the substatus of the interaction. A list of accepted values is defined in ORA_SVC_IM_CLOSED_SUBSTATUS_CD .
    • LastUpdateDate; string; The date when the wrap up was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the wrap up.
    • LastUpdatedBy; string; The user who last updated the wrap up.
    • MediaItemId; string; The Event ID generated during interaction routed through third party tools.
    • OwnerResourceId; integer; The unique identifier of the owner for the interaction.
    • ResolutionCd; string; 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; The description of the resolution code.
    • ResourcePartyName; string; The party name of the owner resource.
    • ResourcePartyNumber; string; The public unique identifier for the owner resource.
    • ResourcePartyUniqueName; string; A uniquely identified name for the owner resource.
    • SrMessageId; integer; The unique identifier of the service request message.
    • SummaryId; integer; The unique identifier of the wrap up. This value is generated during creation.
    • SummaryNumber; string; The summary number of the interaction.
    • TransferReason; string; The reason the interaction was transferred to another user. This is optional and typically provided only for a transferred interaction.
    • VerifiedFlag; boolean; Indicates if the associated contact has been verified.
    • WrapupEndTime; string; The date and time when the wrap up ends.
    • WrapupStartTime; string; The date and time when the wrap up begins.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.

There's no request body for this operation.

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 : wrapUps
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : wrapUps-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : wrapUps-Attachments-item-response
Type: object
Show Source
Back to Top

Examples

Use GET with the following URI syntax to get details of all wrap ups:

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/

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/wrapUps/ 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:32: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.

{
{
"items": [
  {
"SummaryId": 300100091632029,
"InteractionId": 300100091631979,
"CommReasonCd": "OTHER",
"ResolutionCd": "DOCUMENTATION_ISSUE",
"TransferReason": "Skip transfer",
"InteractionNotes": "No reason given",
"InteractionDescription": null,
"InteractionFKId": 300100091631979,
"InteractionObjectVersionNumber": 4,
"InteractionStatusCd": "ORA_SVC_CLOSED",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091632029",
"name": "wrapUps",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091632029",
"name": "wrapUps",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091632029/lov/ResolutionCdLov",
"name": "ResolutionCdLov",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091632029/lov/CommReasonLov",
"name": "CommReasonLov",
"kind": "collection"
}
],
},
  {
"SummaryId": 300100091779811,
"InteractionId": 300100091779766,
"CommReasonCd": "OTHER",
"ResolutionCd": "DOCUMENTATION_ISSUE",
"TransferReason": "Skip transfer",
"InteractionNotes": "No reason given",
"InteractionDescription": null,
"InteractionFKId": 300100091779766,
"InteractionObjectVersionNumber": 4,
"InteractionStatusCd": "ORA_SVC_CLOSED",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091779811",
"name": "wrapUps",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091779811",
"name": "wrapUps",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091779811/lov/ResolutionCdLov",
"name": "ResolutionCdLov",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091779811/lov/CommReasonLov",
"name": "CommReasonLov",
"kind": "collection"
}
],
},
  {
"SummaryId": 300100091810576,
"InteractionId": 300100091810550,
"CommReasonCd": "GENERAL_QUESTION",
"ResolutionCd": "ANSWERED_QUESTION",
"TransferReason": "TransferExample",
"InteractionNotes": "Here's my notes about this. Customer got locked out. So needed help",
"InteractionDescription": null,
"InteractionFKId": 300100091810550,
"InteractionObjectVersionNumber": 4,
"InteractionStatusCd": "ORA_SVC_CLOSED",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091810576",
"name": "wrapUps",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091810576",
"name": "wrapUps",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091810576/lov/ResolutionCdLov",
"name": "ResolutionCdLov",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps/300100091810576/lov/CommReasonLov",
"name": "CommReasonLov",
"kind": "collection"
}
],
},

  . . .

}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/wrapUps",
"name": "wrapUps",
"kind": "collection"
}
],
}
Back to Top