Skip to main content
PUT
/
api
/
dataframer
/
specs
/
{spec_id}
JavaScript
import Dataframer from 'dataframer';

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

const spec = await client.dataframer.specs.update('spec_id', { config_yaml: 'config_yaml' });

console.log(spec.datasets_id);
{
  "name": "<string>",
  "datasets_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "latest_version": -1,
  "status": "PROCESSING",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "dataset_name": "<string>",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_name": "<string>",
  "created_by": 123,
  "created_by_name": "<string>",
  "versions": [
    {
      "spec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": -1,
      "config_yaml": "<string>",
      "results_yaml": "<string>",
      "orig_results_yaml": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "spec_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "runtime_params": {}
    }
  ],
  "version_count": 123,
  "latest_version_data": "<string>",
  "data_property_variations": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

​
spec_id
string
required

Body

application/json
​
config_yaml
string
required

YAML configuration for the spec (required)

​
results_yaml
string

Results YAML from analysis (optional)

​
orig_results_yaml
string

Original results YAML (optional)

​
runtime_params
object

Runtime parameters for generation (optional)

​
name
string

Update the spec name (optional)

​
description
string

Update the spec description (optional)

Response

Spec updated successfully, new version created

​
name
string
required
Minimum string length: 1
​
datasets_id
string<uuid>
required
​
id
string<uuid>
​
description
string | null
​
latest_version
integer
Required range: -2147483648 <= x <= 2147483647
​
status
enum<string>
Available options:
PROCESSING,
READY,
FAILED
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
dataset_name
string
Minimum string length: 1
​
company_id
string<uuid>
​
company_name
string
Minimum string length: 1
​
created_by
integer | null
​
created_by_name
string
Minimum string length: 1
​
versions
object[]
​
version_count
integer
​
latest_version_data
string
​
data_property_variations
string