Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

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

get

/crmRestApi/resources/11.13.18.05/accessGroupRules

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します:
- AltKey : 代替キーを含むアクセス・グループ・ルールを検索します。
  ファインダ変数:
  - RuleName; string;ルールの表示名。
- PrimaryKey : 指定された主キーを持つアクセス・グループを検索します。
  ファインダ変数:
  - RuleId; integer; ルールの一意の識別子。
- RowFinder : ルール番号を持つアクセス・グループ・ルールを検索します。
  ファインダ変数:
  - RuleNumber; string;ルール番号は一意の英数字文字列です。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActiveFlag; boolean。アクセス・グループ・ルールがアクティブかどうかを示します。
- ConditionCode; string; 事前定義済ルールのコード。ハイブリッド・ルールにのみ適用されます。
- ConditionName; string;事前定義済ルールの条件名。ハイブリッド・ルールにのみ適用されます。
- CreatedBy; string; ルールを作成したユーザー。
- CreationDate; string;ルールが作成された日付。
- 説明;文字列;ルールの説明。
- LastUpdateDate; string; ルールが最後に更新された日付。
- LastUpdatedBy; string; ルールを最後に更新したユーザー。
- MatchingType; string; 条件の一致タイプ(OR/AND)。
- オブジェクト;文字列;このルールを作成する必要があるオブジェクト名。
- ObjectCode; string; このルールを作成する必要があるオブジェクト・コード。
- PredefinedFlag; boolean。ルールがシードされているかユーザー定義されているかを示します。
- RuleId; integer; ルールの一意の識別子。
- RuleName; string;ルールの表示名。
- RuleNumber; string;ルールのルール番号。ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : accessGroupRules

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object accessGroupRules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : accessGroupRules-item-response

タイプ: object

ソースを表示

AccessGroupCandidate: array Access Group Rule Candidates

タイトル: Access Group Rule Candidates

アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。ルールに関連付けられたアクセス・グループ・レコードを提供します。
AccessGroupCondition: array Access Group Rule Conditions

タイトル: Access Group Rule Conditions

アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。これらはルールに関連付けられた条件です。
ActiveFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: false

アクセス・グループ・ルールがアクティブかどうかを示します。
ConditionCode: string

タイトル: Condition Code

最大長: 240

事前定義済ルールのコード。ハイブリッド・ルールにのみ適用されます。
ConditionName: string

タイトル: Condition

読取り専用: true

最大長: 1000

事前定義済ルールの条件名。ハイブリッド・ルールにのみ適用されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

ルールを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

ルールが作成された日付。
DeleteFlag: boolean

タイトル: Delete

読取り専用: true

ルールを削除できるかどうかを示します。
Description: string

タイトル: Rule Description

最大長: 255

ルールの説明。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

ルールが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

ルールを最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MatchingType: string

タイトル: Matching Type

最大長: 30

条件の一致タイプ(OR/AND)。
Object: string

タイトル: Object

最大長: 75

このルールを作成する必要があるオブジェクト名。
ObjectCode: string

タイトル: Object Code

読取り専用: true

最大長: 75

このルールを作成する必要があるオブジェクト・コード。
PredefinedFlag: boolean

タイトル: Predefined

最大長: 1

デフォルト値: false

ルールがシード済かユーザー定義かを示します。
RuleId: integer (int64)

タイトル: Rule ID

ルールの一意の識別子。
RuleName: string

タイトル: Rule Name

最大長: 200

ルールの表示名。
RuleNumber: string

タイトル: Rule Number

最大長: 30

ルールのルール番号。ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。
UpdateFlag: boolean

タイトル: Update

読取り専用: true

