import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const applicationVariant = await client.applicationVariants.retrieve('application_variant_id');
console.log(applicationVariant);
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"configuration": {
"metadata": {},
"nodes": [
{
"id": "<string>",
"application_node_schema_id": "text_input_schema",
"configuration": {}
}
],
"edges": [
{
"from_node": "<string>",
"to_node": "<string>",
"from_field": "<string>",
"to_field": "<string>"
}
]
},
"version": "V0",
"application_spec_id": "<string>",
"draft": true,
"published_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
Gets the details of a application variant
This API can be used to get information about a single application variant by ID. To use this API, pass in the id
that was returned from your Create Application Variant 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 applicationVariant = await client.applicationVariants.retrieve('application_variant_id');
console.log(applicationVariant);
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"configuration": {
"metadata": {},
"nodes": [
{
"id": "<string>",
"application_node_schema_id": "text_input_schema",
"configuration": {}
}
],
"edges": [
{
"from_node": "<string>",
"to_node": "<string>",
"from_field": "<string>",
"to_field": "<string>"
}
]
},
"version": "V0",
"application_spec_id": "<string>",
"draft": true,
"published_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
Successful Response
The response is of type object
.