Skip to main content
PUT
/
v1
/
workspaces
Update workspace
curl --request PUT \
  --url https://api.example.com/v1/workspaces \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "id": 123,
  "name": "<string>",
  "plan": {
    "id": "<string>",
    "name": "<string>",
    "price": 123,
    "maxUsersNumber": 123,
    "maxRecordsNumber": 123,
    "maxAutomationsNumber": 123,
    "maxStorage": 123
  },
  "promocode": {
    "id": "<string>",
    "partner": {
      "id": "<string>",
      "name": "<string>",
      "promocodes": "<array>"
    },
    "discount": 123,
    "created": "2023-11-07T05:31:56Z",
    "expires": "2023-11-07T05:31:56Z"
  },
  "dashboards": [
    {
      "id": 123,
      "name": "<string>",
      "isDisabled": true,
      "position": 123,
      "path": "<string>",
      "representations": [
        {
          "id": 123,
          "dashboard": "<unknown>",
          "dataset": {
            "id": 123,
            "name": "<string>",
            "isDisabled": true,
            "position": 123,
            "path": "<string>",
            "states": [
              {
                "id": 123,
                "dataset": "<unknown>",
                "name": "<string>",
                "color": 123,
                "position": 123
              }
            ],
            "properties": [
              {
                "id": 123,
                "dataset": "<unknown>",
                "propertyType": {
                  "id": "<string>",
                  "isAutomatic": true,
                  "isPlural": true,
                  "isSortable": true,
                  "position": 123
                },
                "name": "<string>",
                "isUsedAsTitle": true,
                "isRequired": true,
                "parameters": "<string>",
                "position": 123,
                "options": [
                  {
                    "id": 123,
                    "property": "<unknown>",
                    "text": "<string>",
                    "color": 123
                  }
                ]
              }
            ],
            "representations": "<array>"
          },
          "representationType": {
            "id": "<string>",
            "isAggregated": true,
            "position": 123
          },
          "name": "<string>",
          "parameters": "<string>",
          "position": 123
        }
      ]
    }
  ],
  "datasets": [
    {
      "id": 123,
      "name": "<string>",
      "isDisabled": true,
      "position": 123,
      "path": "<string>",
      "states": [
        {
          "id": 123,
          "dataset": "<unknown>",
          "name": "<string>",
          "color": 123,
          "position": 123
        }
      ],
      "properties": [
        {
          "id": 123,
          "dataset": "<unknown>",
          "propertyType": {
            "id": "<string>",
            "isAutomatic": true,
            "isPlural": true,
            "isSortable": true,
            "position": 123
          },
          "name": "<string>",
          "isUsedAsTitle": true,
          "isRequired": true,
          "parameters": "<string>",
          "position": 123,
          "options": [
            {
              "id": 123,
              "property": "<unknown>",
              "text": "<string>",
              "color": 123
            }
          ]
        }
      ],
      "representations": "<array>"
    }
  ]
}
'
import requests

url = "https://api.example.com/v1/workspaces"

