Skip to content
Patrimoine
v9.1.0

Initialize Dashboards Endpoint

POST
/api/v1/dashboards/initialize
curl --request POST \
  --url https://example.com/api/v1/dashboards/initialize \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "layout": { "cards": [ { "id": "example", "x": 1, "y": 1, "w": 1, "h": 1 } ], "hidden": [ "example" ] } }'

201 with the new list when the caller had no dashboard, else 200 with the existing list.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
DashboardInitialize

The first dashboard a browser uploads: a name and the layout it already holds.

object
name
required
Name
string
>= 1 characters <= 40 characters
layout
DashboardLayout

The placed cards and the ids of the cards the user hid.

object
cards
Cards
Array<object>
<= 64 items
DashboardCard

One card placed on the grid: its id and its cell rectangle.

object
id
required
Id
string
/^[a-z0-9][a-z0-9-]{0,39}$/
x
required
X
integer
y
required
Y
integer
<= 1000
w
required
W
integer
>= 1 <= 12
h
required
H
integer
>= 1 <= 50
hidden
Hidden
Array<string>
<= 64 items

Example generated

{
  "name": "example",
  "layout": {
    "cards": [
      {
        "id": "example",
        "x": 1,
        "y": 1,
        "w": 1,
        "h": 1
      }
    ],
    "hidden": [
      "example"
    ]
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Initialize Dashboards Endpoint Api V1 Dashboards Initialize Post
Array<object>
DashboardOut
object
id
required
Id
integer
name
required
Name
string
sort_order
required
Sort Order
integer
layout
required
DashboardLayout

The placed cards and the ids of the cards the user hid.

object
cards
Cards
Array<object>
<= 64 items
DashboardCard

One card placed on the grid: its id and its cell rectangle.

object
id
required
Id
string
/^[a-z0-9][a-z0-9-]{0,39}$/
x
required
X
integer
y
required
Y
integer
<= 1000
w
required
W
integer
>= 1 <= 12
h
required
H
integer
>= 1 <= 50
hidden
Hidden
Array<string>
<= 64 items
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Example generated

[
  {
    "id": 1,
    "name": "example",
    "sort_order": 1,
    "layout": {
      "cards": [
        {
          "id": "example",
          "x": 1,
          "y": 1,
          "w": 1,
          "h": 1
        }
      ],
      "hidden": [
        "example"
      ]
    },
    "created_at": "2026-04-15T12:00:00Z",
    "updated_at": "2026-04-15T12:00:00Z"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}