Workspace
workspace の作成
Square Cloud アカウントに新しい workspace を作成します。
POST
/
v2
/
workspaces
workspace の作成
curl --request POST \
--url https://api.squarecloud.app/v2/workspaces \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/workspaces"
payload = { "name": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://api.squarecloud.app/v2/workspaces', 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.squarecloud.app/v2/workspaces",
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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.squarecloud.app/v2/workspaces"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.squarecloud.app/v2/workspaces")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body
{
"status": "success",
"response": {
"id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
"name": "Test"
}
}
認証済みユーザーが所有するworkspaceを作成します。所有権を移動することなく、ロールベースの権限モデルで他のSquare Cloudアカウントとアプリケーションを共有できるようになります。workspaceはStandard、Pro、Enterpriseプランでのみ利用でき、これらのプラン階層ではいずれもアカウントあたり最大5つのworkspaceに制限されます。
name は1〜32文字（英数字、スペース、ハイフン、アンダースコア）である必要があります。workspaceを作成した後は、アプリケーションの追加でアプリケーションを共有し、メンバーの招待で共同作業者を追加できます。このエンドポイントのレート制限は1ユーザーあたり10秒間に1回の作成です。
パラメータ
string
workspace の名前を表す文字列。
a〜z、A〜Z、0〜9、スペース、_ のパターンに従う必要があります。（1〜32文字）
a〜z、A〜Z、0〜9、スペース、_ のパターンに従う必要があります。（1〜32文字）
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。
{
"status": "success",
"response": {
"id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
"name": "Test"
}
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_NAME | 400 | name が指定されていないか、1〜32文字のパターンに一致しません。 |
UPGRADE_REQUIRED | 403 | 現在のプランがStandard、Pro、Enterpriseのいずれでもありません。 |
WORKSPACE_LIMIT_REACHED | 400 | アカウントがすでにプランの上限数のworkspaceを保有しています。 |
WORKSPACE_CREATION_FAILED | 400 | workspaceを作成できませんでした。 |
⌘I
workspace の作成
curl --request POST \
--url https://api.squarecloud.app/v2/workspaces \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/workspaces"
payload = { "name": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://api.squarecloud.app/v2/workspaces', 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.squarecloud.app/v2/workspaces",
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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.squarecloud.app/v2/workspaces"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.squarecloud.app/v2/workspaces")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body
{
"status": "success",
"response": {
"id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
"name": "Test"
}
}