Endpoints

GET /space-settings/:spaceIndex

Description

Retrieves the space settings for a given space index.

Request

• URL Parameters:

spaceIndex

(string): The unique index of the space.

Response

• Status Code: 202 Accepted

• Body:

  {
    "isHandlerVisible": boolean,
    "spaceIndex": string,
    "documentIndexes": string[],
    "mediaIndexes": string[],
    "isModelVisible": boolean,
    "componentIndexes": string[],
    "selectedComponentIndex": string | null
  }

POST /space-settings

Description

Creates new space settings.

Request

• Body:

  {
    "isHandlerVisible": boolean,
    "spaceIndex": string
  }

Response

• Status Code: 202 Accepted

• Body:

  {
    "isHandlerVisible": boolean,
    "spaceIndex": string,
    "documentIndexes": string[],
    "mediaIndexes": string[],
    "isModelVisible": boolean,
    "componentIndexes": string[],
    "selectedComponentIndex": string | null
  }

PATCH /space-settings

Description

Updates existing space settings.

Request

• Body:

  {
    "spaceIndex": string,
    "isHandlerVisible": boolean,
    "isModelVisible": boolean,
    "isModelListVisible": boolean,
    "selectedComponentIndex": string,
    "documentIndexes": string[],
    "componentIndexes": string[],
    "mediaIndexes": string[]
  }

Response

• Status Code: 202 Accepted

• Body:

  {
    "isHandlerVisible": boolean,
    "spaceIndex": string,
    "documentIndexes": string[],
    "mediaIndexes": string[],
    "isModelVisible": boolean,
    "componentIndexes": string[],
    "selectedComponentIndex": string | null
  }

Example Usage

Retrieve Space Settings

Request:

GET /space-settings/space123

Response:

{
  "isHandlerVisible": true,
  "spaceIndex": "space123",
  "documentIndexes": ["doc1", "doc2"],
  "mediaIndexes": ["media1", "media2"],
  "isModelVisible": true,
  "componentIndexes": ["comp1", "comp2"],
  "selectedComponentIndex": "comp1"
}

Create Space Settings

Request:

POST /space-settings
Content-Type: application/json

{
  "isHandlerVisible": true,
  "spaceIndex": "space123"
}

Response:

{
  "isHandlerVisible": true,
  "spaceIndex": "space123",
  "documentIndexes": [],
  "mediaIndexes": [],
  "isModelVisible": false,
  "componentIndexes": [],
  "selectedComponentIndex": null
}

Update Space Settings

Request:

PATCH /space-settings
Content-Type: application/json

{
  "spaceIndex": "space123",
  "isHandlerVisible": false,
  "isModelVisible": true,
  "isModelListVisible": true,
  "selectedComponentIndex": "comp2",
  "documentIndexes": ["doc3"],
  "componentIndexes": ["comp2"],
  "mediaIndexes": ["media3"]
}

Response:

{
  "isHandlerVisible": false,
  "spaceIndex": "space123",
  "documentIndexes": ["doc3"],
  "mediaIndexes": ["media3"],
  "isModelVisible": true,
  "componentIndexes": ["comp2"],
  "selectedComponentIndex": "comp2"
}