すべてのアクセス・グループ条件の取得
get
/crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition
リクエスト
パス・パラメータ
- RuleNumber(required): string
ルールのルール番号。 ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定された主キーを持つアクセス・グループ条件を検索します。
ファインダ変数: - RowFinder : 条件番号を持つアクセス・グループ条件を検索します。
ファインダ変数:- RuleConditionNumber; string;グループ条件のルール条件番号。
- PrimaryKey : 指定された主キーを持つアクセス・グループ条件を検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; グループ条件を作成したユーザー。
- CreationDate; string;グループ条件が作成された日付。
- LastUpdateDate; string; グループ条件が最後に更新された日付。
- LastUpdatedBy; string; グループ条件を最後に更新したユーザー。
- オブジェクト;文字列;ルール条件を作成する必要があるオブジェクト。
- ObjectAttributeCode; string;ルール条件を作成する必要がある属性。
- ObjectAttributeName; string;条件を作成する必要があるオブジェクト属性の表示名。
- ObjectCode; string;ルール条件を作成する必要があるオブジェクト・コード。
- 演算子、文字列。属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。 既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。
- RuleConditionNumber; 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-AccessGroupCondition
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : 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
条件の値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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/accessGroupRules/{RuleNumber}/child/AccessGroupCondition
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "items": [ { "AccessGroupId": 300100546570570, "AccessGroupNumber": "CDRM_37027", "ActiveFlag": true, "CreatedBy": "IT_SECURITY_MANAGER", "CreationDate": "2021-08-07T09:47:55+00:00", "Description": "CreateAccessGroupMemberTest for mow Description", "LastUpdateDate": "2021-08-07T09:47:55.014+00:00", "LastUpdateLogin": "C8EB47ABFB5ED916E0533BFDF40A0928", "LastUpdatedBy": "IT_SECURITY_MANAGER", "Name": "AutoAGUImow2021-08-07 09:47:55", "TypeCode": "ORA_ZCA_CUSTOM", "UpdateFlag": true, "DeleteFlag": true, "TypeCodeMeaning": "Custom group", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_37027", "name": "accessGroups", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_37027", "name": "accessGroups", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_37027/lov/ActiveFlagLookupVO", "name": "ActiveFlagLookupVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_37027/lov/LookupPVOForGroupType", "name": "LookupPVOForGroupType", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_37027/child/AccessGroupMembers", "name": "AccessGroupMembers", "kind": "collection" } ] }, ..... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups", "name": "accessGroups", "kind": "collection" } ] }