Skip to content

Objects

create

HTTP Request

POST https://api.solvebio.com/v2/objects

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with "write" permission or higher to the vault that the object will go into.

Request Body

In the request body, provide a single Object resource.

Property Value Description
vault_id integer The ID of the vault that will contain the object.
parent_object_id integer The ID of the existing folder object to place the new object into. To place at "/", set this value to null.
filename string The filename of the object, not including its parent folder. This value cannot contain slashes.
object_type string The object_type of the object. Must be one of "file", "folder", or "dataset".
description text (Optional) The description of the object.
metadata object (Optional) A dictionary of key/value pairs.
tags string (Optional) A list of strings to organize the vault.

Response

The response contains a single Object resource.

list

HTTP Request

GET https://api.solvebio.com/v2/objects

Parameters

This request accepts the following parameters:

Parameter Value Description
id integer The ID of an object.
parent_object_id integer The ID of the folder containing objects.
vault_id integer The ID of the vault containing objects.
vault_name text The name of the vault containing objects.
filename text The filename of the object, not including its parent folder.
path text The path of the object, including its parent folder.
object_type text The type of the object. Must be one of "file", "folder", or "dataset".
depth integer The depth of the object in the Vault. Objects at the root have depth = 0.
query text A string that matches any objects whose path contains that string.
regex regex A regular expression which searches objects for matching paths (case-insensitive).
ancestor_id integer The ID of an ancestor object (parent folder, parent of parent folder, etc). For "/", use "null".
min_distance integer Used in conjuction with the ancestor_id filter to only include objects at a minimum distance from the ancestor.
tags text A string representing a single vault tag. Matching vaults must have this tag set.

Authorization

The response includes objects which exist inside vaults that the user has "read" permission or higher to.

Request Body

Do not supply a request body with this method.

Response

The response returns a list of objects matching the provided filters.

update

HTTP Request

PUT https://api.solvebio.com/v2/objects/{ID}

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with "write" permission or higher to the vault that contains the object.

Request Body

In the request body, provide a valid Object body (see create above).

Response

The response contains the updated Object resource.

delete

HTTP Request

DELETE https://api.solvebio.com/v2/objects/{ID}

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with "write" permission or higher to the vault that contains the object.

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/objects/{ID}

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with "read" permission or higher to the vault that contains the object.

Request Body

Do not supply a request body with this method.

Response

The response contains an Object resource.

create (object copy task)

Datasets are ignored by object copy tasks. If you wish to copy a dataset, you must download it and re-import it.

HTTP Request

POST https://api.solvebio.com/v2/object_copy_tasks

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with "read" permission or higher on the source vault, and "write" permission or higher on the target vault.

Request Body

In the request body, provide the following parameters:

Property Value Description
source_vault_id integer The ID of the vault that contains the object which will be copied.
target_vault_id integer The ID of the vault that the object will be copied to.
source_object_id integer The ID of the object which will be copied. Must be a file or folder. Set to null to copy the entire vault.
target_object_id integer The ID of the object into which the new objects will copied. Must be a folder. Set to null to copy objects to /.

Response

The response contains a single object copy task.

list (object copy tasks)

HTTP Request

GET https://api.solvebio.com/v2/object_copy_tasks

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user.

Request Body

Do not supply a request body with this method.

Response

The response contains a list of object copy tasks.

get (object copy task)

HTTP Request

GET https://api.solvebio.com/v2/object_copy_tasks/{ID}

Parameters

This request does not accept URL parameters.

Authorization

This request requires that the authorized user is also the user who created the object copy task being retrieved.

Request Body

Do not supply a request body with this method.

Response

The response contains an object copy task resource.