Dataset Commits¶
Dataset commits cannot be directly created. Commits are generated only from dataset imports.
delete¶
Not recommended
Deleting dataset commits is not recommended as data provenance will be lost.
HTTP Request
DELETE https://api.solvebio.com/v2/dataset_commits/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with write permissions on the dataset.
Request Body
Do not supply a request body with this method.
Response
The response returns "HTTP 200 OK" when successful.
get¶
HTTP Request
GET https://api.solvebio.com/v2/dataset_commits/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with permission.
Request Body
Do not supply a request body with this method.
Response
The response contains a DatasetCommit resource.
list¶
HTTP Request
GET https://api.solvebio.com/v2/datasets/{DATASET_ID}/commits
Parameters
This request accepts the following parameters:
| Parameter | Value | Description |
|---|---|---|
| limit | integer | The number of objects to return per page. |
| offset | integer | The offset within the list of available objects. |
Authorization
This request requires an authorized user with read permission on the dataset.
Response
The response contains a list of DatasetCommit resources.
revert status¶
Returns whether or not a commit can be reverted and returns a reason why along with any commits that are blocking.
HTTP Request
GET https://api.solvebio.com/v2/dataset_commits/{ID}/rollback
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with write permission on the dataset.
Request Body
This request does not accept a request body.
Response
Returns a boolean is_blocked and a detail string explaining why. If there are blocking commits blocking_commits will contain a list of DatasetCommit resources.
revert¶
Revert a completed commit by creating a rollback
HTTP Request
POST https://api.solvebio.com/v2/dataset_commits/{ID}/rollback
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with write permission on the dataset.
Request Body
This request does not accept a request body.
Response
If a rollback cannot be created, the status code will be 400 Bad Request. Otherwise, the response will contain a DatasetCommit resource, representing the rollback commit.
cancel¶
HTTP Request
PUT https://api.solvebio.com/v2/datasets_commits/{ID}/cancel
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with read permission on the dataset.
Request Body
In the request body, provide a valid DatasetCommit object (see create above) with status = canceled.
Response
The response will contain a DatasetCommit resource with the status canceled.