機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アウトバウンド・メッセージ

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

get

/crmRestApi/resources/11.13.18.05/outboundMessages

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • PrimaryKey主キーを含むアウトバウンド・メッセージを検索します。
      ファインダ変数
      • OutboundMessageId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AlternateMessageId; string; 電子メール配信アプリケーション内のアウトバウンド電子メールの一意の識別子。
    • BUOrgId; integer;ビジネス・ユニット組織IDの一意の識別子。
    • ChannelId; integer; アウトバウンド・メッセージのチャネルの一意の識別子。
    • ChannelTypeCd; string; チャネル・タイプ・コード。
    • CorpCurrencyCode; string; アウトバウンド・メッセージに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CreatedBy; string; コードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CurcyConvRateType; string;アウトバウンド・メッセージに関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string; アウトバウンド・メッセージに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • DeliveryTypeCd; string;アウトバウンド・メッセージの配信タイプ・コード。
    • LastUpdateDate; string;アウトバウンド・メッセージが最後に更新された日付。
    • LastUpdatedBy; string; アウトバウンド・メッセージを最後に更新したユーザー。
    • OutboundMessageId; integer;アウトバウンド・メッセージの一意の識別子。
    • OutboundMessageNumber; string;アウトバウンド・メッセージの代替キー識別子。
    • PostedByPartyid; integer; アウトバウンド・メッセージを投稿したユーザーの一意のパーティ識別子。
    • ProcessingStatusCd; string;アウトバウンド・メッセージの処理ステータス・コード。
    • ReplyToAddress; string;アウトバウンド・メッセージのアドレスへの返信。
    • RetryCount; integer;アウトバウンド・メッセージの再試行回数。
    • SenderEmailSourceCd; string; アウトバウンド・メッセージの送信者Eメールのソース・コード。
    • SenderName; string;アウトバウンド・メッセージを送信した送信者の名前。
    • SentDate; string;送信者がメッセージを送信した日付。
    • SourceCd; string;アウトバウンド・メッセージのソース・コード。
    • SourceMsgObjId; integer;アウトバウンド・メッセージのオブジェクト識別子。
    • SourceMsgObjTypeCd; string;アウトバウンド・メッセージのソース・メッセージ・オブジェクト・タイプ・コード。
    • SourceObjId; integer;アウトバウンド・メッセージのソース・オブジェクト識別子。
    • SourceObjPkName; string;アウトバウンド・メッセージのソース・オブジェクトの主キー。
    • SourceObjTemplateName; string;アウトバウンド・メッセージのテンプレート名。
    • SourceObjTypeCd; string;アウトバウンド・メッセージのソース・オブジェクト・タイプ・コード。
    • StatusCd; string;アウトバウンド・メッセージのステータス・コード。
    • StatusDetails; string;アウトバウンド・メッセージのステータス詳細。
    • StripeCd; string;アウトバウンド・メッセージのストライプ・コード。
    • Subject; string;アウトバウンド・メッセージの件名。
    • UsePostedByEmailFlag; boolean;アウトバウンド・メッセージを投稿したユーザーの電子メール。
    • UsePostedByNameFlag; boolean;アウトバウンド・メッセージを投稿したユーザーの名前。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : outboundMessages
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : outboundMessages-item-response
タイプ: object
ソースを表示
  • タイトル: Alternate Message ID
    最大長: 2000
    Eメール配信アプリケーションのアウトバウンドEメールの一意の識別子。
  • タイトル: Body
    アウトバウンド・メッセージの本文。
  • タイトル: Business Organization ID
    ビジネス・ユニット組織IDの一意の識別子。
  • タイトル: Channel ID
    アウトバウンド・メッセージのチャネルの一意の識別子。
  • タイトル: Channel Type Code
    最大長: 30
    チャネル・タイプ・コード。
  • タイトル: Corporate Currency Code
    最大長: 15
    アウトバウンド・メッセージに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    コードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Type of Currency Conversion Rate
    最大長: 30
    アウトバウンド・メッセージに関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    アウトバウンド・メッセージに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Can Delete Message
    読取り専用: true
    アウトバウンド・メッセージ・レコードを削除できるかどうかを示します。
  • タイトル: Delivery Type Code
    最大長: 30
    デフォルト値: ORA_SVC_IMMEDIATE
    アウトバウンド・メッセージの配信タイプ・コード。
  • タイトル: Last Updated Date
    読取り専用: true
    アウトバウンド・メッセージが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アウトバウンド・メッセージを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アウトバウンド・メッセージを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Message Content
    電子メールの内容など、アウトバウンド・メッセージのコンテンツ。
  • タイトル: Outbound Message ID
    アウトバウンド・メッセージの一意の識別子。
  • タイトル: Outbound Message Number
    最大長: 30
    アウトバウンド・メッセージの代替キー識別子。
  • Outbound Message Parts
    タイトル: Outbound Message Parts
    アウトバウンド・メッセージ・パート・リソースは、アウトバウンド・メッセージ・パートの表示、作成、更新および削除に使用されます。 ルート・アウトバウンド・メッセージ・リソース部分の説明を取得するために使用されます。
  • タイトル: Posted by Party ID
    アウトバウンド・メッセージを投稿したユーザーの一意のパーティ識別子。
  • タイトル: Processing Status Code
    最大長: 30
    アウトバウンド・メッセージの処理ステータス・コード。
  • タイトル: Reply to Address
    最大長: 240
    アウトバウンド・メッセージの返信先アドレス。
  • タイトル: Retry Count
    デフォルト値: 0
    アウトバウンド・メッセージの再試行回数。
  • タイトル: Sender Email Source Code
    最大長: 30
    アウトバウンド・メッセージの送信者Eメールのソース・コード。
  • タイトル: Sender Name
    最大長: 100
    アウトバウンド・メッセージを送信した送信者の名前。
  • タイトル: Sent Date
    送信者がメッセージを送信した日付。
  • タイトル: Source Code
    最大長: 30
    アウトバウンド・メッセージのソース・コード。
  • タイトル: Source Message Object ID
    アウトバウンド・メッセージのオブジェクト識別子。
  • タイトル: Source Message Object Type Code
    最大長: 30
    アウトバウンド・メッセージのソース・メッセージ・オブジェクト・タイプ・コード。
  • タイトル: Source Object ID
    アウトバウンド・メッセージのソース・オブジェクト識別子。
  • タイトル: Source Object Primary Key Name
    最大長: 30
    アウトバウンド・メッセージのソース・オブジェクト主キー。
  • タイトル: Source Object Template Name
    最大長: 240
    アウトバウンド・メッセージのテンプレート名。
  • タイトル: Source Object Type Code
    最大長: 30
    アウトバウンド・メッセージのソース・オブジェクト・タイプ・コード。
  • タイトル: Status Code
    最大長: 30
    アウトバウンド・メッセージのステータス・コード。
  • タイトル: Status Details
    最大長: 1000
    アウトバウンド・メッセージのステータス詳細。
  • タイトル: Stripe Code
    最大長: 30
    アウトバウンド・メッセージのストライプ・コード。
  • タイトル: Subject
    最大長: 400
    アウトバウンド・メッセージの件名。
  • タイトル: Can Update Message
    アウトバウンド・メッセージが更新されたかどうかを示します。
  • タイトル: Use Posted by Party Email
    最大長: 1
    デフォルト値: false
    アウトバウンド・メッセージを投稿したユーザーのEメール。
  • タイトル: Use Posted by Party Name
    最大長: 1
    デフォルト値: false
    アウトバウンド・メッセージを投稿したユーザーの名前。
