1. SuiteCloud Platform
  2. SuiteTalk Web Services
  3. SuiteTalk SOAP Web Services Records Guide
  4. Entities
  5. Group (Entity Group)

Group (Entity Group)

The group record is defined in listRel (relationships) XSD.

Specify the group type (contact, customer, employee, partner, or vendor) by setting the type element on an add operation. Note that the group record cannot be customized. Also note that in NetSuite, groups can be dynamic or static. To create a dynamic group, on the group record you must set the group type to dynamic. You can then reference a saved search when adding the group record. The members will change based on the results of the saved search. To create a static group, first add the group record to NetSuite. Then use the attach operation to associate members with it. For more information and for examples of using the attach operation, see attach / detach.

For information about working with groups in the UI, and about adding and removing members, see Working with Groups.

Supported Operations

The following operations can be used with the group record.

add | addList | attach / detach | delete | deleteList | get | getList | getSavedSearch | getSelectValue | search | update | updateList | upsert | upsertList

Note:

You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.

Field Definitions

The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s entity group reference page.

Note:

For information about using the SOAP Schema Browser, see SOAP Schema Browser.

Usage Notes

When searching for members of a dynamic group, you must use the GroupMemberSearchBasic search interface; you cannot use the group's corresponding entity search. The GroupMemberSearch interface retrieves members of a dynamic group by referencing the groupId.

GroupMemberSearchBasic

Field Name

Type

groupId

platformCore:RecordRef

Field Name

Type

groupId

platformCore:SearchMultiSelectField

The following code snippet shows GroupMemberSearchBasic in a SOAP request.

SOAP Request
          <soapenv:Body>
   <search xmlns="urn:messages_2017_1.platform.webservices.netsuite.com">
      <searchRecord xsi:type="ns7:GroupMemberSearchBasic" xmlns:ns7="urn:common_2017_1.platform.webservices.netsuite.com">
         <ns7:groupId internalId="163" xsi:type="ns8:RecordRef" xmlns:ns8="urn:core_2017_1.platform.webservices.netsuite.com"/>
      </searchRecord>
   </search>
</soapenv:Body>

If the entity group is not dynamic, you can use the standard EntityGroupSearch interface to execute a search against the group.

Related Topics

General Notices