import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const applicationSpec = await client.applicationSpecs.retrieve('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"
}
Gets the details of a application spec
This API can be used to get information about a single application spec by ID. To use this API, pass in the id
that was returned from your Create Application Spec API call as a path parameter.
Review the response schema to see the fields that will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const applicationSpec = await client.applicationSpecs.retrieve('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"
}
Successful Response
The response is of type object
.