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

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

get

/crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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指定した主キーを持つアウトバウンド・メッセージの詳細を検索します。
      ファインダ変数
      • OutboundMsgPartId; integer;アウトバウンド・メッセージ・パートIDの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CorpCurrencyCode; string; メッセージ部分に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CreatedBy; string; アウトバウンド・メッセージ受信者を作成したユーザー。
    • CreationDate; string;アウトバウンド・メッセージが作成された日付。
    • CurcyConvRateType; string; メッセージ・パートの通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string; メッセージ部分に関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • LastUpdateDate; string;アウトバウンド・メッセージの詳細が最後に更新された日付。
    • LastUpdatedBy; string; アウトバウンド・メッセージの詳細を最後に更新したユーザーのログイン。
    • OutboundMessageId; integer;アウトバウンド・メッセージ詳細の一意の識別子。
    • OutboundMsgPartId; integer;アウトバウンド・メッセージ詳細の一意の部分識別子。
    • PartName; string;アウトバウンド・メッセージの詳細の部分名。
    • PartTypeCd; string;アウトバウンド・メッセージの詳細のパート・タイプ。
    • PartValue; string;アウトバウンド・メッセージの詳細の部分値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : outboundMessages-OutboundMsgParts
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : 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
    アウトバウンド・メッセージを更新できるかどうかを示します。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
  "items": [
    {
      "OutboundMsgPartId": 300100192129744,
      "OutboundMessageId": 300100192129742,
      "PartTypeCd": "ORA_SVC_ATTACHMENT",
      "PartName": null,
      "PartValue": "300100192129741",
      "CreationDate": "2020-07-23T14:22:54.552+00:00",
      "CreatedBy": "automisrhdagent1",
      "LastUpdateDate": "2020-07-23T14:22:54.553+00:00",
      "LastUpdatedBy": "automisrhdagent1",
      "LastUpdateLogin": "A95B195E6936F8C0E053773AF80AA280",
      "DeleteFlag": true,
      "UpdateFlag": true,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "CurrencyCode": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742/child/OutboundMsgParts/300100192129744",
          "name": "OutboundMsgParts",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742/child/OutboundMsgParts/300100192129744",
          "name": "OutboundMsgParts",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742",
          "name": "outboundMessages",
          "kind": "item"
        }
      ]
    },
    {
      "OutboundMsgPartId": 300100192129743,
      "OutboundMessageId": 300100192129742,
      "PartTypeCd": "ORA_SVC_TO",
      "PartName": null,
      "PartValue": "sendmail-test-discard@oracle.com",
      "CreationDate": "2020-07-23T14:22:54.538+00:00",
      "CreatedBy": "automisrhdagent1",
      "LastUpdateDate": "2020-07-23T14:22:54.539+00:00",
      "LastUpdatedBy": "automisrhdagent1",
      "LastUpdateLogin": "A95B195E6936F8C0E053773AF80AA280",
      "DeleteFlag": true,
      "UpdateFlag": true,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "CurrencyCode": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742/child/OutboundMsgParts/300100192129743",
          "name": "OutboundMsgParts",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742/child/OutboundMsgParts/300100192129743",
          "name": "OutboundMsgParts",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742",
          "name": "outboundMessages",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100192129742/child/OutboundMsgParts",
      "name": "OutboundMsgParts",
      "kind": "collection"
    }
  ]
}
「トップに戻る」