ルールを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Rule Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is seeded or user defined.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AccessGroupCondition":{
            "title":"Access Group Rule Conditions",
            "type":"array",
            "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-response"
            }
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccessGroupCandidate":{
            "title":"Access Group Rule Candidates",
            "type":"array",
            "description":"The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-response"
            }
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":75,
            "type":"string",
            "description":"The object code for which this rule needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The condition name for the predefined rules. It is applicable only for Hybrid rules.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the access group rule is active.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the rule can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConditionCode":{
            "title":"Condition Code",
            "maxLength":240,
            "type":"string",
            "description":"The code for predefined rules. It is applicable only for Hybrid rules.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the rule can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchingType":{
            "title":"Matching Type",
            "maxLength":30,
            "type":"string",
            "description":"The matching type for the conditions (OR/AND).",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number of the rule. The user can either provide this value or the system generated number.",
            "nullable":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":75,
            "type":"string",
            "description":"The object name for which this rule needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":200,
            "type":"string",
            "description":"The display name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アクセス・グループ・ルール候補

タイプ: array

タイトル: Access Group Rule Candidates

アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。ルールに関連付けられたアクセス・グループ・レコードを提供します。

ソースを表示

Array of: object accessGroupRules-AccessGroupCandidate-item-response

{
    "title":"Access Group Rule Candidates",
    "type":"array",
    "description":"The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-response"
    }
}

ネストされたスキーマ : アクセス・グループ・ルール条件

タイプ: array

タイトル: Access Group Rule Conditions

アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。これらはルールに関連付けられた条件です。

ソースを表示

Array of: object accessGroupRules-AccessGroupCondition-item-response

{
    "title":"Access Group Rule Conditions",
    "type":"array",
    "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : accessGroupRules-AccessGroupCandidate-item-response

タイプ: object

ソースを表示

AccessGroupName: string

タイトル: Access Group Name

読取り専用: true

最大長: 4000

アクセス・グループ候補の名前。
AccessGroupNumber: string

タイトル: Access Group Number

読取り専用: true

最大長: 4000

このルールに関連付けられているアクセス・グループ番号。
AccessLevel: string

タイトル: Access Level

最大長: 255

デフォルト値: READ

ルールに関連付けられたアクセス・レベル。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

グループ候補を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

グループ候補者が作成された日付。
DeleteFlag: boolean

タイトル: Delete

読取り専用: true

候補者を削除できるかどうかを示します。
EnableFlag: boolean

タイトル: Enable

最大長: 1

アクセス・グループの候補者がこのルールに対して使用可能かどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

グループ候補者が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

グループ候補を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PredefinedFlag: boolean

タイトル: Predefined

読取り専用: true

アクセス・グループ候補がシードされているかどうかを示します。
RuleCandidateId: integer (int64)

タイトル: Rule Candidate ID

ルール候補の一意の識別子。
RuleCandidateNumber: string

タイトル: Rule Candidate Number

最大長: 30

アクセス・グループ・ルール候補の内部番号。
RuleNumber: string

タイトル: Rule Number

読取り専用: true

最大長: 30

このアクセス・グループ候補が属するルール番号。
UpdateFlag: boolean

タイトル: Update

読取り専用: true

候補者を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group candidate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "type":"boolean",
            "description":"Indicates whether the Access Group Candidate is seeded or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessGroupName":{
            "title":"Access Group Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the Access Group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleCandidateId":{
            "title":"Rule Candidate ID",
            "type":"integer",
            "description":"The unique identifier of the rule candidate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnableFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Access Group candidate is enabled for this rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the candidate can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevel":{
            "title":"Access Level",
            "maxLength":255,
            "type":"string",
            "description":"The access level associated with the rule.",
            "nullable":true,
            "default":"READ",
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the candidate can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RuleCandidateNumber":{
            "title":"Rule Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"The internal number for Access Group Rule Candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Access Group Number",
            "maxLength":4000,
            "type":"string",
            "description":"The access group number associated with this rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number for which this Access Group candidate belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group candidate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : accessGroupRules-AccessGroupCondition-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

グループ条件を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

グループ条件が作成された日付。
DeleteFlag: boolean

タイトル: Delete

読取り専用: true

グループ条件を削除できるかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

グループ条件が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

グループ条件を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Object: string

タイトル: Object

最大長: 64

ルール条件の作成が必要なオブジェクト。
ObjectAttributeCode: string

タイトル: Object Attribute Code

最大長: 80

ルール条件の作成が必要な属性。
ObjectAttributeName: string

タイトル: Object Attribute Name

読取り専用: true

条件の作成が必要なオブジェクト属性の表示名。
ObjectCode: string

タイトル: Object Code

読取り専用: true

最大長: 75

ルール条件の作成が必要なオブジェクト・コード。
Operator: string

タイトル: Operator

最大長: 20

属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。
RuleConditionNumber: string

タイトル: Rule Condition Number

最大長: 30

ルール条件番号。
RuleNumber: string

タイトル: Rule Number

読取り専用: true

最大長: 30

条件を作成する必要があるルール番号。
UpdateFlag: boolean

タイトル: Update

読取り専用: true

グループ条件を更新できるかどうかを示します。
Value: string

タイトル: Value

最大長: 255

条件の値。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":20,
            "type":"string",
            "description":"The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributeCode":{
            "title":"Object Attribute Code",
            "maxLength":80,
            "type":"string",
            "description":"The attribute for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":75,
            "type":"string",
            "description":"The object code for which rule condition needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributeName":{
            "title":"Object Attribute Name",
            "type":"string",
            "description":"The object attribute display name for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the group condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the group condition can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value of condition.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleConditionNumber":{
            "title":"Rule Condition Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule condition number.",
            "nullable":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":64,
            "type":"string",
            "description":"The object for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group condition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

getGlobalPublishRequestStatus: 操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/action/getGlobalPublishRequestStatus

この操作は、管理者がESSリクエストIDに基づいてグローバル公開のステータスを確認するのに役立ちます。
submitGlobalPublishRequest: 操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/action/submitGlobalPublishRequest

プロファイル・オプションに基づいて、ルールはMRAまたはOBRエンジンに公開されます。

トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "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://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13",
                    "name": "accessGroupRules",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13",
                    "name": "accessGroupRules",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCandidate",
                    "name": "AccessGroupCandidate",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCondition",
                    "name": "AccessGroupCondition",
                    "kind": "collection"
                },
...
}

「トップに戻る」