cURL
curl --request PATCH \
--url https://api.eda.prisme.ai/v2/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": [
"<string>"
],
"customDomains": [
"<string>"
],
"registerWorkspace": true,
"repositories": {},
"secrets": {
"schema": {}
},
"events": {
"mapping": {},
"types": {}
}
}
'import requests
url = "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}"
payload = {
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": ["<string>"],
"customDomains": ["<string>"],
"registerWorkspace": True,
"repositories": {},
"secrets": { "schema": {} },
"events": {
"mapping": {},
"types": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: {fr: 'Bonjour', en: 'Hello'},
photo: '<string>',
config: {schema: {}, block: '<string>', value: '<unknown>'},
blocks: {},
slug: '<string>',
id: '<string>',
labels: ['<string>'],
customDomains: ['<string>'],
registerWorkspace: true,
repositories: {},
secrets: {schema: {}},
events: {mapping: {}, types: {}}
})
};
fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}', 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.eda.prisme.ai/v2/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => [
'fr' => 'Bonjour',
'en' => 'Hello'
],
'photo' => '<string>',
'config' => [
'schema' => [
],
'block' => '<string>',
'value' => '<unknown>'
],
'blocks' => [
],
'slug' => '<string>',
'id' => '<string>',
'labels' => [
'<string>'
],
'customDomains' => [
'<string>'
],
'registerWorkspace' => true,
'repositories' => [
],
'secrets' => [
'schema' => [
]
],
'events' => [
'mapping' => [
],
'types' => [
]
]
]),
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.eda.prisme.ai/v2/workspaces/{workspaceId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": {\n \"fr\": \"Bonjour\",\n \"en\": \"Hello\"\n },\n \"photo\": \"<string>\",\n \"config\": {\n \"schema\": {},\n \"block\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"blocks\": {},\n \"slug\": \"<string>\",\n \"id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"customDomains\": [\n \"<string>\"\n ],\n \"registerWorkspace\": true,\n \"repositories\": {},\n \"secrets\": {\n \"schema\": {}\n },\n \"events\": {\n \"mapping\": {},\n \"types\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": {\n \"fr\": \"Bonjour\",\n \"en\": \"Hello\"\n },\n \"photo\": \"<string>\",\n \"config\": {\n \"schema\": {},\n \"block\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"blocks\": {},\n \"slug\": \"<string>\",\n \"id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"customDomains\": [\n \"<string>\"\n ],\n \"registerWorkspace\": true,\n \"repositories\": {},\n \"secrets\": {\n \"schema\": {}\n },\n \"events\": {\n \"mapping\": {},\n \"types\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": {\n \"fr\": \"Bonjour\",\n \"en\": \"Hello\"\n },\n \"photo\": \"<string>\",\n \"config\": {\n \"schema\": {},\n \"block\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"blocks\": {},\n \"slug\": \"<string>\",\n \"id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"customDomains\": [\n \"<string>\"\n ],\n \"registerWorkspace\": true,\n \"repositories\": {},\n \"secrets\": {\n \"schema\": {}\n },\n \"events\": {\n \"mapping\": {},\n \"types\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": [
"<string>"
],
"customDomains": [
"<string>"
],
"registerWorkspace": true,
"repositories": {},
"secrets": {
"schema": {}
},
"events": {
"mapping": {},
"types": {}
}
}{
"error": "BadParameters",
"message": "<string>",
"details": "<unknown>"
}{
"error": "AuthenticationError",
"message": "Unauthenticated"
}{
"error": "ForbiddenError",
"message": "Forbidden"
}{
"error": "ObjectNotFound",
"message": "<string>"
}Prisme.ai Workspaces
Patch v2workspaces
Update a workspace
PATCH
/
v2
/
workspaces
/
{workspaceId}
cURL
curl --request PATCH \
--url https://api.eda.prisme.ai/v2/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": [
"<string>"
],
"customDomains": [
"<string>"
],
"registerWorkspace": true,
"repositories": {},
"secrets": {
"schema": {}
},
"events": {
"mapping": {},
"types": {}
}
}
'import requests
url = "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}"
payload = {
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": ["<string>"],
"customDomains": ["<string>"],
"registerWorkspace": True,
"repositories": {},
"secrets": { "schema": {} },
"events": {
"mapping": {},
"types": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: {fr: 'Bonjour', en: 'Hello'},
photo: '<string>',
config: {schema: {}, block: '<string>', value: '<unknown>'},
blocks: {},
slug: '<string>',
id: '<string>',
labels: ['<string>'],
customDomains: ['<string>'],
registerWorkspace: true,
repositories: {},
secrets: {schema: {}},
events: {mapping: {}, types: {}}
})
};
fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}', 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.eda.prisme.ai/v2/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => [
'fr' => 'Bonjour',
'en' => 'Hello'
],
'photo' => '<string>',
'config' => [
'schema' => [
],
'block' => '<string>',
'value' => '<unknown>'
],
'blocks' => [
],
'slug' => '<string>',
'id' => '<string>',
'labels' => [
'<string>'
],
'customDomains' => [
'<string>'
],
'registerWorkspace' => true,
'repositories' => [
],
'secrets' => [
'schema' => [
]
],
'events' => [
'mapping' => [
],
'types' => [
]
]
]),
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.eda.prisme.ai/v2/workspaces/{workspaceId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": {\n \"fr\": \"Bonjour\",\n \"en\": \"Hello\"\n },\n \"photo\": \"<string>\",\n \"config\": {\n \"schema\": {},\n \"block\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"blocks\": {},\n \"slug\": \"<string>\",\n \"id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"customDomains\": [\n \"<string>\"\n ],\n \"registerWorkspace\": true,\n \"repositories\": {},\n \"secrets\": {\n \"schema\": {}\n },\n \"events\": {\n \"mapping\": {},\n \"types\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": {\n \"fr\": \"Bonjour\",\n \"en\": \"Hello\"\n },\n \"photo\": \"<string>\",\n \"config\": {\n \"schema\": {},\n \"block\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"blocks\": {},\n \"slug\": \"<string>\",\n \"id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"customDomains\": [\n \"<string>\"\n ],\n \"registerWorkspace\": true,\n \"repositories\": {},\n \"secrets\": {\n \"schema\": {}\n },\n \"events\": {\n \"mapping\": {},\n \"types\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": {\n \"fr\": \"Bonjour\",\n \"en\": \"Hello\"\n },\n \"photo\": \"<string>\",\n \"config\": {\n \"schema\": {},\n \"block\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"blocks\": {},\n \"slug\": \"<string>\",\n \"id\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"customDomains\": [\n \"<string>\"\n ],\n \"registerWorkspace\": true,\n \"repositories\": {},\n \"secrets\": {\n \"schema\": {}\n },\n \"events\": {\n \"mapping\": {},\n \"types\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": [
"<string>"
],
"customDomains": [
"<string>"
],
"registerWorkspace": true,
"repositories": {},
"secrets": {
"schema": {}
},
"events": {
"mapping": {},
"types": {}
}
}{
"error": "BadParameters",
"message": "<string>",
"details": "<unknown>"
}{
"error": "AuthenticationError",
"message": "Unauthenticated"
}{
"error": "ForbiddenError",
"message": "Forbidden"
}{
"error": "ObjectNotFound",
"message": "<string>"
}Authorizations
BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace id
Body
application/json
Pattern:
^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$Show child attributes
Show child attributes
Example:
{ "fr": "Bonjour", "en": "Hello" }
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^[0-9A-Za-z._:-]{2,60}$If true, make this workspace metadata available to all workspaces with this variable : {{global.workspacesRegistry[WORKSPACE_SLUG]}}
Remote versioning repositories
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success Response
Pattern:
^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$Show child attributes
Show child attributes
Example:
{ "fr": "Bonjour", "en": "Hello" }
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^[0-9A-Za-z._:-]{2,60}$If true, make this workspace metadata available to all workspaces with this variable : {{global.workspacesRegistry[WORKSPACE_SLUG]}}
Remote versioning repositories
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I