Archive Evaluation Group

client.EvaluationGroups.Archive(ctx, groupID) (*EvaluationGroup, error)

DELETE/v5/evaluation-groups/{group_id}

Archive (soft-delete) an evaluation group and its dependent records.

This is a soft delete: the group is marked deleted rather than removed, so it no longer appears in default list/get results but can still be fetched with the include-deleted flags. The same delete timestamp cascades as a soft delete to the group’s members, row identifiers, and its dashboard charts and their chart columns; the member evaluations themselves are not affected. The archived group is returned in the response.

ParametersExpand Collapse

groupID string

ReturnsExpand Collapse

type EvaluationGroup struct{…}

Response model for evaluation group

ID string

Unique identifier of the evaluation group

AccountID string

Account that owns this evaluation group

CreatedAt Time

When the group was created

formatdate-time

Name string

Name of the evaluation group

Tags []string

The tags associated with the entity

DeletedAt TimeOptional

When the group was soft-deleted

formatdate-time

Description stringOptional

Optional description

Members []EvaluationGroupMemberOptional

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

CreatedAt Time

When this member was added to the group

formatdate-time

EvaluationGroupID string

ID of the evaluation group

EvaluationID string

ID of the evaluation

DeletedAt TimeOptional

When this membership was soft-deleted (if applicable)

formatdate-time

EvaluationCreatedAt TimeOptional

When the evaluation was created

formatdate-time

EvaluationName stringOptional

Name of the evaluation

EvaluationTags []stringOptional

Tags of the evaluation

Object EvaluationGroupMemberObjectOptional

Metadata map[string, any]Optional

Optional metadata key-value pairs

Object EvaluationGroupObjectOptional

RowIdentifiers []EvaluationGroupRowIdentifierOptional

Row identifier mappings. Populated with ‘row_identifiers’ view.

ColumnName string

Name of the column used as row identifier

EvaluationID string

ID of the evaluation

Object EvaluationGroupRowIdentifierObjectOptional

Archive Evaluation Group

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  evaluationGroup, err := client.EvaluationGroups.Archive(context.TODO(), "group_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
    }
  ]
}