payload = {
    "id": 123,
    "name": "<string>",
    "plan": {
        "id": "<string>",
        "name": "<string>",
        "price": 123,
        "maxUsersNumber": 123,
        "maxRecordsNumber": 123,
        "maxAutomationsNumber": 123,
        "maxStorage": 123
    },
    "promocode": {
        "id": "<string>",
        "partner": {
            "id": "<string>",
            "name": "<string>",
            "promocodes": "<array>"
        },
        "discount": 123,
        "created": "2023-11-07T05:31:56Z",
        "expires": "2023-11-07T05:31:56Z"
    },
    "dashboards": [
        {
            "id": 123,
            "name": "<string>",
            "isDisabled": True,
            "position": 123,
            "path": "<string>",
            "representations": [
                {
                    "id": 123,
                    "dashboard": "<unknown>",
                    "dataset": {
                        "id": 123,
                        "name": "<string>",
                        "isDisabled": True,
                        "position": 123,
                        "path": "<string>",
                        "states": [
                            {
                                "id": 123,
                                "dataset": "<unknown>",
                                "name": "<string>",
                                "color": 123,
                                "position": 123
                            }
                        ],
                        "properties": [
                            {
                                "id": 123,
                                "dataset": "<unknown>",
                                "propertyType": {
                                    "id": "<string>",
                                    "isAutomatic": True,
                                    "isPlural": True,
                                    "isSortable": True,
                                    "position": 123
                                },
                                "name": "<string>",
                                "isUsedAsTitle": True,
                                "isRequired": True,
                                "parameters": "<string>",
                                "position": 123,
                                "options": [
                                    {
                                        "id": 123,
                                        "property": "<unknown>",
                                        "text": "<string>",
                                        "color": 123
                                    }
                                ]
                            }
                        ],
                        "representations": "<array>"
                    },
                    "representationType": {
                        "id": "<string>",
                        "isAggregated": True,
                        "position": 123
                    },
                    "name": "<string>",
                    "parameters": "<string>",
                    "position": 123
                }
            ]
        }
    ],
    "datasets": [
        {
            "id": 123,
            "name": "<string>",
            "isDisabled": True,
            "position": 123,
            "path": "<string>",
            "states": [
                {
                    "id": 123,
                    "dataset": "<unknown>",
                    "name": "<string>",
                    "color": 123,
                    "position": 123
                }
            ],
            "properties": [
                {
                    "id": 123,
                    "dataset": "<unknown>",
                    "propertyType": {
                        "id": "<string>",
                        "isAutomatic": True,
                        "isPlural": True,
                        "isSortable": True,
                        "position": 123
                    },
                    "name": "<string>",
                    "isUsedAsTitle": True,
                    "isRequired": True,
                    "parameters": "<string>",
                    "position": 123,
                    "options": [
                        {
                            "id": 123,
                            "property": "<unknown>",
                            "text": "<string>",
                            "color": 123
                        }
                    ]
                }
            ],
            "representations": "<array>"
        }
    ]
}
headers = {"Content-Type": "application/json-patch+json"}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    id: 123,
    name: '<string>',
    plan: {
      id: '<string>',
      name: '<string>',
      price: 123,
      maxUsersNumber: 123,
      maxRecordsNumber: 123,
      maxAutomationsNumber: 123,
      maxStorage: 123
    },
    promocode: {
      id: '<string>',
      partner: {id: '<string>', name: '<string>', promocodes: '<array>'},
      discount: 123,
      created: '2023-11-07T05:31:56Z',
      expires: '2023-11-07T05:31:56Z'
    },
    dashboards: [
      {
        id: 123,
        name: '<string>',
        isDisabled: true,
        position: 123,
        path: '<string>',
        representations: [
          {
            id: 123,
            dashboard: '<unknown>',
            dataset: {
              id: 123,
              name: '<string>',
              isDisabled: true,
              position: 123,
              path: '<string>',
              states: [{id: 123, dataset: '<unknown>', name: '<string>', color: 123, position: 123}],
              properties: [
                {
                  id: 123,
                  dataset: '<unknown>',
                  propertyType: {
                    id: '<string>',
                    isAutomatic: true,
                    isPlural: true,
                    isSortable: true,
                    position: 123
                  },
                  name: '<string>',
                  isUsedAsTitle: true,
                  isRequired: true,
                  parameters: '<string>',
                  position: 123,
                  options: [{id: 123, property: '<unknown>', text: '<string>', color: 123}]
                }
              ],
              representations: '<array>'
            },
            representationType: {id: '<string>', isAggregated: true, position: 123},
            name: '<string>',
            parameters: '<string>',
            position: 123
          }
        ]
      }
    ],
    datasets: [
      {
        id: 123,
        name: '<string>',
        isDisabled: true,
        position: 123,
        path: '<string>',
        states: [{id: 123, dataset: '<unknown>', name: '<string>', color: 123, position: 123}],
        properties: [
          {
            id: 123,
            dataset: '<unknown>',
            propertyType: {
              id: '<string>',
              isAutomatic: true,
              isPlural: true,
              isSortable: true,
              position: 123
            },
            name: '<string>',
            isUsedAsTitle: true,
            isRequired: true,
            parameters: '<string>',
            position: 123,
            options: [{id: 123, property: '<unknown>', text: '<string>', color: 123}]
          }
        ],
        representations: '<array>'
      }
    ]
  })
};

