機械翻訳について

アクセス・グループ・ルールの取得

get

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

リクエスト

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

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accessGroupRules-item-response
タイプ: object
ソースを表示
  • Access Group Rule Candidates
    タイトル: Access Group Rule Candidates
    アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。
  • Access Group Rule Conditions
    タイトル: Access Group Rule Conditions
    アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。
  • タイトル: Active
    最大長: 1
    デフォルト値: false
    アクセス・グループ・ルールがアクティブかどうかを示します。
  • タイトル: Condition Code
    最大長: 240
    事前定義済ルールのコード。 ハイブリッド・ルールにのみ適用されます。
  • タイトル: Condition
    読取り専用: true
    最大長: 1000
    事前定義済ルールの条件名。 ハイブリッド・ルールにのみ適用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ルールを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    ルールが作成された日付。
  • タイトル: Delete
    読取り専用: true
    ルールを削除できるかどうかを示します。
  • タイトル: Rule Description
    最大長: 255
    ルールの説明。
  • タイトル: Last Updated Date
    読取り専用: true
    ルールが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    ルールを最後に更新したユーザー。
  • Links
  • タイトル: Matching Type
    最大長: 30
    条件の一致タイプ(OR/AND)。
  • タイトル: Object
    最大長: 75
    このルールを作成する必要があるオブジェクト名。
  • タイトル: Object Code
    読取り専用: true
    最大長: 75
    このルールを作成する必要があるオブジェクト・コード。
  • タイトル: Predefined
    最大長: 1
    デフォルト値: false
    ルールがシード済かユーザー定義かを示します。
  • タイトル: Rule ID
    ルールの一意の識別子。
  • タイトル: Rule Name
    最大長: 200
    ルールの表示名。
  • タイトル: Rule Number
    最大長: 30
    ルールのルール番号。 ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。
  • タイトル: Update
    読取り専用: true
    ルールを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ・ルール候補
タイプ: array
タイトル: Access Group Rule Candidates
アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。
ソースを表示
ネストされたスキーマ : アクセス・グループ・ルール条件
タイプ: array
タイトル: Access Group Rule Conditions
アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。
ソースを表示
ネストされたスキーマ : 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
    候補者を更新できるかどうかを示します。
ネストされたスキーマ : accessGroupRules-AccessGroupCondition-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    グループ条件を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    グループ条件が作成された日付。
  • タイトル: Delete
    読取り専用: true
    グループ条件を削除できるかどうかを示します。
  • タイトル: Last Updated Date
    読取り専用: true
    グループ条件が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    グループ条件を最後に更新したユーザー。
  • Links
  • タイトル: Object
    最大長: 64
    ルール条件の作成が必要なオブジェクト。
  • タイトル: Object Attribute Code
    最大長: 80
    ルール条件の作成が必要な属性。
  • タイトル: Object Attribute Name
    読取り専用: true
    条件の作成が必要なオブジェクト属性の表示名。
  • タイトル: Object Code
    読取り専用: true
    最大長: 75
    ルール条件の作成が必要なオブジェクト・コード。
  • タイトル: Operator
    最大長: 20
    属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。 既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。
  • タイトル: Rule Condition Number
    最大長: 30
    ルール条件番号。
  • タイトル: Rule Number
    読取り専用: true
    最大長: 30
    条件を作成する必要があるルール番号。
  • タイトル: Update
    読取り専用: true
    グループ条件を更新できるかどうかを示します。
  • タイトル: Value
    最大長: 255
    条件の値。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "RuleName": "Opportunity Partner",
    "RuleNumber": "OpportunityPR13",
    "Description": "Predefined rule for access to all opportunities associated with a partner organization.",
    "ActiveFlag": false,
    "MatchingType": "AND",
    "CreationDate": "2021-03-11T18:27:30.831+00:00",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateDate": "2021-06-10T09:44:33.181+00:00",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "RuleId": 100100334622303,
    "ObjectCode": "ORA_Opportunity",
    "PredefinedFlag": true,
    "ConditionCode": "OPTYANYPARTNERORG",
    "ConditionName": "Opportunities associated with a partner organization",
    "Object": "Opportunity",
    "UpdateFlag": "true",
    "DeleteFlag": "false",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13",
            "name": "accessGroupRules",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13",
            "name": "accessGroupRules",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCandidate",
            "name": "AccessGroupCandidate",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCondition",
            "name": "AccessGroupCondition",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/action/isRulePublished",
            "name": "isRulePublished",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/action/publishRule",
            "name": "publishRule",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/action/deleteAndPublishRule",
            "name": "deleteAndPublishRule",
            "kind": "other"
        }
    ]
}
「トップに戻る」