Get all field groups
get
/crmRestApi/resources/11.13.18.05/fieldGroups
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- FieldGroupAltKey Finds a field group using its alternate key.
Finder Variables- FieldGroupNumber; string; The public unique identifier of the field group.
- FieldGroupByNumber Find a field group using its public unique identifier.
Finder Variables- FieldGroupNumber; string; The public unique identifier of the field group.
- PrimaryKey Finds a field group using its primary key.
Finder Variables- FieldGroupId; integer; The unique identifier of the field group.
- FieldGroupAltKey Finds a field group using its alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AllFieldsFlag; boolean; Indicates that the field group includes all the fields of the associated object.
- CreatedBy; string; The person who created the record.
- CreationDate; string; The creation date of the record.
- Description; string; The description of the field group.
- EnabledFlag; boolean; Indicates if the field group is enabled.
- FieldGroupId; integer; The unique identifier of the field group.
- FieldGroupName; string; The name of the field group.
- FieldGroupNumber; string; The public unique identifier of the field group.
- LastUpdateDate; string; The last updated date of the record.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The person who last updated the record.
- ObjectType; string; The business object type associated with the field group.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : fieldGroups
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fieldGroups-item-response
Type:
Show Source
object
-
AllFieldsFlag: boolean
Title:
All Fields
Maximum Length:1
Default Value:false
Indicates that the field group includes all the fields of the associated object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The creation date of the record. -
Description: string
Title:
Description
Maximum Length:1000
The description of the field group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Indicates if the field group is enabled. -
FieldGroupId: integer
(int64)
Title:
Field Group ID
Read Only:true
The unique identifier of the field group. -
FieldGroupName: string
Title:
Field Group Name
Maximum Length:100
The name of the field group. -
FieldGroupNumber: string
Title:
Field Group Number
Maximum Length:64
The public unique identifier of the field group. -
fields: array
Field Group Fields
Title:
Field Group Fields
The field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The last updated date of the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectType: string
Title:
Object Type
Maximum Length:128
The business object type associated with the field group. -
permissions: array
Field Group Permissions
Title:
Field Group Permissions
The field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.
Nested Schema : Field Group Fields
Type:
array
Title:
Field Group Fields
The field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Field Group Permissions
Type:
array
Title:
Field Group Permissions
The field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.
Show Source
Nested Schema : fieldGroups-fields-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The creation date of the record. -
FieldGroupId: integer
(int64)
Title:
Field Group ID
The unique identifier of the field group. -
FieldGroupNumber: string
Title:
Field Group Number
Maximum Length:64
The public unique identifier of the field group. -
FieldId: integer
(int64)
Title:
Field ID
Read Only:true
The unique identifier of the field group field. -
FieldName: string
Title:
Field Name
Maximum Length:100
The name of the field that's part of the field group. -
FieldNumber: string
Title:
Field Number
Maximum Length:64
The public unique identifier of the field group field. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The last updated date of the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : fieldGroups-permissions-item-response
Type:
Show Source
object
-
AccessGroupId: integer
(int64)
Title:
Access Group ID
The unique identifier of the access group. -
AccessGroupNumber: string
Maximum Length:
4000
The public unique identifier of the access group. -
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
Default Value:ORA_SVC_FS_READ
The code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE. -
AccessLevelCdMeaning: string
Title:
Access Level Value
Read Only:true
Maximum Length:255
The level of access that the access group members have to the field such as, Read, Update. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The creation date of the record. -
FieldGroupId: integer
(int64)
Title:
Field Group ID
The unique identifier of the field group. -
FieldGroupNumber: string
Title:
Field Group Number
Maximum Length:64
The public unique identifier of the field group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The last updated date of the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PermissionId: integer
(int64)
Title:
Permission ID
Read Only:true
The unique identifier of the field group permission. -
PermissionNumber: string
Title:
Permission Number
Maximum Length:64
The public unique identifier of the field group permission.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- publishFieldSecurityMetadata
-
This method lets you publish and cache the field security meta data.