Create Subdirectory

POST

directories

{directory_id}

directories

Create Subdirectory

curl --request POST \
  --url https://api.aspect.inc/directories/{directory_id}/directories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_performed_at": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_performed_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    client_performed_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.aspect.inc/directories/{directory_id}/directories', 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}/directories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'client_performed_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_performed_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aspect.inc/directories/{directory_id}/directories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_performed_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_performed_at\": \"2023-11-07T05:31:56Z\"\n}"

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",
  "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,
  "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_latest": true
}

{
  "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

Body

application/json

API request schema for creating a directory

name

string

required

Name of the directory

string<uuid> | null

Client-generated directory ID (optional, server generates if not provided)

auto_rename

enum<string> | null

Auto-rename style to use if name conflicts with an existing item. If not set and a conflict exists, returns 409.

Available options:

parenthesized,

numeric

client_performed_at

string<date-time> | null

When the client performed this action. Defaults to server time if not provided.

Response

Successful Response

API response schema for creating a directory

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

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

revision_id

string<uuid> | null

ID of the CREATED revision for this directory

is_latest

boolean | null

Whether the revision is the overall latest

Create Subdirectory

curl --request POST \
  --url https://api.aspect.inc/directories/{directory_id}/directories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_performed_at": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_performed_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    client_performed_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.aspect.inc/directories/{directory_id}/directories', 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}/directories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'client_performed_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_performed_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aspect.inc/directories/{directory_id}/directories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_performed_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_performed_at\": \"2023-11-07T05:31:56Z\"\n}"

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",
  "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,
  "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_latest": true
}

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

Overview

API Endpoints

Create Subdirectory

Authorizations

Path Parameters

Body

Response