機械翻訳について

すべてのインバウンド・メッセージの取得

get

/crmRestApi/resources/11.13.18.05/inboundMessages

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定された主キーを持つインバウンド・メッセージを検索します。
      ファインダ変数:
      • InboundMessageId; integer;インバウンド・メッセージの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AcknowledgedDate; string;インバウンド・メッセージが確認された日付。
    • BUOrgId; integer;インバウンドEメールに関連付けられたビジネス・ユニット名の一意のID。
    • BatchId; integer; インバウンド・メッセージが処理されるバッチの一意の識別子。
    • ChannelId; integer;インバウンド・メッセージに対するチャネルの一意の識別子。
    • ChannelTypeCdMeaning; string;インバウンドEメールのチャネル・タイプ参照コードに対応する表示値。
    • ConnectionTypeCd; string; インバウンド・メッセージの読取りに使用された接続タイプを示します。
    • ConnectionTypeCdMeaning; string; インバウンド・メッセージの接続タイプ参照コードに対応する表示値を示します。
    • ContentTypeCd; string;インバウンド・メッセージのコンテンツ・タイプ。
    • ContentTypeCdMeaning; string; インバウンドEメールのコンテンツ・タイプ参照コードに対応する表示値。
    • CreatedBy; string;インバウンド・メッセージを作成したユーザー。
    • CreationDate; string;インバウンド・メッセージが作成された日付。
    • FusionRecipient; string; サービス・リクエストの転送先となるアカウント。
    • InboundMessageId; integer;インバウンド・メッセージの一意の識別子。
    • LastUpdateDate; string;インバウンド・メッセージが最後に更新された日付。
    • LastUpdatedBy; string; インバウンド・メッセージを最後に更新したユーザー。
    • ObjectId; integer; インバウンド・メッセージに関連付けられたビジネス・オブジェクトの一意の識別子。
    • ObjectTypeCd; string; インバウンド・メッセージに関連付けられたビジネス・オブジェクトのタイプ(例: SVC_SERVICE_REQUESTS)。
    • ObjectTypeCdMeaning; string; インバウンドEメールのオブジェクト・タイプ参照コードに対応する表示値。
    • ReceivedChannelCd; string;インバウンド・メッセージのチャネル・タイプ。 たとえば、EメールやSMSです。
    • ReceivedDateTime; string; メールボックスがEメールを受信した日時を示します。
    • RetryCount; integer;システムがインバウンド・メッセージの処理を試行した回数。
    • 送信者;文字列;インバウンド・メッセージの送信者。
    • SenderPartyId; integer; メッセージを送信した個人のパーティ識別子。
    • SourceMessageId; string;ソース・システム内のメッセージID。
    • StatusCd; string;インバウンド・メッセージの現在のステータス。 たとえば、受信済、処理済、削除済などです。
    • StatusDetails; string;インバウンドEメール処理ステータスの詳細。
    • StatusTypeCdMeaning; string;インバウンドEメールのステータス・タイプ参照コードに対応する表示値。
    • StripeCd; string;インバウンド・メッセージのアプリケーション・コンテキスト。
    • StripeCdMeaning; string;インバウンドEメールのストライプ・タイプ参照コードに対応する表示値。
    • StripeCode; string;インバウンド・メッセージのアプリケーション・ストライプ。
    • Subject; string;インバウンド・メッセージの件名。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : inboundMessages
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : inboundMessages-item-response
タイプ: object
ソースを表示
  • タイトル: Acknowledged Date
    インバウンド・メッセージが確認された日付。
  • Attachments
    タイトル: Attachments
    添付リソースは、インバウンド・メッセージとともに添付として送信されるファイルのリストを作成、表示、更新および削除するために使用されます。 たとえば、エラー・メッセージのスクリーンショットを含むドキュメントです。
  • タイトル: Batch ID
    インバウンド・メッセージが処理されるバッチの一意の識別子。
  • タイトル: Body
    インバウンド・メッセージのコンテンツ。
  • タイトル: Business Unit ID
    読取り専用: true
    インバウンドEメールに関連付けられたビジネス・ユニット名の一意のID。
  • タイトル: Channel ID
    インバウンド・メッセージに対するチャネルの一意の識別子。
  • タイトル: Channel Type Value
    最大長: 255
    インバウンドEメールのチャネル・タイプ参照コードに対応する表示値。
  • タイトル: Connection Type Code
    最大長: 30
    デフォルト値: ORA_SVC_UMS
    インバウンド・メッセージの読取りに使用された接続タイプを示します。
  • タイトル: Connection Type Value
    最大長: 255
    インバウンド・メッセージの接続タイプ参照コードに対応する表示値を示します。
  • タイトル: Content Type
    最大長: 30
    インバウンド・メッセージのコンテンツ・タイプ。
  • タイトル: Content Type Value
    最大長: 255
    インバウンドEメールのコンテンツ・タイプ参照コードに対応する表示値。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    インバウンド・メッセージを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    インバウンド・メッセージが作成された日付。
  • タイトル: Can Delete
    読取り専用: true
    インバウンド・メッセージを削除できるかどうかを示します。
  • タイトル: Inbound Message Account
    最大長: 320
    サービス・リクエストが転送される取引先。
  • タイトル: Inbound Message ID
    インバウンド・メッセージの一意の識別子。
  • Inbound Message Parts
    タイトル: Inbound Message Parts
    インバウンド・メッセージ・パート・リソースは、インバウンド・メッセージのコンポーネント・リスト(送信元、送信先、CC、重要度など)の作成、表示、更新および削除に使用されます。
  • タイトル: Last Updated Date
    読取り専用: true
    インバウンド・メッセージが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    インバウンド・メッセージを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Object ID
    インバウンド・メッセージに関連付けられたビジネス・オブジェクトの一意の識別子。
  • タイトル: Object Type
    最大長: 30
    インバウンド・メッセージに関連付けられたビジネス・オブジェクトのタイプ(SVC_SERVICE_REQUESTSなど)。
  • タイトル: Object Type Value
    最大長: 255
    インバウンドEメールのオブジェクト・タイプ参照コードに対応する表示値。
  • タイトル: Plain Text Body
    インバウンド・メッセージのプレーン・テキスト・コンテンツ。
  • タイトル: Received Channel Code
    最大長: 30
    インバウンド・メッセージのチャネル・タイプ。 たとえば、EメールやSMSです。
  • タイトル: Received Date Time
    メールボックスがEメールを受信した日時を示します。
  • タイトル: Retry Count
    システムがインバウンド・メッセージの処理を試行した回数。
  • タイトル: Sender
    最大長: 320
    インバウンド・メッセージの送信者。
  • タイトル: Sender Party ID
    メッセージを送信した個人のパーティ識別子。
  • タイトル: Source Message ID
    最大長: 2000
    ソース・システムのメッセージID。
  • タイトル: Status Code
    最大長: 30
    インバウンド・メッセージの現在のステータス。 たとえば、受信済、処理済、削除済などです。
  • タイトル: Status Details
    最大長: 1000
    インバウンドEメール処理ステータスの詳細。
  • タイトル: Status Type Value
    最大長: 255
    インバウンドEメールのステータス・タイプ参照コードに対応する表示値。
  • タイトル: Stripe Code
    最大長: 30
    インバウンド・メッセージのアプリケーション・コンテキスト。
  • タイトル: Stripe Value
    最大長: 255
    インバウンドEメールのストライプ・タイプ参照コードに対応する表示値。
  • タイトル: Stripe Code
    インバウンド・メッセージのアプリケーション・ストライプ。
  • タイトル: Subject
    最大長: 400
    インバウンド・メッセージの件名。
  • タイトル: Can Update
    読取り専用: true
    インバウンド・メッセージを更新できるかどうかを示します。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、インバウンド・メッセージとともに添付として送信されるファイルのリストを作成、表示、更新および削除するために使用されます。 たとえば、エラー・メッセージのスクリーンショットを含むドキュメントです。