fetch('https://api.example.com/v1/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.example.com/v1/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 123,
    'name' => '<string>',
    'plan' => [
        'id' => '<string>',
        'name' => '<string>',
        'price' => 123,
        'maxUsersNumber' => 123,
        'maxRecordsNumber' => 123,
        'maxAutomationsNumber' => 123,
        'maxStorage' => 123
    ],
    'promocode' => [
        'id' => '<string>',
        'partner' => [
                'id' => '<string>',
                'name' => '<string>',
                'promocodes' => '<array>'
        ],
        'discount' => 123,
        'created' => '2023-11-07T05:31:56Z',
        'expires' => '2023-11-07T05:31:56Z'
    ],
    'dashboards' => [
        [
                'id' => 123,
                'name' => '<string>',
                'isDisabled' => true,
                'position' => 123,
                'path' => '<string>',
                'representations' => [
                                [
                                                                'id' => 123,
                                                                'dashboard' => '<unknown>',
                                                                'dataset' => [
                                                                                                                                'id' => 123,
                                                                                                                                'name' => '<string>',
                                                                                                                                'isDisabled' => true,
                                                                                                                                'position' => 123,
                                                                                                                                'path' => '<string>',
                                                                                                                                'states' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'id' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'dataset' => '<unknown>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'name' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'color' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'position' => 123
                                                                                                                                                                                                                                                                ]
                                                                                                                                ],
                                                                                                                                'properties' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'id' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'dataset' => '<unknown>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'propertyType' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'id' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'isAutomatic' => true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'isPlural' => true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'isSortable' => true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'position' => 123
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'name' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'isUsedAsTitle' => true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'isRequired' => true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'parameters' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'position' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'options' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'id' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'property' => '<unknown>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'text' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'color' => 123
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                ]
                                                                                                                                ],
                                                                                                                                'representations' => '<array>'
                                                                ],
                                                                'representationType' => [
                                                                                                                                'id' => '<string>',
                                                                                                                                'isAggregated' => true,
                                                                                                                                'position' => 123
                                                                ],
                                                                'name' => '<string>',
                                                                'parameters' => '<string>',
                                                                'position' => 123
                                ]
                ]
        ]
    ],
    'datasets' => [
        [
                'id' => 123,
                'name' => '<string>',
                'isDisabled' => true,
                'position' => 123,
                'path' => '<string>',
                'states' => [
                                [
                                                                'id' => 123,
                                                                'dataset' => '<unknown>',
                                                                'name' => '<string>',
                                                                'color' => 123,
                                                                'position' => 123
                                ]
                ],
                'properties' => [
                                [
                                                                'id' => 123,
                                                                'dataset' => '<unknown>',
                                                                'propertyType' => [
                                                                                                                                'id' => '<string>',
                                                                                                                                'isAutomatic' => true,
                                                                                                                                'isPlural' => true,
                                                                                                                                'isSortable' => true,
                                                                                                                                'position' => 123
                                                                ],
                                                                'name' => '<string>',
                                                                'isUsedAsTitle' => true,
                                                                'isRequired' => true,
                                                                'parameters' => '<string>',
                                                                'position' => 123,
                                                                'options' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'id' => 123,
                                                                                                                                                                                                                                                                'property' => '<unknown>',
                                                                                                                                                                                                                                                                'text' => '<string>',
                                                                                                                                                                                                                                                                'color' => 123
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'representations' => '<array>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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.example.com/v1/workspaces"

	payload := strings.NewReader("{\n  \"id\": 123,\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"price\": 123,\n    \"maxUsersNumber\": 123,\n    \"maxRecordsNumber\": 123,\n    \"maxAutomationsNumber\": 123,\n    \"maxStorage\": 123\n  },\n  \"promocode\": {\n    \"id\": \"<string>\",\n    \"partner\": {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"promocodes\": \"<array>\"\n    },\n    \"discount\": 123,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"expires\": \"2023-11-07T05:31:56Z\"\n  },\n  \"dashboards\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"isDisabled\": true,\n      \"position\": 123,\n      \"path\": \"<string>\",\n      \"representations\": [\n        {\n          \"id\": 123,\n          \"dashboard\": \"<unknown>\",\n          \"dataset\": {\n            \"id\": 123,\n            \"name\": \"<string>\",\n            \"isDisabled\": true,\n            \"position\": 123,\n            \"path\": \"<string>\",\n            \"states\": [\n              {\n                \"id\": 123,\n                \"dataset\": \"<unknown>\",\n                \"name\": \"<string>\",\n                \"color\": 123,\n                \"position\": 123\n              }\n            ],\n            \"properties\": [\n              {\n                \"id\": 123,\n                \"dataset\": \"<unknown>\",\n                \"propertyType\": {\n                  \"id\": \"<string>\",\n                  \"isAutomatic\": true,\n                  \"isPlural\": true,\n                  \"isSortable\": true,\n                  \"position\": 123\n                },\n                \"name\": \"<string>\",\n                \"isUsedAsTitle\": true,\n                \"isRequired\": true,\n                \"parameters\": \"<string>\",\n                \"position\": 123,\n                \"options\": [\n                  {\n                    \"id\": 123,\n                    \"property\": \"<unknown>\",\n                    \"text\": \"<string>\",\n                    \"color\": 123\n                  }\n                ]\n              }\n            ],\n            \"representations\": \"<array>\"\n          },\n          \"representationType\": {\n            \"id\": \"<string>\",\n            \"isAggregated\": true,\n            \"position\": 123\n          },\n          \"name\": \"<string>\",\n          \"parameters\": \"<string>\",\n          \"position\": 123\n        }\n      ]\n    }\n  ],\n  \"datasets\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"isDisabled\": true,\n      \"position\": 123,\n      \"path\": \"<string>\",\n      \"states\": [\n        {\n          \"id\": 123,\n          \"dataset\": \"<unknown>\",\n          \"name\": \"<string>\",\n          \"color\": 123,\n          \"position\": 123\n        }\n      ],\n      \"properties\": [\n        {\n          \"id\": 123,\n          \"dataset\": \"<unknown>\",\n          \"propertyType\": {\n            \"id\": \"<string>\",\n            \"isAutomatic\": true,\n            \"isPlural\": true,\n            \"isSortable\": true,\n            \"position\": 123\n          },\n          \"name\": \"<string>\",\n          \"isUsedAsTitle\": true,\n          \"isRequired\": true,\n          \"parameters\": \"<string>\",\n          \"position\": 123,\n          \"options\": [\n            {\n              \"id\": 123,\n              \"property\": \"<unknown>\",\n              \"text\": \"<string>\",\n              \"color\": 123\n            }\n          ]\n        }\n      ],\n      \"representations\": \"<array>\"\n    }\n  ]\n}")

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

	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.example.com/v1/workspaces")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"id\": 123,\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"price\": 123,\n    \"maxUsersNumber\": 123,\n    \"maxRecordsNumber\": 123,\n    \"maxAutomationsNumber\": 123,\n    \"maxStorage\": 123\n  },\n  \"promocode\": {\n    \"id\": \"<string>\",\n    \"partner\": {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"promocodes\": \"<array>\"\n    },\n    \"discount\": 123,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"expires\": \"2023-11-07T05:31:56Z\"\n  },\n  \"dashboards\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"isDisabled\": true,\n      \"position\": 123,\n      \"path\": \"<string>\",\n      \"representations\": [\n        {\n          \"id\": 123,\n          \"dashboard\": \"<unknown>\",\n          \"dataset\": {\n            \"id\": 123,\n            \"name\": \"<string>\",\n            \"isDisabled\": true,\n            \"position\": 123,\n            \"path\": \"<string>\",\n            \"states\": [\n              {\n                \"id\": 123,\n                \"dataset\": \"<unknown>\",\n                \"name\": \"<string>\",\n                \"color\": 123,\n                \"position\": 123\n              }\n            ],\n            \"properties\": [\n              {\n                \"id\": 123,\n                \"dataset\": \"<unknown>\",\n                \"propertyType\": {\n                  \"id\": \"<string>\",\n                  \"isAutomatic\": true,\n                  \"isPlural\": true,\n                  \"isSortable\": true,\n                  \"position\": 123\n                },\n                \"name\": \"<string>\",\n                \"isUsedAsTitle\": true,\n                \"isRequired\": true,\n                \"parameters\": \"<string>\",\n                \"position\": 123,\n                \"options\": [\n                  {\n                    \"id\": 123,\n                    \"property\": \"<unknown>\",\n                    \"text\": \"<string>\",\n                    \"color\": 123\n                  }\n                ]\n              }\n            ],\n            \"representations\": \"<array>\"\n          },\n          \"representationType\": {\n            \"id\": \"<string>\",\n            \"isAggregated\": true,\n            \"position\": 123\n          },\n          \"name\": \"<string>\",\n          \"parameters\": \"<string>\",\n          \"position\": 123\n        }\n      ]\n    }\n  ],\n  \"datasets\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"isDisabled\": true,\n      \"position\": 123,\n      \"path\": \"<string>\",\n      \"states\": [\n        {\n          \"id\": 123,\n          \"dataset\": \"<unknown>\",\n          \"name\": \"<string>\",\n          \"color\": 123,\n          \"position\": 123\n        }\n      ],\n      \"properties\": [\n        {\n          \"id\": 123,\n          \"dataset\": \"<unknown>\",\n          \"propertyType\": {\n            \"id\": \"<string>\",\n            \"isAutomatic\": true,\n            \"isPlural\": true,\n            \"isSortable\": true,\n            \"position\": 123\n          },\n          \"name\": \"<string>\",\n          \"isUsedAsTitle\": true,\n          \"isRequired\": true,\n          \"parameters\": \"<string>\",\n          \"position\": 123,\n          \"options\": [\n            {\n              \"id\": 123,\n              \"property\": \"<unknown>\",\n              \"text\": \"<string>\",\n              \"color\": 123\n            }\n          ]\n        }\n      ],\n      \"representations\": \"<array>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workspaces")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"id\": 123,\n  \"name\": \"<string>\",\n  \"plan\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"price\": 123,\n    \"maxUsersNumber\": 123,\n    \"maxRecordsNumber\": 123,\n    \"maxAutomationsNumber\": 123,\n    \"maxStorage\": 123\n  },\n  \"promocode\": {\n    \"id\": \"<string>\",\n    \"partner\": {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"promocodes\": \"<array>\"\n    },\n    \"discount\": 123,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"expires\": \"2023-11-07T05:31:56Z\"\n  },\n  \"dashboards\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"isDisabled\": true,\n      \"position\": 123,\n      \"path\": \"<string>\",\n      \"representations\": [\n        {\n          \"id\": 123,\n          \"dashboard\": \"<unknown>\",\n          \"dataset\": {\n            \"id\": 123,\n            \"name\": \"<string>\",\n            \"isDisabled\": true,\n            \"position\": 123,\n            \"path\": \"<string>\",\n            \"states\": [\n              {\n                \"id\": 123,\n                \"dataset\": \"<unknown>\",\n                \"name\": \"<string>\",\n                \"color\": 123,\n                \"position\": 123\n              }\n            ],\n            \"properties\": [\n              {\n                \"id\": 123,\n                \"dataset\": \"<unknown>\",\n                \"propertyType\": {\n                  \"id\": \"<string>\",\n                  \"isAutomatic\": true,\n                  \"isPlural\": true,\n                  \"isSortable\": true,\n                  \"position\": 123\n                },\n                \"name\": \"<string>\",\n                \"isUsedAsTitle\": true,\n                \"isRequired\": true,\n                \"parameters\": \"<string>\",\n                \"position\": 123,\n                \"options\": [\n                  {\n                    \"id\": 123,\n                    \"property\": \"<unknown>\",\n                    \"text\": \"<string>\",\n                    \"color\": 123\n                  }\n                ]\n              }\n            ],\n            \"representations\": \"<array>\"\n          },\n          \"representationType\": {\n            \"id\": \"<string>\",\n            \"isAggregated\": true,\n            \"position\": 123\n          },\n          \"name\": \"<string>\",\n          \"parameters\": \"<string>\",\n          \"position\": 123\n        }\n      ]\n    }\n  ],\n  \"datasets\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"isDisabled\": true,\n      \"position\": 123,\n      \"path\": \"<string>\",\n      \"states\": [\n        {\n          \"id\": 123,\n          \"dataset\": \"<unknown>\",\n          \"name\": \"<string>\",\n          \"color\": 123,\n          \"position\": 123\n        }\n      ],\n      \"properties\": [\n        {\n          \"id\": 123,\n          \"dataset\": \"<unknown>\",\n          \"propertyType\": {\n            \"id\": \"<string>\",\n            \"isAutomatic\": true,\n            \"isPlural\": true,\n            \"isSortable\": true,\n            \"position\": 123\n          },\n          \"name\": \"<string>\",\n          \"isUsedAsTitle\": true,\n          \"isRequired\": true,\n          \"parameters\": \"<string>\",\n          \"position\": 123,\n          \"options\": [\n            {\n              \"id\": 123,\n              \"property\": \"<unknown>\",\n              \"text\": \"<string>\",\n              \"color\": 123\n            }\n          ]\n        }\n      ],\n      \"representations\": \"<array>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "dataset": {
    "id": 123,
    "name": "<string>",
    "isDisabled": true,
    "position": 123,
    "path": "<string>",
    "states": "<array>",
    "properties": [
      {
        "id": 123,
        "dataset": "<unknown>",
        "propertyType": {
          "id": "<string>",
          "isAutomatic": true,
          "isPlural": true,
          "isSortable": true,
          "position": 123
        },
        "name": "<string>",
        "isUsedAsTitle": true,
        "isRequired": true,
        "parameters": "<string>",
        "position": 123,
        "options": [
          {
            "id": 123,
            "property": "<unknown>",
            "text": "<string>",
            "color": 123
          }
        ]
      }
    ],
    "representations": [
      {
        "id": 123,
        "dashboard": {
          "id": 123,
          "name": "<string>",
          "isDisabled": true,
          "position": 123,
          "path": "<string>",
          "representations": "<array>"
        },
        "dataset": "<unknown>",
        "representationType": {
          "id": "<string>",
          "isAggregated": true,
          "position": 123
        },
        "name": "<string>",
        "parameters": "<string>",
        "position": 123
      }
    ]
  },
  "name": "<string>",
  "color": 123,
  "position": 123
}

Body

id
integer<int32>
name
string | null
plan
object
promocode
object
dashboards
object[] | null
datasets
object[] | null

Response

OK

id
integer<int32>
dataset
object
name
string | null
color
integer<int64>
position
integer<int32>