POST

/api/v1/windows/arrange

Arrange open profile windows (grid: equal tiles, cascade: overlapping offsets) within a screen area (coordinates in device-independent pixels)

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/windows/arrange" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: runtime:control

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

Required.

Field	Type	Required
`mode`	`union`	Yes
`area`	`object`	Yes
`profile_ids`	`array`	No
`columns`	`integer`	No
`gap`	`integer`	No

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "mode",
          "area"
        ],
        "properties": {
          "mode": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "grid"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "cascade"
                ]
              }
            ]
          },
          "area": {
            "type": "object",
            "required": [
              "x",
              "y",
              "width",
              "height"
            ],
            "properties": {
              "x": {
                "type": "integer",
                "minimum": -100000,
                "maximum": 100000
              },
              "y": {
                "type": "integer",
                "minimum": -100000,
                "maximum": 100000
              },
              "width": {
                "type": "integer",
                "minimum": 200,
                "maximum": 100000
              },
              "height": {
                "type": "integer",
                "minimum": 200,
                "maximum": 100000
              }
            },
            "additionalProperties": false
          },
          "profile_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "minItems": 1,
            "maxItems": 200
          },
          "columns": {
            "type": "integer",
            "minimum": 1,
            "maximum": 20
          },
          "gap": {
            "type": "integer",
            "minimum": 0,
            "maximum": 200
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "results"
        ],
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "profile_id",
                "profile_no",
                "ok",
                "error"
              ],
              "properties": {
                "profile_id": {
                  "type": "string"
                },
                "profile_no": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "ok": {
                  "type": "boolean"
                },
                "error": {
                  "type": [
                    "null",
                    "string"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Fenster geöffneter Profile anordnen (grid: gleich große Kacheln, cascade: versetzt übereinander) in einem Bildschirmbereich (Koordinaten in geräteunabhängigen Pixeln)",
  "tags": [
    "Laufzeit"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "mode",
            "area"
          ],
          "properties": {
            "mode": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "grid"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "cascade"
                  ]
                }
              ]
            },
            "area": {
              "type": "object",
              "required": [
                "x",
                "y",
                "width",
                "height"
              ],
              "properties": {
                "x": {
                  "type": "integer",
                  "minimum": -100000,
                  "maximum": 100000
                },
                "y": {
                  "type": "integer",
                  "minimum": -100000,
                  "maximum": 100000
                },
                "width": {
                  "type": "integer",
                  "minimum": 200,
                  "maximum": 100000
                },
                "height": {
                  "type": "integer",
                  "minimum": 200,
                  "maximum": 100000
                }
              },
              "additionalProperties": false
            },
            "profile_ids": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64
              },
              "minItems": 1,
              "maxItems": 200
            },
            "columns": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20
            },
            "gap": {
              "type": "integer",
              "minimum": 0,
              "maximum": 200
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "runtime:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "results"
            ],
            "properties": {
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "profile_id",
                    "profile_no",
                    "ok",
                    "error"
                  ],
                  "properties": {
                    "profile_id": {
                      "type": "string"
                    },
                    "profile_no": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "ok": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": [
                        "null",
                        "string"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}