ソースを表示
ネストされたスキーマ : インバウンド・メッセージ部品
タイプ: array
タイトル: Inbound Message Parts
インバウンド・メッセージ・パート・リソースは、インバウンド・メッセージのコンポーネント・リスト(送信元、送信先、CC、重要度など)の作成、表示、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : inboundMessages-Attachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : inboundMessages-InboundMsgParts-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    インバウンド・メッセージ・パートを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    インバウンド・メッセージ・パートが作成された日付。
  • タイトル: Can Delete
    読取り専用: true
    インバウンド・メッセージ・パートを削除できるかどうかを示します。
  • タイトル: Inbound Message ID
    メッセージ・パートが関連付けられているインバウンド・メッセージの一意の識別子。
  • タイトル: Inbound Message Part ID
    メッセージ・パートの一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    インバウンド・メッセージ部分が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    インバウンド・メッセージ・パートを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Part Name
    最大長: 64
    インバウンド・メッセージ部分のヘッダー名。
  • タイトル: Part Type Code
    最大長: 30
    インバウンド・メッセージ部分のタイプ。
  • タイトル: Part Type Value
    最大長: 255
    インバウンド・メッセージの部品タイプ参照コードに対応する表示値。
  • タイトル: Part Value
    最大長: 2000
    インバウンド・メッセージ部分の値。
  • タイトル: Can Update
    読取り専用: true
    インバウンド・メッセージ・パートを更新できるかどうかを示します。
トップに戻る

例:

次のURI構文でGETを使用して、すべてのインバウンド・メッセージを取得します:

リクエストURIの例

次に、リクエストURLの例を示します。

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

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

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

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

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

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

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"
    }
  ]
} 
「トップに戻る」