1. SuiteCloud Platform
  2. SuiteTalk Web Services
  3. SuiteTalk REST Web Services Records Guide
  4. REST Web Services Supported Records
  5. Entity Group

Entity Group

The entity group record exposes an entity group to REST web services.

This record:

For more information about working with entity groups in the UI, see Working with Groups.

For information about using the REST API Browser, see The REST API Browser.

Record ID

The record ID for an entity group REST record is entitygroup.

Prerequisites

You must enable the Marketing Automation feature before you can use this record through REST web services. For more information, see Marketing Automation Overview.

To use all the fields of this record, you must enable the following features: Mail Merge, Team Selling, Customer Support and Service, Sales Force Automation, Issue Management, Manufacturing Routing and Work Center, Billing Operations, Subsidiaries, and Personalized Catalog Views.

Additional Details

Consider the following when working with the entity group record:

  • The following field isn't accessible through REST web services: dynamic.

  • The following fields aren't accessible through REST web services:

    • bulkMerge

    • campaign

  • Some behaviors differ depending on whether you're accessing the record through REST web services or in the UI, like:

    • The fields in the following UI tabs aren't exposed to REST:

      • Notes

      • Files

      • Events

      • Workflows

    • The groupMembers sublist is supported only by the Sales Team entity group.

    • The dynamic entity group can't be created with REST.

  • Not all fields can be populated at the same time. Each group type (for example: Employee, Customer, Vendor) supports different fields and may require different features. You can use the UI to see which fields are supported.

Code Samples

The following samples show common actions for a entity group.

POST Request

              POST /services/rest/record/v1/entitygroup HTTP/1.1
Host: 3619616.suitetalk.api.netsuite.com
Content-Type: application/json
Authorization: OAuth realm="3619616",oauth_consumer_key="",oauth_token="",oauth_signature_method="",oauth_timestamp="",oauth_nonce="",oauth_version="1.0",oauth_signature=""
Content-Length: 605
{
    "comments": "test comments",
    "email": "test@test.com",
    "groupName": "Test employee group",
    "groupOwner": {
        "id": "303"
    },
    "groupType": {
        "id": "Employee"
    },
    "isFunctionalTeam": true,
    "isInactive": false,
    "isManufacturingWorkCenter": false,
    "isPrivate": false,
    "isProductTeam": true,
    "issueRole": {
        "id": "1"
    },
    "isSupportRep": true,
    "testCell": {
        "items": [
            {
                "cellId": 1,
                "cellName": "Test cell",
                "cellPercent": 20
            }
        ]
    }
}

GET Request

              GET /services/rest/record/v1/entitygroup/1?expandSubResources=true HTTP/1.1
Host: 3619616.suitetalk.api.netsuite.com
Authorization: OAuth realm="3619616",oauth_consumer_key="",oauth_token="",oauth_signature_method="",oauth_timestamp="",oauth_nonce="",oauth_version="1.0",oauth_signature=""

PATCH Request

              PATCH /services/rest/record/v1/entitygroup/1 HTTP/1.1
Host: 3619616.suitetalk.api.netsuite.com
Content-Type: application/json
Authorization: OAuth realm="3619616",oauth_consumer_key="",oauth_token="",oauth_signature_method="",oauth_timestamp="",oauth_nonce="",oauth_version="1.0",oauth_signature=""
Content-Length: 656
{
    "comments": "test comments updated",
    "email": "test2@test.com",
    "groupName": "Test employee group updated",
    "groupOwner": {
        "id": "303"
    },
    "groupType": {
        "id": "Employee"
    },
    "isFunctionalTeam": false,
    "isInactive": false,
    "isManufacturingWorkCenter": true,
    "isPrivate": false,
    "isProductTeam": false,
    "isSupportRep": false,
    "laborResources": 20.1,
    "machineResources": 10.2,
    "subsidiary": {
        "id": "1"
    },
    "testCell": {
        "items": [
            {
                "cellName": "Test cell 2",
                "cellPercent": 30
            }
        ]
    }
}

DELETE Request

              DELETE /services/rest/record/v1/entitygroup/1 HTTP/1.1
Host: 3619616.suitetalk.api.netsuite.com
Authorization: OAuth realm="3619616",oauth_consumer_key="",oauth_token="",oauth_signature_method="",oauth_timestamp="",oauth_nonce="",oauth_version="1.0",oauth_signature=""

Related Topics

General Notices