Skip to main content

FunctionGroup

Function Groups allow the categorizing of functions into logical groups. Creating Function Groups for similar functions makes searching and reporting easier. Note that this is not related to group registrations for functions.

For example, Function Groups may exist for:

Inclusive Functions
Optional Activities
Tours and Dinners
Educational Classes

type FunctionGroup {
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  name: String!
  uniqueCode: String
}

Fields

`FunctionGroup.createdAt` ● `DateTime!` non-null scalar

The date and time the record was created.

`FunctionGroup.createdBy` ● `String` scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

`FunctionGroup.customFields` ● `[CustomField!]!` non-null object

A list of custom field values associated with this function group.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

offset must be a non-negative integer (defaults to 0).
limit must be a positive integer from 1 to 2000 (defaults to 100).

`FunctionGroup.customFields.input` ● `CustomFieldSearchFilterInput!` non-null input

`FunctionGroup.customFields.limit` ● `PaginationLimit!` non-null scalar

`FunctionGroup.customFields.offset` ● `NonNegativeInt!` non-null scalar

`FunctionGroup.id` ● `ID!` non-null scalar

The unique identifier for a function group.

`FunctionGroup.lastModifiedAt` ● `DateTime!` non-null scalar

The date and time the record was last modified.

`FunctionGroup.lastModifiedBy` ● `String` scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

`FunctionGroup.name` ● `String!` non-null scalar

UTF-8 string value that represents the name of the function group.

`FunctionGroup.uniqueCode` ● `String` scalar

A customer supplied, UTF-8 string value that represents a unique code for the function group. Optional.

The value must be unique across all function groups for a tenant.

Member Of

CeContactStoreFunction object ● CeContactStoreFunctionSetup object ● CreateFunctionGroupPayload object ● Function object ● FunctionEventAgendaItem object ● FunctionSetup object ● MembershipContactStoreFunction object ● MembershipContactStoreFunctionSetup object ● UpdateFunctionGroupPayload object

Fields
Member Of