Folders
Folders can be used to organize files within the platform. Folders are virtual, and aren't mirrored within the storage adapter.
The folders Object
| Field Name | Type | Description |
|---|---|---|
id | uuid | Primary key of the folder (UUID format). |
name | string | Name of the folder. |
parent | object | Parent folder. Many-to-one relationship to folders (recursive). |
List Folders
List all folders that exist in TrackVision.
Request
- REST
- GraphQL
GET /folders
SEARCH /folders
If using SEARCH you can provide a query object as the body of your request.
POST /graphql/system
type Query {
folders: trackvision_folders
}
Query Parameters
Supports all global query parameters.
Response
An array of up to limit folder objects. If no items are available, data will be an empty array.
Example
- REST
- GraphQL
GET /folders
SEARCH /folders
POST /graphql/system
query {
folders {
name
}
}
Retrieve a Folder
List an existing folder by primary key.
Request
- REST
- GraphQL
GET /folders/:id
POST /graphql/system
type Query {
folders_by_id(id: ID!): trackvision_folders
}
Query Parameters
Supports all global query parameters.
Response
Returns a folder object if a valid primary key was provided.
Example
- REST
- GraphQL
GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
POST /graphql/system
query {
folders_by_id(id: "fc02d733-95b8-4e27-bd4b-08a32cbe4e66") {
name
}
}
Create a Folder
Create a new (virtual) folder.
Request
- REST
- GraphQL
POST /folders
Provide a folder object as the body of your request.
POST /graphql/system
type Mutation {
create_folders_item(data: create_trackvision_folders_input): trackvision_folders
}
Query Parameters
Supports all global query parameters.
Request Body
A partial folder object. name is required.
Response
Returns the folder object of the folder that was created.
Example
- REST
- GraphQL
POST /folders
{
"name": "Nature"
}
POST /graphql/system
mutation {
create_folders_item(data: { name: "Nature" }) {
id
name
}
}
Create Multiple Folders
Create multiple new (virtual) folders.
Request
- REST
- GraphQL
POST /folders
Provide an array of folder object as the body of your request.
POST /graphql/system
type Mutation {
create_folders_items(data: [create_trackvision_folders_input]): [trackvision_folders]
}
Query Parameters
Supports all global query parameters.
Request Body
An array of partial folder objects. name is required.
Response
Returns the folder object of the folder that was created.
Example
- REST
- GraphQL
POST /folders
[
{
"name": "Nature"
},
{
"name": "Cities"
}
]
POST /graphql/system
mutation {
create_folders_items(data: [{ name: "Nature" }, { name: "Cities" }]) {
id
name
}
}
Update a Folder
Update an existing folder.
Request
- REST
- GraphQL
PATCH /folders/:id
Provide a partial folder object as the body of your request.
POST /graphql/system
type Mutation {
update_folders_item(id: ID!, data: update_trackvision_folders_input): trackvision_folders
}
Query Parameters
Supports all global query parameters.
Request Body
A partial folder object.
Response
Returns the folder object of the folder that was updated.
Example
- REST
- GraphQL
PATCH /folders/fac21847-d5ce-4e4b-a288-9abafbdfbc87
{
"parent": "d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"
}
POST /graphql/system
mutation {
update_folders_item(
id: "fac21847-d5ce-4e4b-a288-9abafbdfbc87"
data: { parent: "d97c2e0e-293d-4eb5-9e1c-27d3460ad29d" }
) {
id
name
}
}
Update Multiple Folders
Update multiple existing folders.
Request
- REST
- GraphQL
PATCH /folders
{
"keys": folder_id_array,
"data": partial_folder_object
}
POST /graphql/system
type Mutation {
update_folders_items(ids: [ID!]!, data: update_trackvision_folders_input): [trackvision_folders]
}
Query Parameters
Supports all global query parameters.
Request Body
keys Required
Array of primary keys of the folders you'd like to update.
data Required
Any of the folder object's properties.
Response
Returns the folder objects of the folders that were updated.
Example
- REST
- GraphQL
PATCH /folders
{
"keys": ["fac21847-d5ce-4e4b-a288-9abafbdfbc87", "a5bdb793-dd85-4ac9-882a-b42862092983"],
"data": {
"parent": "d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"
}
}
POST /graphql/system
mutation {
update_folders_items(
ids: ["fac21847-d5ce-4e4b-a288-9abafbdfbc87", "a5bdb793-dd85-4ac9-882a-b42862092983"]
data: { parent: "d97c2e0e-293d-4eb5-9e1c-27d3460ad29d" }
) {
id
name
}
}
Delete a Folder
Delete an existing folder.
Any files in this folder will be moved to the root folder.
Request
- REST
- GraphQL
DELETE /folders/:id
POST /graphql/system
type Mutation {
delete_folders_item(id: ID!): delete_one
}
Response
Empty body.
Example
- REST
- GraphQL
DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983
POST /graphql/system
mutation {
delete_folders_item(id: "fac21847-d5ce-4e4b-a288-9abafbdfbc87") {
id
}
}
Delete Multiple Folders
Delete multiple existing folders.
Any files in these folders will be moved to the root folder.
Request
- REST
- GraphQL
DELETE /folders
Provide an array of item IDs as your request body.
POST /graphql/system
type Mutation {
delete_folders_items(ids: [ID!]!): delete_many
}
Request Body
An array of folder primary keys.
Returns
Empty body.
Example
- REST
- GraphQL
DELETE /folders
["d97c2e0e-293d-4eb5-9e1c-27d3460ad29d", "fc02d733-95b8-4e27-bd4b-08a32cbe4e66"]
mutation {
delete_folders_items(ids: ["fac21847-d5ce-4e4b-a288-9abafbdfbc87", "a5bdb793-dd85-4ac9-882a-b42862092983"]) {
ids
}
}