機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アクセス・グループ・ルール
  4. アクセス・グループ・ルール候補

すべてのアクセス・グループ候補の取得

get

/crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate

リクエスト

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

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

    • AltKey : アクセス・グループ候補の代替キー。
      ファインダ変数:
      • PrimaryKey : 指定した主キーを持つアクセス・グループ候補を検索します。
        ファインダ変数:
        • RuleCandidateId; integer; ルール候補の一意の識別子。
      • RowFinder : 候補者番号を持つアクセス・グループ候補を検索します。
        ファインダ変数:
        • RuleCandidateNumber; string;候補番号は一意の英数字文字列です。
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • AccessGroupName; string;アクセス・グループ候補の名前。
      • AccessGroupNumber; string; このルールに関連付けられているアクセス・グループ番号。
      • AccessLevel; string;ルールに関連付けられたアクセス・レベル。
      • CreatedBy; string; グループ候補を作成したユーザー。
      • CreationDate; string;グループ候補が作成された日付。
      • EnableFlag; boolean。このルールに対してアクセス・グループの候補が有効かどうかを示します。
      • LastUpdateDate; string;グループ候補が最後に更新された日付。
      • LastUpdatedBy; string; グループ候補を最後に更新したユーザー。
      • PredefinedFlag; boolean。アクセス・グループ候補がシードされているかどうかを示します。
      • RuleCandidateId; integer; ルール候補の一意の識別子。
      • RuleCandidateNumber; string;アクセス・グループ・ルール候補の内部番号。
      • RuleNumber; string; このアクセス・グループの候補が属するルール番号。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : accessGroupRules-AccessGroupCandidate
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : accessGroupRules-AccessGroupCandidate-item-response
    タイプ: object
    ソースを表示
    • タイトル: Access Group Name
      読取り専用: true
      最大長: 4000
      アクセス・グループ候補の名前。
    • タイトル: Access Group Number
      読取り専用: true
      最大長: 4000
      このルールに関連付けられているアクセス・グループ番号。
    • タイトル: Access Level
      最大長: 255
      デフォルト値: READ
      ルールに関連付けられたアクセス・レベル。
    • タイトル: Created By
      読取り専用: true
      最大長: 64
      グループ候補を作成したユーザー。
    • タイトル: Creation Date
      読取り専用: true
      グループ候補者が作成された日付。
    • タイトル: Delete
      読取り専用: true
      候補者を削除できるかどうかを示します。
    • タイトル: Enable
      最大長: 1
      アクセス・グループの候補者がこのルールに対して使用可能かどうかを示します。
    • タイトル: Last Updated Date
      読取り専用: true
      グループ候補者が最後に更新された日付。
    • タイトル: Last Updated By
      読取り専用: true
      最大長: 64
      グループ候補を最後に更新したユーザー。
    • Links
    • タイトル: Predefined
      読取り専用: true
      アクセス・グループ候補がシードされているかどうかを示します。
    • タイトル: Rule Candidate ID
      ルール候補の一意の識別子。
    • タイトル: Rule Candidate Number
      最大長: 30
      アクセス・グループ・ルール候補の内部番号。
    • タイトル: Rule Number
      読取り専用: true
      最大長: 30
      このアクセス・グループ候補が属するルール番号。
    • タイトル: Update
      読取り専用: true
      候補者を更新できるかどうかを示します。
    トップに戻る

    例:

    次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのアクセス・グループ候補を取得する方法を示しています。

    cURLコマンド

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

    レスポンス本文の例

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

    {
    "items": [
        {
            "RuleCandidateNumber": "AccountPR7_C1",
            "RuleNumber": "AccountPR7",
            "AccessGroupNumber": "ORA_MKL_SALES_LEAD_QUALIFIER_JOB",
            "AccessLevel": "FULL",
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2020-09-10T18:28:48.909+00:00",
            "LastUpdateDate": "2020-10-01T20:19:46.284+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "RuleCandidateId": 100100228135143,
            "PredefinedFlag": true,
            "EnableFlag": false,
            "AccessGroupName": "Sales Lead Qualifier Group",
            "UpdateFlag": "true",
            "DeleteFlag": "false",
            "links": [
                {
                    "rel": "self",
                    "href": "https://fuscdrmsmc212-fa-ext.us.oracle.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/AccountPR7/child/AccessGroupCandidate/AccountPR7_C1",
                    "name": "AccessGroupCandidate",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://fuscdrmsmc212-fa-ext.us.oracle.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/AccountPR7/child/AccessGroupCandidate/AccountPR7_C1",
                    "name": "AccessGroupCandidate",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://fuscdrmsmc212-fa-ext.us.oracle.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/AccountPR7",
                    "name": "accessGroupRules",
                    "kind": "item"
                },
                {
                    "rel": "action",
                    "href": "https://fuscdrmsmc212-fa-ext.us.oracle.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/AccountPR7/child/AccessGroupCandidate/AccountPR7_C1/action/deleteCandidateAndPublishRule",
                    "name": "deleteCandidateAndPublishRule",
                    "kind": "other"
                }
            ]
        },
        {
            "RuleCandidateNumber": "AccountPR7_C10",
            "RuleNumber": "AccountPR7",
            "AccessGroupNumber": "ORA_ZCA_CUSTOMER_RELATIONSHIP_MANAGEMENT_APPLICATION_ADMINISTRATOR_JOB",
            "AccessLevel": "FULL",
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2020-09-10T18:28:48.909+00:00",
            "LastUpdateDate": "2020-10-01T20:19:46.286+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "RuleCandidateId": 100100228135145,
            "PredefinedFlag": true,
            "EnableFlag": false,
            "AccessGroupName": "Customer Relationship Management Application Administrator Group",
            "UpdateFlag": "true",
            "DeleteFlag": "false",
            "links": [
                {
                    "rel": "self",
                    "href": "https://fuscdrmsmc212-fa-ext.us.oracle.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/AccountPR7/child/AccessGroupCandidate/AccountPR7_C10",
                    "name": "AccessGroupCandidate",
                    "kind": "item",
                    "properties": {
...
}
    「トップに戻る」