Update a dataset version

Request

Edit the description of an editable or committed dataset version. This does not change episodes, commit attribution, or commit time.

Security

ApiKey(Required scopes: datasets.update)

Path

idstringrequired

Dataset ID

versionNumberstring^[0-9]+$required

Version number

Bodyapplication/jsonrequired

descriptionstring or null, [ 1 .. 2048 ] characters\Srequired

Description of the version. Set to null to clear it.

Payload

{
  "description": "string"
}

Responses

The updated dataset version

Bodyapplication/json

descriptionstring

Description of the version. Omitted when the version has no description.

versionNumberinteger, >= 1required

The version's number. The highest-numbered version is the editable latest.

committedAtstring, (date-time)

Omitted for the editable latest version; set once the version has been committed and its episode membership is saved.

committedByOrgMemberIdstring

ID of the org member who committed the version. Omitted when committed via API-key auth or when the version is still editable.

committedByApiKeyIdstring

ID of the API key that committed the version. Omitted when committed via session auth or when the version is still editable.

createdAtstring, (date-time)required

Timestamp when the version was created.

episodeCountinteger, >= 0required

Total number of episodes in the dataset at this version. For the editable latest version, this is the current working set, including staged, uncommitted edits.

addedEpisodeCountinteger, >= 0required

Number of episodes added in this version, relative to the previous version. For the editable latest version, this is the count of staged, uncommitted additions.

removedEpisodeCountinteger, >= 0required

Number of episodes removed in this version, relative to the previous version. For the editable latest version, this is the count of staged, uncommitted removals.

changedEpisodeCountinteger, >= 0required

Number of episodes using a different episode version than in the previous dataset version.

hasMissingRecordingsbooleanrequired

True when at least one recording in this dataset version has no available data source.

Response

{
  "description": "string",
  "versionNumber": 1,
  "committedAt": "2019-08-24T14:15:22Z",
  "committedByOrgMemberId": "string",
  "committedByApiKeyId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "episodeCount": 0,
  "addedEpisodeCount": 0,
  "removedEpisodeCount": 0,
  "changedEpisodeCount": 0,
  "hasMissingRecordings": true
}