すべてのアクセス・グループ拡張ルールの取得
get
/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ACC_EXT_RULES_AK : 指定されたアクセス・グループ拡張ルール番号を持つアクセス・グループ拡張ルールを検索します。
ファインダ変数:- AccExtRuleNumber; string; アクセス・グループ拡張ルールの一意の代替識別子。
- PrimaryKey : 指定された主キーを持つアクセス・グループ拡張ルールを検索します。
ファインダ変数:- AccExtRuleId; integer; アクセス・グループ拡張ルールの一意の識別子。
- ACC_EXT_RULES_AK : 指定されたアクセス・グループ拡張ルール番号を持つアクセス・グループ拡張ルールを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccExtRuleId; integer; アクセス拡張ルールの一意の識別子。
- AccExtRuleNumber; string; アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。
- ActiveFlag; boolean。アクセス拡張ルールがアクティブかどうかを示します。
- CreatedBy; string; アクセス拡張ルールを作成したユーザー。
- CreationDate; string; アクセス拡張ルールが作成された日付。
- DeleteFlag; boolean;レコードを削除できるかどうかを示します。
- 説明;文字列;アクセス拡張ルールの説明。
- ExtendAllRulesFlag; boolean;ソース・オブジェクトからターゲット・オブジェクトに拡張するルールを識別するために使用されるメソッドを示します。
- LastUpdateDate; string; アクセス拡張ルールが最後に更新された日付。
- LastUpdateLogin; string;アクセス拡張ルールを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; アクセス拡張ルールを最後に更新したユーザー。
- 名前、文字列。アクセス拡張ルールの名前。
- PredefinedFlag; boolean。アクセス拡張ルールが事前定義されているかどうかを示します。
- RelationshipDisplayName; string;ソース・オブジェクトとターゲット・オブジェクト間の関係の表示名。
- RelationshipId; integer; ソース・オブジェクトとターゲット・オブジェクト間の関係の一意の識別子。
- RelationshipName; string;ソース・オブジェクトとターゲット・オブジェクト間の関係の名前。
- RelationshipTypeCode; string; ソース・オブジェクトとターゲット・オブジェクト間の関係のタイプ。
- SourceObjectCode; string; アクセス拡張ルールで使用されるソース・オブジェクトのコード。
- SourceObjectName; string; アクセス拡張ルールで使用されるソース・オブジェクトの名前。
- TargetObjectCode; string; アクセス拡張ルールで使用されるターゲット・オブジェクトのコード。
- TargetObjectName; string; アクセス拡張ルールで使用されるターゲット・オブジェクトの名前。
- UpdateFlag; boolean;レコードを更新できるかどうかを示します。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : accessGroupExtensionRules
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : accessGroupExtensionRules-item-response
タイプ:
ソースを表示
object-
accessGroupExtensionRuleDetails: array Access Group Extension Rule Details
タイトル:
Access Group Extension Rule Detailsアクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。 -
AccExtRuleId: integer (int64)
タイトル:
Access Extension Rule IDアクセス拡張ルールの一意の識別子。 -
AccExtRuleNumber: string
タイトル:
Access Extension Rule Number最大長:30アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。 -
ActiveFlag: boolean
タイトル:
Active最大長:1デフォルト値:trueアクセス拡張ルールがアクティブかどうかを示します。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64アクセス拡張ルールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueアクセス拡張ルールが作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete読取り専用:trueレコードを削除できるかどうかを示します。 -
Description: string
タイトル:
Description最大長:255アクセス拡張ルールの説明。 -
ExtendAllRulesFlag: boolean
タイトル:
Extend All Rules Indicator最大長:1デフォルト値:trueソース・オブジェクトからターゲット・オブジェクトに拡張するルールを識別するために使用するメソッドを示します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date読取り専用:trueアクセス拡張ルールが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64アクセス拡張ルールを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32アクセス拡張ルールを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name最大長:200アクセス拡張ルールの名前。 -
PredefinedFlag: boolean
タイトル:
Predefined Indicator読取り専用:true最大長:255アクセス拡張ルールが事前定義されているかどうかを示します。 -
RelationshipDisplayName: string
タイトル:
Relationship Display Name読取り専用:trueソース・オブジェクトとターゲット・オブジェクト間の関係の表示名。 -
RelationshipId: integer (int64)
タイトル:
Related Objectソース・オブジェクトとターゲット・オブジェクト間の関係の一意の識別子。 -
RelationshipName: string
タイトル:
Relationship Nameソース・オブジェクトとターゲット・オブジェクト間の関係の名前。 -
RelationshipTypeCode: string
タイトル:
Relationship Type Codeソース・オブジェクトとターゲット・オブジェクト間の関係のタイプ。 -
SourceObjectCode: string
タイトル:
Source Object Code読取り専用:trueアクセス拡張ルールで使用されるソース・オブジェクトのコード。 -
SourceObjectName: string
タイトル:
Source Object Name読取り専用:trueアクセス拡張ルールで使用されるソース・オブジェクトの名前。 -
TargetObjectCode: string
タイトル:
Target Object Code読取り専用:trueアクセス拡張ルールで使用されるターゲット・オブジェクトのコード。 -
TargetObjectName: string
タイトル:
Target Object Name読取り専用:trueアクセス拡張ルールで使用されるターゲット・オブジェクトの名前。 -
UpdateFlag: boolean
タイトル:
Update読取り専用:trueレコードを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ拡張ルール詳細
タイプ:
arrayタイトル:
Access Group Extension Rule Detailsアクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。
ソースを表示
ネストされたスキーマ : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response
タイプ:
ソースを表示
object-
AccessGroupNumber: string
タイトル:
Group Numberソース・オブジェクトのルールに関連付けられているアクセス・グループの代替キー識別子。 -
AccExtRuleDetailId: integer (int64)
タイトル:
Access Extension Rule Detail IDアクセス拡張ルール詳細の一意の識別子。 -
AccExtRuleId: integer (int64)
タイトル:
Access Extension Rule IDアクセス拡張ルールの一意の識別子。 -
AccExtRuleNumber: string
タイトル:
Access Extension Rule Number読取り専用:true最大長:30アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64アクセス拡張ルールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueアクセス拡張ルールが作成された日付。 -
DeleteAccessPermissionFlag: boolean
タイトル:
Delete Access Permission Indicator最大長:1デフォルト値:false削除アクセス権が付与されているかどうかを示します。 -
DeleteFlag: boolean
タイトル:
Delete読取り専用:trueレコードを削除できるかどうかを示します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date読取り専用:trueアクセス拡張ルールが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64アクセス拡張ルールを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32アクセス拡張ルールを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
ReadAccessPermissionFlag: boolean
タイトル:
Read Access Permission Indicator最大長:1デフォルト値:false読取りアクセス権が付与されているかどうかを示します。 -
SrcObjAccessGroupId: integer (int64)
タイトル:
Source Object Access Group IDソース・オブジェクトのルールに関連付けられているアクセス・グループの一意の識別子。 -
SrcObjectRuleGuid: string
タイトル:
Source Object Rule GUID最大長:64ソース・オブジェクトのルールの一意の識別子。 -
SrcObjectRuleNumber: string
タイトル:
Source Object Rule Numberソース・オブジェクトのルールの代替キー識別子。 -
UpdateAccessPermissionFlag: boolean
タイトル:
Update Access Permission Indicator最大長:1デフォルト値:false更新アクセス権が付与されているかどうかを示します。 -
UpdateFlag: boolean
タイトル:
Update読取り専用:trueレコードを更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行することによって、すべてのアクセス・グループ拡張ルールを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accessGroupExtensionRules
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"items": [
{
"AccExtRuleId": 1,
"ActiveFlag": false,
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2020-09-10T18:27:45.082+00:00",
"Description": "Predefined rule for contacts of related account team.",
"ExtendAllRulesFlag": false,
"LastUpdateDate": "2021-06-10T09:44:00.456+00:00",
"LastUpdateLogin": "-1",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"Name": "Contacts of Related Account Team",
"RelationshipId": 100100216995688,
"AccExtRuleNumber": "AccountContactRule1",
"PredefinedFlag": true,
"RelationshipName": "AccountToContact",
"RelationshipDisplayName": "Account to Contact (Standard)",
"SourceObjectCode": "Account",
"TargetObjectCode": "Contact",
"UpdateFlag": true,
"DeleteFlag": false,
"SourceObjectName": "Account",
"TargetObjectName": "Contact",
"RelationshipTypeCode": "STANDARD",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/AccountContactRule1",
"name": "accessGroupExtensionRules",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
.....
],
}
]
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules",
"name": "accessGroupExtensionRules",
"kind": "collection"
}
]
}