PATCH
/
v4
/
application-specs
/
{application_spec_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const applicationSpec = await client.applicationSpecs.update('application_spec_id');

console.log(applicationSpec.id);
{
  "name": "<string>",
  "description": "<string>",
  "theme_id": "<string>",
  "run_online_evaluation": true,
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

application_spec_id
string
required

Body

application/json
name
string

The name of the Application Spec

description
string

The description of the Application Spec

theme_id
string
run_online_evaluation
boolean

Whether the application spec should run online evaluation, default is false

restore
boolean
default:false

Set to true to restore the entity from the database.

Response

Successful Response

name
string
required

The name of the Application Spec

description
string
required

The description of the Application Spec

id
string
required

The unique identifier of the entity.

created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

account_id
string
required

The ID of the account that owns the given entity.

theme_id
string
run_online_evaluation
boolean

Whether the application spec should run online evaluation, default is false

created_by_user_id
string

The user who originally created the entity.

created_by_identity_type
enum<string>

The type of identity that created the entity.

Available options:
user,
service_account
archived_at
string<date-time>

The date and time when the entity was archived in ISO format.