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

すべてのケース・メッセージの取得

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • PrimaryKey : 指定された主キーを持つケース・メッセージを検索します。
      ファインダ変数:
      • MessageId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CaseId; integer; caseの一意の識別子。
    • CaseNumber; string; 大文字小文字の代替キー識別子。
    • CorpCurrencyCode; string; ケース・メッセージの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CreatedBy; string; ケースのメッセージを作成したユーザー。
    • CreationDate; string; ケース・メッセージが作成された日時。
    • CurcyConvRateType; string; ケース・メッセージに関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string; ケース・メッセージに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • LastEditedDate; string; ケース・メッセージが最後に編集された日付。
    • LastUpdateDate; string; ケースのメッセージが最後に更新された日時。
    • LastUpdatedBy; string; ケースのメッセージを最後に更新したユーザー。
    • MessageCreatedBy; string; ケース・メッセージを作成したユーザー。
    • MessageCreationDate; string; ケース・メッセージが作成された日時。
    • MessageId; integer; メッセージの一意の識別子。
    • MessageLastUpdateDate; string; ケース・メッセージが最後に更新された日時。
    • MessageLastUpdateLogin; string; ケース・メッセージを最後に更新したユーザーのアプリケーション・ログインID。
    • MessageLastUpdatedBy; string; ケース・メッセージを最後に更新したユーザー。
    • MessageNumber; string;メッセージの代替キー識別子。
    • MessageTypeCd; string; 内部や外部など、メッセージのタイプを示すコード。
    • MessageTypeCdMeaning; string; ケース・メッセージのメッセージ・タイプ参照コードに対応する表示値。
    • OriginationDate; string;メッセージの発信または投稿された日付。
    • ParentMessageId; integer; 親メッセージの一意の識別子。
    • PostedByPartyId; integer; メッセージを投稿したユーザー・パーティの一意の識別子。
    • PostedByPartyName; string; メッセージを投稿したパーティの名前。
    • PostedByPartyNumber; string; メッセージを投稿したユーザー・パーティの代替キー識別子。
    • RichTextFlag; boolean;メッセージ・コンテンツがリッチ・テキスト形式かどうかを示します。値はYまたはNです。
    • SourceCd; string; メッセージがシステムに入力された方法を示すコード。 たとえば、ORA_SVC_API、REST APIを介してケース・メッセージが作成されたORA_SVC_AGENT_UI、UIでケース・メッセージが作成されたケース・メッセージ、またはモバイル・デバイスを介してケース・メッセージが作成されたORA_SVC_MOBILEなどです。
    • SourceCdMeaning; string; ケース・メッセージのソース参照コードに対応する表示値です。
    • StatusCd; string; メッセージのステータスを示すコード。 たとえば、ORA_SVC_COMMITTEDは、メッセージがコミットされているか、NULLであることを示します。
    • StatusCdMeaning; string; ケース・メッセージのステータス参照コードに対応する表示値。
    • VisibilityCd; string; ケース・メッセージの可視性レベルを示すコード。 たとえば、ORA_SVC_EXTERNALの場合、ケース・メッセージは内部ユーザーと外部ユーザーに表示され、ORA_SVC_INTERNALの場合メッセージは内部ユーザーにのみ表示されます。
    • VisibilityCdMeaning; string; ケース・メッセージの可視性参照コードに対応する表示値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : cases-caseMessages
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : cases-caseMessages-item-response
タイプ: object
ソースを表示
  • Attachments
    タイトル: Attachments
    添付リソースは、添付の表示、作成、更新および削除に使用されます。
  • タイトル: Case ID
    ケースの一意の識別子。
  • タイトル: Case Number
    最大長: 30
    ケースの代替キー識別子。
  • タイトル: Content
    添付ではないメッセージのコンテンツ。
  • タイトル: Corporate Currency Code
    最大長: 15
    ケース・メッセージの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ケースのメッセージを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    ケース・メッセージが作成された日時。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ケース・メッセージに関連付けられた通貨換算レート・タイプです。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    ケース・メッセージに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Delete
    読取り専用: true
    レコードを削除できるかどうかを示します。
  • タイトル: Last Update Date
    ケース・メッセージが最後に編集された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    ケースのメッセージが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    ケースのメッセージを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    ケースのメッセージを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Message Created By
    最大長: 64
    ケース・メッセージを作成したユーザー。
  • タイトル: Message Creation Date
    ケース・メッセージが作成された日時。
  • タイトル: Message ID
    メッセージの一意の識別子。
  • タイトル: Message Last Update Date
    ケース・メッセージが最後に更新された日時。
  • タイトル: Message Last Updated By
    最大長: 64
    ケース・メッセージを最後に更新したユーザー。
  • タイトル: Message Last Update Login
    最大長: 32
    ケース・メッセージを最後に更新したユーザーのアプリケーション・ログインID。
  • タイトル: Message Number
    最大長: 30
    メッセージの代替キー識別子。
  • タイトル: Message Type
    最大長: 30
    デフォルト値: ORA_SVC_NOTE
    内部や外部など、メッセージのタイプを示すコード。
  • タイトル: Message Type Value
    最大長: 255
    ケース・メッセージのメッセージ・タイプ参照コードに対応する表示値。
  • タイトル: Origination Date
    メッセージが発生した日付またはメッセージが投稿された日付。
  • タイトル: Parent Message
    親メッセージの一意の識別子。
  • タイトル: Posting Party ID
    メッセージをポストしたユーザー・パーティの一意の識別子。
  • タイトル: Posted by Party Name
    読取り専用: true
    最大長: 360
    メッセージをポストしたパーティの名前。
  • タイトル: Posting Party Number
    読取り専用: true
    最大長: 30
    メッセージをポストしたユーザー・パーティの代替キー識別子。
  • タイトル: Rich Text Format
    最大長: 1
    デフォルト値: true
    メッセージ・コンテンツがリッチ・テキスト形式であるかどうかを示します。値はYまたはNです。
  • タイトル: Source
    最大長: 30
    メッセージがシステムにどのように入力されたかを示すコード。 たとえば、ORA_SVC_API、REST APIを介してケース・メッセージが作成されたORA_SVC_AGENT_UI、UIでケース・メッセージが作成されたケース・メッセージ、またはモバイル・デバイスを介してケース・メッセージが作成されたORA_SVC_MOBILEなどです。
  • タイトル: Source Value
    最大長: 255
    ケース・メッセージのソース参照コードに対応する表示値。
  • タイトル: Status Code
    最大長: 30
    デフォルト値: ORA_SVC_COMMITTED
    メッセージのステータスを示すコード。 たとえば、ORA_SVC_COMMITTEDは、メッセージがコミットされているか、NULLであることを示します。
  • タイトル: Status Value
    最大長: 255
    ケース・メッセージのステータス参照コードに対応する表示値。
  • タイトル: Update
    読取り専用: true
    レコードを更新できるかどうかを示します。
  • タイトル: Visibility
    最大長: 30
    デフォルト値: ORA_SVC_INTERNAL
    ケース・メッセージの表示レベルを示すコード。 たとえば、ORA_SVC_EXTERNALの場合、ケース・メッセージは内部ユーザーと外部ユーザーに表示され、ORA_SVC_INTERNALの場合メッセージは内部ユーザーにのみ表示されます。
  • タイトル: Visibility Value
    最大長: 255
    ケース・メッセージの表示参照コードに対応する表示値。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、添付の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : cases-caseMessages-Attachments-item-response
