Get all inbound messages

get

/crmRestApi/resources/11.13.18.05/inboundMessages

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 an inbound message with the specified primary key.
      Finder Variables:
      • InboundMessageId; integer; The unique identifier of the inbound message.
  • 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:
    • AcknowledgedDate; string; The date when the inbound message was acknowledged.
    • BUOrgId; integer; The unique ID of the business unit name associated to inbound email.
    • BatchId; integer; The unique identifier of the batch in which the inbound message will be processed.
    • ChannelId; integer; The unique identifier of the channel for the inbound message.
    • ChannelTypeCdMeaning; string; The display value corresponding to the channel type lookup code for the inbound email.
    • ConnectionTypeCd; string; Indicates the connection type that was used to read the inbound message.
    • ConnectionTypeCdMeaning; string; Indicates the display value corresponding to the connection type lookup code for the inbound message.
    • ContentTypeCd; string; The content type of the inbound message.
    • ContentTypeCdMeaning; string; The display value corresponding to the content type lookup code for the inbound email.
    • CreatedBy; string; The user who created the inbound message.
    • CreationDate; string; The date when the inbound message was created.
    • FusionRecipient; string; The account to which the service requests are forwarded.
    • InboundMessageId; integer; The unique identifier of an inbound message.
    • LastUpdateDate; string; The date when the inbound message was last updated.
    • LastUpdatedBy; string; The user who last updated the inbound message.
    • ObjectId; integer; The unique identifier of the business object associated with the inbound message.
    • ObjectTypeCd; string; The type of business object associated with the inbound message, for example SVC_SERVICE_REQUESTS.
    • ObjectTypeCdMeaning; string; The display value corresponding to the object type lookup code for the inbound email.
    • ReceivedChannelCd; string; The channel type of the inbound message. For example E-Mail or SMS.
    • ReceivedDateTime; string; Indicates the date and time when the mailbox received the email.
    • RetryCount; integer; The number of times the system attempted to process the inbound messages.
    • Sender; string; The sender of an inbound message.
    • SenderPartyId; integer; The party identifier of the person who sent the message.
    • SourceMessageId; string; The message ID in the source system.
    • StatusCd; string; The current status of the inbound message. For example Received, Processed, or Deleted.
    • StatusDetails; string; The details of the inbound email processing status.
    • StatusTypeCdMeaning; string; The display value corresponding to the status type lookup code for the inbound email.
    • StripeCd; string; The application context of inbound messages.
    • StripeCdMeaning; string; The display value corresponding to the stripe type lookup code for the inbound email.
    • StripeCode; string; The application stripe of the inbound message.
    • Subject; string; The subject of the inbound message.
  • 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 : inboundMessages
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inboundMessages-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.
Show Source
Nested Schema : Inbound Message Parts
Type: array
Title: Inbound Message Parts
The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.
Show Source
Nested Schema : inboundMessages-Attachments-item-response
Type: object
Show Source
Nested Schema : inboundMessages-InboundMsgParts-item-response
Type: object
Show Source
Back to Top

Examples

Use GET with the following URI syntax to get all inbound messages:

Example of Request URI

The following shows an example of the request URL.

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/inboundMessages/ 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, 18 Jan 2017 09:10: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:
{
  "items": [
    {
      "InboundMessageId": 300100095258851,
      "Sender": "edwin.mitchell@us2.oraclecloud.com",
      "FusionRecipient": "incoming@service.us2.oraclecloud.com",
      "Subject": "SendEmailAUTOScriptOn_13012017_162851.476",
      "ContentTypeCd": "ORA_SVC_TEXT_HTML",
      "StatusCd": "ORA_SVC_RECEIVED",
      "ReceivedChannelCd": "ORA_SVC_EMAIL",
      "AcknowledgedDate": null,
      "CreationDate": "2017-01-13T16:29:03-08:00",
      "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
      "LastUpdateDate": "2017-01-13T16:29:03-08:00",
      "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
      "ChannelId": 300100089980767,
      "ObjectId": null,
      "ObjectTypeCd": null,
      "BatchId": 300100095258850,
      "RetryCount": 0,
      "StripeCode": "ORA_SVC_CRM",
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851",
          "name": "inboundMessages",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851",
          "name": "inboundMessages",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/child/InboundMsgParts",
          "name": "InboundMsgParts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/child/Attachments",
          "name": "Attachments",
          "kind": "collection"
        },
        {
          "rel": "enclosure",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/enclosure/Body",
          "name": "Body",
          "kind": "other"
        },
        {
          "rel": "enclosure",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/enclosure/PlainTextBody",
          "name": "PlainTextBody",
          "kind": "other"
        }
      ]
    },
    {
      "InboundMessageId": 300100095315827,
      "Sender": "service_test5@servername.fa.us2.oraclecloud.com",
      "FusionRecipient": "edwin.mitchell@us2.oraclecloud.com",
      "Subject": "SendEmailAUTOScriptOn_17012017_161417.423",
      "ContentTypeCd": "ORA_SVC_TEXT_HTML",
      "StatusCd": "ORA_SVC_PROCESSED",
      "ReceivedChannelCd": "ORA_SVC_EMAIL",
      "AcknowledgedDate": "2017-01-17T16:15:00-08:00",
      "CreationDate": "2017-01-17T16:14:57-08:00",
      "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
      "LastUpdateDate": "2017-01-17T16:15:00-08:00",
      "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
      "ChannelId": 300100089980767,
      "ObjectId": 300100095315837,
      "ObjectTypeCd": "SVC_SERVICE_REQUESTS",
      "BatchId": 300100095315826,
      "RetryCount": 0,
      "StripeCode": "ORA_SVC_CRM",
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827",
          "name": "inboundMessages",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827",
          "name": "inboundMessages",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/child/InboundMsgParts",
          "name": "InboundMsgParts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/child/Attachments",
          "name": "Attachments",
          "kind": "collection"
        },
        {
          "rel": "enclosure",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/enclosure/Body",
          "name": "Body",
          "kind": "other"
        },
        {
          "rel": "enclosure",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/enclosure/PlainTextBody",
          "name": "PlainTextBody",
          "kind": "other"
        }
      ]
    },
    

     . . .

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