Get Directory Details

GET

directories

{directory_id}

details

curl --request GET \
  --url https://api.aspect.inc/directories/{directory_id}/details \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aspect.inc/directories/{directory_id}/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aspect.inc/directories/{directory_id}/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aspect.inc/directories/{directory_id}/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aspect.inc/directories/{directory_id}/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "color": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "num_assets": 123,
  "size_bytes": 123,
  "duration": 123,
  "is_symlink": false,
  "target_path": [
    "<string>"
  ],
  "target_path_type": "relative",
  "target_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_resource_name": "<string>",
  "target_resource_type": "workspace",
  "target_resolution_status": "resolved",
  "actions": 123,
  "client_performed_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "avatar_url": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

JWT in Authorization header. 'Bearer ' prefix optional.

Path Parameters

directory_id

string<uuid>

required

Response

Successful Response

API response schema for getting directory details with stats and creator info

string<uuid>

required

Directory ID

name

string

required

Directory name

color

string

required

Hex color code for the directory icon

project_id

string<uuid>

required

ID of the project this directory belongs to

parent_id

string<uuid>

required

ID of the parent resource (directory or project)

created_by_user_id

string<uuid>

required

ID of the user that created the directory

created

string<date-time>

required

Creation timestamp

updated

string<date-time>

required

Last update timestamp

num_assets

integer

required

Total number of assets in directory tree

size_bytes

integer

required

Total size in bytes of all assets in directory tree

duration

number

required

Total duration of all assets in directory tree

is_symlink

boolean

default:false

True when this item is a projected symlink

target_path

string[] | null

Symlink target path components

target_path_type

enum<string> | null

Symlink target path type

Available options:

relative,

internal_absolute,

external_absolute

target_resource_id

string<uuid> | null

Resolved target resource ID

target_resource_name

string | null

Resolved target resource name

target_resource_type

enum<string> | null

Resolved or hinted target resource type

Available options:

workspace,

project,

directory,

asset,

symlink,

collection

target_resolution_status

enum<string> | null

Symlink resolution status

Available options:

resolved,

dangling,

permission_denied,

external

actions

integer | null

User's permission bitmap on this directory

client_performed_at

string<date-time> | null

Server-recorded timestamp of the latest user action on this directory, flattened from current_revision.client_performed_at. NULL when no revision exists. Used by the desktop renderer to compare against a per-pin coverage cursor.

created_by

UserInfo · object | null

Information about the user who created the directory

Show child attributes

Get Directory Details

curl --request GET \
  --url https://api.aspect.inc/directories/{directory_id}/details \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aspect.inc/directories/{directory_id}/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aspect.inc/directories/{directory_id}/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aspect.inc/directories/{directory_id}/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aspect.inc/directories/{directory_id}/details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "color": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "num_assets": 123,
  "size_bytes": 123,
  "duration": 123,
  "is_symlink": false,
  "target_path": [
    "<string>"
  ],
  "target_path_type": "relative",
  "target_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_resource_name": "<string>",
  "target_resource_type": "workspace",
  "target_resolution_status": "resolved",
  "actions": 123,
  "client_performed_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "avatar_url": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

API Endpoints

Get Directory Details

Authorizations

Path Parameters

Response