機械翻訳について
  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/caseContacts

リクエスト

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

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

    • CaseContactAltKeyFinder : 指定した代替キーを持つケース担当を検索します。
      ファインダ変数:
      • CaseNumber; string; 大文字小文字の代替キー識別子。
      • ContactPartyNumber; string; ケースに関連付けられている担当者パーティの代替キー識別子。
    • PrimaryKey : 指定した主キーを持つケース担当者を検索します。
      ファインダ変数:
      • CaseContactId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CaseContactId; integer; ケース・コンタクトの一意の識別子。
    • CaseId; integer; caseの一意の識別子。
    • CaseNumber; string; 大文字小文字の代替キー識別子。
    • ContactPartyNumber; 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で定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • EmailAddress; string; 担当者の電子メール・アドレス。
    • JobTitle; string; 担当者のジョブ・タイトル。
    • LastUpdateDate; string; ケースの担当者が最後に更新された日時。
    • LastUpdatedBy; string; ケースの担当者を最後に更新したユーザー。
    • PartyId; integer;パーティの一意の識別子。
    • PartyName; string;パーティの名前。
    • RelationshipCd; string;コンタクトとケースの関係を示すコード。 たとえば、ORA_SVC_BENEFICIARYは、ケースの受取人である担当者(ORA_SVC_CHILD)、応募者の法定子である担当者(ORA_SVC_DEPENDENT)、担当者は応募者(ORA_SVC_GUARDIAN)に依存し、担当者は申請者の法定後見人です(ORA_SVC_LAWYER)、担当者は職業によって弁護士です(ORA_SVC_PARENT)、担当者は申請者の法定の親です(ORA_SVC_PERPETRATOR)、担当者はケースを処理する担当者(ORA_SVC_PARENT)です犯罪者または有害な行為、ORA_SVC_REFERRAL、サービス・プロバイダを参照する担当者、ORA_SVC_REPORTER、インシデントを報告する担当者、ORA_SVC_SERVICE_PROVIDER、特定のサービスまたは福利厚生を応募者にレンダリングしている担当者、ORA_SVC_SIBLING、応募者の法的兄弟である担当者、ORA_SVC_SPOUSE、応募者の配偶者である担当者、またはORA_SVC_VICTIM、インシデントまたはイベントの影響を受ける担当者、
    • RelationshipCdMeaning; 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-caseContacts
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : cases-caseContacts-item-response
タイプ: object
ソースを表示
  • タイトル: Contact ID
    読取り専用: true
    ケース担当者の一意の識別子。
  • タイトル: Case ID
    ケースの一意の識別子。
  • タイトル: Case Number
    最大長: 30
    ケースの代替キー識別子。
  • タイトル: Contact Party Number
    読取り専用: true
    最大長: 30
    担当者パーティの代替キー識別子。
  • タイトル: 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
    ケース担当者を削除できるかどうかを示します。
  • タイトル: Email
    読取り専用: true
    最大長: 320
    担当者の電子メール・アドレス。
  • タイトル: Phone
    読取り専用: true
    担当者の電話番号。
  • タイトル: Job Title
    読取り専用: true
    最大長: 100
    コンタクトのジョブ・タイトル。
  • タイトル: Last Updated Date
    読取り専用: true
    ケースの担当者が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    ケースの担当者を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    ケースの担当者を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Party ID
    パーティの一意識別子
  • タイトル: Party Name
    最大長: 360
    パーティの名前。
  • タイトル: Primary Contact
    読取り専用: true
    担当者がケースのプライマリ担当者であるかどうかを示します。
  • タイトル: Relationship Code
    最大長: 30
    担当者とケースの関係を示すコード。 たとえば、ORA_SVC_BENEFICIARYは、ケースの受取人である担当者(ORA_SVC_CHILD)、応募者の法定子である担当者(ORA_SVC_DEPENDENT)、担当者は応募者(ORA_SVC_GUARDIAN)に依存し、担当者は申請者の法定後見人です(ORA_SVC_LAWYER)、担当者は職業によって弁護士です(ORA_SVC_PARENT)、担当者は申請者の法定の親です(ORA_SVC_PERPETRATOR)、担当者はケースを処理する担当者(ORA_SVC_PARENT)です犯罪者または有害な行為、ORA_SVC_REFERRAL、サービス・プロバイダを参照する担当者、ORA_SVC_REPORTER、インシデントを報告する担当者、ORA_SVC_SERVICE_PROVIDER、特定のサービスまたは福利厚生を応募者にレンダリングしている担当者、ORA_SVC_SIBLING、応募者の法的兄弟である担当者、ORA_SVC_SPOUSE、応募者の配偶者である担当者、またはORA_SVC_VICTIM、インシデントまたはイベントの影響を受ける担当者、
  • タイトル: Relationship Value
    最大長: 255
    ケース担当者の関係参照コードに対応する表示値。
  • タイトル: Update
    読取り専用: true
    ケース担当者を更新できるかどうかを示します。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのケース担当者を取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

 {
    "items": [
        {
            "CaseContactId": 300100215772591,
            "CaseId": 300100215793299,
            "CorpCurrencyCode": null,
            "CreatedBy": "AUTOUICASE1",
            "CreationDate": "2021-08-23T06:29:06+00:00",
            "CurcyConvRateType": null,
            "CurrencyCode": null,
            "LastUpdateDate": "2021-08-23T06:29:06.965+00:00",
            "LastUpdateLogin": "C9E50EC5A48AEE00E05323EAF40A1FFD",
            "LastUpdatedBy": "AUTOUICASE1",
            "PartyId": 7755,
            "ContactPartyNumber": "6191",
            "RelationshipCd": null,
            "PartyName": "Fred Bramer",
            "CaseNumber": "CDRM_4003",
            "PrimaryFlag": false,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "RelationshipCdMeaning": null,
            "EmailAddress": "sendmail-test-discard@oracle.com",
            "FormattedPhoneNumber": "+1 ",
            "JobTitle": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591",
                    "name": "caseContacts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591",
                    "name": "caseContacts",
                    "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/caseContacts/300100215772591/lov/PersonDVO",
                    "name": "PersonDVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseContacts/300100215772591/lov/ContactRelCdLookup",
                    "name": "ContactRelCdLookup",
                    "kind": "collection"
                }
            ]
        }
    ],
    "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/caseContacts",
            "name": "caseContacts",
            "kind": "collection"
        }
    ]
}
「トップに戻る」