タイプ: object
ソースを表示
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages

レスポンス本文の例

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

  {
    "items": [
        {
            "CaseId": 300100215793299,
            "CorpCurrencyCode": null,
            "CreatedBy": "AUTOUICASE1",
            "CreationDate": "2021-08-23T06:29:12+00:00",
            "CurcyConvRateType": null,
            "CurrencyCode": null,
            "LastEditedDate": "2021-08-23T06:29:12.001+00:00",
            "LastUpdateDate": "2021-08-23T06:29:12.867+00:00",
            "LastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
            "LastUpdatedBy": "AUTOUICASE1",
            "MessageCreatedBy": "AUTOUICASE1",
            "MessageCreationDate": "2021-08-23T06:29:12+00:00",
            "MessageId": 300100215798773,
            "MessageLastUpdateDate": "2021-08-23T06:29:12.001+00:00",
            "MessageLastUpdateLogin": "C9E4F38A864CEDEEE05323EAF40A0051",
            "MessageLastUpdatedBy": "AUTOUICASE1",
            "MessageTypeCd": "ORA_SVC_NOTE",
            "OriginationDate": "2021-08-23T06:29:12+00:00",
            "ParentMessageId": null,
            "PostedByPartyId": null,
            "PostedByPartyNumber": null,
            "RichTextFlag": true,
            "SourceCd": null,
            "VisibilityCd": "ORA_SVC_INTERNAL",
            "PostedByPartyName": null,
            "CaseNumber": "CDRM_4003",
            "StatusCd": "ORA_SVC_COMMITTED",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "MessageNumber": "CDRM_4003",
            "MessageTypeCdMeaning": "Note",
            "SourceCdMeaning": null,
            "VisibilityCdMeaning": "Internal",
            "StatusCdMeaning": "Committed",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773",
                    "name": "caseMessages",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773",
                    "name": "caseMessages",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
                    "name": "cases",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgStatusCdLookup",
                    "name": "MsgStatusCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/SourceCdLookup",
                    "name": "SourceCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgVisibilityCdLookup",
                    "name": "MsgVisibilityCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/MsgTypeCdLookup",
                    "name": "MsgTypeCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/lov/YesNoLookup",
                    "name": "YesNoLookup",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages/300100215798773/enclosure/Content",
                    "name": "Content",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseMessages",
            "name": "caseMessages",
            "kind": "collection"
        }
    ]
}
「トップに戻る」