Update Evaluation Group

client.evaluationGroups.replace(, , ?): EvaluationGroup { id, account_id, created_at, 8 more }

PUT/v5/evaluation-groups/{group_id}

Replace an evaluation group’s attributes and, optionally, its membership.

This is a full replacement of the group’s attributes: every attribute field (name, description, tags, metadata) is written from the request, so omitting an optional field clears it rather than leaving it unchanged. Use PATCH instead to update only selected fields and to merge (rather than overwrite) metadata. Membership is replaced only when evaluation_ids is supplied: the resulting members become exactly that set (added/removed by diff against the current members), it must contain at least one ID with no duplicates, and every ID is validated for existence and account access or the request fails with a 400. When membership actually changes, a best-effort Temporal workflow is started to recompute the group’s dashboard widgets; this is fire-and-forget and its failure does not fail the request. Removing members hard-deletes the corresponding chart columns and any charts left with no columns.

ParametersExpand Collapse

groupID: string

body: EvaluationGroupReplaceParams { description, evaluation_ids, metadata, 3 more }

description?: string

Optional description

evaluation_ids?: Array<string>

Complete list of evaluation IDs to include in group (replaces existing members)

metadata?: Record<string, unknown>

Optional metadata key-value pairs

name?: string

Name of the evaluation group

maxLength128

row_identifiers?: Record<string, string>

Optional mapping of evaluation_id to column name for cross-dataset joins

tags?: Array<string>

The tags associated with the entity

ReturnsExpand Collapse

EvaluationGroup { id, account_id, created_at, 8 more }

Response model for evaluation group

id: string

Unique identifier of the evaluation group

account_id: string

Account that owns this evaluation group

created_at: string

When the group was created

formatdate-time

name: string

Name of the evaluation group

tags: Array<string> | null

The tags associated with the entity

deleted_at?: string

When the group was soft-deleted

formatdate-time

description?: string

Optional description

members?: Array<EvaluationGroupMember { id, created_at, evaluation_group_id, 6 more } >

Evaluation members in this group. Returned by default on GET by id; on list endpoints, populated only with the ‘members’ view.

id: string

Unique identifier of the member record

created_at: string

When this member was added to the group

formatdate-time

evaluation_group_id: string

ID of the evaluation group

evaluation_id: string

ID of the evaluation

deleted_at?: string

When this membership was soft-deleted (if applicable)

formatdate-time

evaluation_created_at?: string

When the evaluation was created

formatdate-time

evaluation_name?: string

Name of the evaluation

evaluation_tags?: Array<string>

Tags of the evaluation

object?: "evaluation_group.member"

metadata?: Record<string, unknown>

Optional metadata key-value pairs

object?: "evaluation_group"

row_identifiers?: Array<EvaluationGroupRowIdentifier { column_name, evaluation_id, object } >

Row identifier mappings. Populated with ‘row_identifiers’ view.

column_name: string

Name of the column used as row identifier

evaluation_id: string

ID of the evaluation

object?: "evaluation_group.row_identifier"

Update Evaluation Group

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const evaluationGroup = await client.evaluationGroups.replace('group_id');

console.log(evaluationGroup.id);

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "tags": [
    "string"
  ],
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "members": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "evaluation_created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_name": "evaluation_name",
      "evaluation_tags": [
        "string"
      ],
      "object": "evaluation_group.member"
    }
  ],
  "metadata": {
    "foo": "bar"
  },
  "object": "evaluation_group",
  "row_identifiers": [
    {
      "column_name": "column_name",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_group.row_identifier"
    }
  ]
}

Returns Examples

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "tags": [
    "string"
  ],
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "members": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "evaluation_created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_name": "evaluation_name",
      "evaluation_tags": [
        "string"
      ],
      "object": "evaluation_group.member"
    }
  ],
  "metadata": {
    "foo": "bar"
  },
  "object": "evaluation_group",
  "row_identifiers": [
    {
      "column_name": "column_name",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_group.row_identifier"
    }
  ]
}