すべてのフィールド・グループの取得
get
/crmRestApi/resources/11.13.18.05/fieldGroups
リクエスト
問合せパラメータ
- 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
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- FieldGroupAltKeyその代替キーを使用してフィールド・グループを検索します。
ファインダ変数- FieldGroupNumber; string;フィールド・グループの公開一意識別子。
- FieldGroupByNumber公開一意識別子を使用してフィールド・グループを検索します。
ファインダ変数- FieldGroupNumber; string;フィールド・グループの公開一意識別子。
- PrimaryKey主キーを使用してフィールド・グループを検索します。
ファインダ変数- FieldGroupId; integer;フィールド・グループの一意の識別子。
- FieldGroupAltKeyその代替キーを使用してフィールド・グループを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AllFieldsFlag; boolean。フィールド・グループに、関連付けられたオブジェクトのすべてのフィールドが含まれていることを示します。
- CreatedBy; string;レコードを作成したユーザー。
- CreationDate; string;レコードの作成日。
- Description; string;フィールド・グループの説明。
- EnabledFlag; boolean;フィールド・グループが有効かどうかを示します。
- FieldGroupId; integer;フィールド・グループの一意の識別子。
- FieldGroupName; string;フィールド・グループの名前。
- FieldGroupNumber; string;フィールド・グループの公開一意識別子。
- LastUpdateDate; string; レコードの最終更新日。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- ObjectType; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : fieldGroups
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : fieldGroups-item-response
タイプ:
ソースを表示
object
-
AllFieldsFlag: boolean
タイトル:
All Fields
最大長:1
デフォルト値:false
フィールド・グループに、関連付けられたオブジェクトのすべてのフィールドが含まれていることを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードの作成日。 -
Description: string
タイトル:
Description
最大長:1000
フィールド・グループの摘要。 -
EnabledFlag: boolean
タイトル:
Enabled
最大長:1
デフォルト値:false
フィールド・グループが使用可能かどうかを示します。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
読取り専用:true
フィールド・グループの一意の識別子。 -
FieldGroupName: string
タイトル:
Field Group Name
最大長:100
フィールド・グループの名前。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
fields: array Field Group Fields
タイトル:
Field Group Fields
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードの最終更新日。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectType: string
タイトル:
Object Type
最大長:128
フィールド・グループに関連付けられたビジネス・オブジェクト・タイプ。 -
permissions: array Field Group Permissions
タイトル:
Field Group Permissions
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。
ネストされたスキーマ : フィールド・グループのフィールド
タイプ:
array
タイトル:
Field Group Fields
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。
ソースを表示
ネストされたスキーマ : フィールド・グループ権限
タイプ:
array
タイトル:
Field Group Permissions
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。
ソースを表示
ネストされたスキーマ : fieldGroups-fields-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードの作成日。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
フィールド・グループの一意の識別子。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
FieldId: integer (int64)
タイトル:
Field ID
読取り専用:true
フィールド・グループ・フィールドの一意の識別子。 -
FieldName: string
タイトル:
Field Name
最大長:100
フィールド・グループの一部であるフィールドの名前。 -
FieldNumber: string
タイトル:
Field Number
最大長:64
フィールド・グループ・フィールドの公開一意識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードの最終更新日。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : fieldGroups-permissions-item-response
タイプ:
ソースを表示
object
-
AccessGroupId: integer (int64)
タイトル:
Access Group ID
アクセス・グループの一意の識別子。 -
AccessGroupNumber: string
最大長:
4000
アクセス・グループの公開一意識別子。 -
AccessLevelCd: string
タイトル:
Access Level
最大長:30
デフォルト値:ORA_SVC_FS_READ
ORA_SVC_FS_READやORA_SVC_FS_UPDATEなど、アクセス・グループ・メンバーがフィールドに対して持つアクセス・レベルを示すコード。 -
AccessLevelCdMeaning: string
タイトル:
Access Level Value
読取り専用:true
最大長:255
アクセス・グループ・メンバーがフィールドに対して持つアクセス・レベル(読取り、更新など)。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードの作成日。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
フィールド・グループの一意の識別子。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードの最終更新日。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PermissionId: integer (int64)
タイトル:
Permission ID
読取り専用:true
フィールド・グループ権限の一意の識別子。 -
PermissionNumber: string
タイトル:
Permission Number
最大長:64
フィールド・グループ権限の公開一意識別子。
リンク
- publishFieldSecurityMetadata
-
このメソッドでは、フィールド・セキュリティ・メタデータを公開してキャッシュできます。