Commit a new dataset version

Request

Commit the current changes as a new dataset version. Returns 409 when the current dataset version has no changes.

Security

ApiKey(Required scopes: datasets.update)

Path

idstringrequired

Dataset ID

Bodyapplication/json

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

Description of the version. Set to null to clear it. If omitted, keeps the editable version's description.

Payload

{
  "description": "string"
}

Responses

The committed version and the new editable version number

Bodyapplication/json

committedobject(DatasetVersionResponse)required

The version that was committed.

editableVersionNumberinteger, >= 1required

The number of the new editable version opened by the commit.

Response

{
  "committed": {
    "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
  },
  "editableVersionNumber": 1
}