ネストされたスキーマ : アウトバウンド・メッセージ部品
タイプ: array
タイトル: Outbound Message Parts
アウトバウンド・メッセージ・パート・リソースは、アウトバウンド・メッセージ・パートの表示、作成、更新および削除に使用されます。 ルート・アウトバウンド・メッセージ・リソース部分の説明を取得するために使用されます。
ソースを表示
ネストされたスキーマ : outboundMessages-OutboundMsgParts-item-response
タイプ: object
ソースを表示
  • タイトル: Corporate Currency Code
    最大長: 15
    メッセージ・パートに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アウトバウンド・メッセージ受信者を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アウトバウンド・メッセージが作成された日付。
  • タイトル: Type of Currency Conversion Rate
    最大長: 30
    メッセージ・パートの通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    メッセージ・パートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Can Delete Message Part
    読取り専用: true
    アウトバウンド・メッセージが削除されたかどうかを示します。
  • タイトル: Last Updated Date
    読取り専用: true
    アウトバウンド・メッセージ詳細が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アウトバウンド・メッセージ詳細を最後に更新したユーザーのログイン。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アウトバウンド・メッセージ詳細を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Outbound Message ID
    アウトバウンド・メッセージ詳細の一意の識別子。
  • タイトル: Outbound Message Part ID
    アウトバウンド・メッセージ詳細の一意の部分識別子。
  • タイトル: Part Name
    最大長: 64
    アウトバウンド・メッセージ詳細のパート名。
  • タイトル: Part Type Code
    最大長: 30
    アウトバウンド・メッセージ詳細のパート・タイプ。
  • タイトル: Part Value
    最大長: 2000
    アウトバウンド・メッセージ詳細のパート値。
  • タイトル: Can Update Message Part
    読取り専用: true
    アウトバウンド・メッセージを更新できるかどうかを示します。
リンク
getMessageDetails
アウトバウンド・メッセージおよびアウトバウンド・メッセージ受信者の作成
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのアウトバウンド・メッセージを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "items": [
    {
      "OutboundMessageId": 300100185236180,
      "SourceMsgObjId": 300100185236178,
      "SourceObjId": null,
      "SourceObjTypeCd": null,
      "SourceObjTemplateName": null,
      "SourceObjPkName": null,
      "PostedByPartyid": 300100112113725,
      "Subject": "Test Inboud Email",
      "SourceCd": "ORA_SVC_API",
      "ChannelId": 100100104291163,
      "StatusCd": "ORA_SVC_COMMITTED",
      "StatusDetails": null,
      "ProcessingStatusCd": "ORA_SVC_READY",
      "SentDate": null,
      "ReplyToAddress": null,
      "BUOrgId": 204,
      "StripeCd": "ORA_SVC_CRM",
      "CreationDate": "2020-04-22T15:55:30.607+00:00",
      "CreatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2020-04-22T15:55:30.607+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateLogin": "A3C4EB7111592134E053773AF80AD383",
      "ChannelTypeCd": "ORA_SVC_EMAIL",
      "RetryCount": 0,
      "SourceMsgObjTypeCd": "ConversationMessage",
      "OutboundMessageNumber": "CDRM_0000000001",
      "SenderName": null,
      "UsePostedByEmailFlag": false,
      "UsePostedByNameFlag": false,
      "UpdateFlag": true,
      "DeleteFlag": true,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "CurrencyCode": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180",
          "name": "outboundMessages",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180",
          "name": "outboundMessages",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180/child/OutboundMsgParts",
          "name": "OutboundMsgParts",
          "kind": "collection"
        },
        {
          "rel": "enclosure",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180/enclosure/Body",
          "name": "Body",
          "kind": "other"
        },
        {
          "rel": "enclosure",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180/enclosure/MessageContent",
          "name": "MessageContent",
          "kind": "other"
        }
      ]
    },
...
「トップに戻る」