Get all field groups

get

/crmRestApi/resources/11.13.18.05/fieldGroups

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : fieldGroups
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : fieldGroups-item-response
Type: object
Show Source
  • Title: All Fields
    Maximum Length: 1
    Default Value: false
    Indicates that the field group includes all the fields of the associated object.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The person who created the record.
  • Title: Creation Date
    Read Only: true
    The creation date of the record.
  • Title: Description
    Maximum Length: 1000
    The description of the field group.
  • Title: Enabled
    Maximum Length: 1
    Default Value: false
    Indicates if the field group is enabled.
  • Title: Field Group ID
    Read Only: true
    The unique identifier of the field group.
  • Title: Field Group Name
    Maximum Length: 100
    The name of the field group.
  • Title: Field Group Number
    Maximum Length: 64
    The public unique identifier of the field group.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The last updated date of the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The person who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Object Type
    Maximum Length: 128
    The business object type associated with the field group.
  • 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 : 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: object
Show Source
Nested Schema : fieldGroups-permissions-item-response
Type: object
Show Source
Back to Top