> For the complete documentation index, see [llms.txt](https://documentation.ocsinventory-ng.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.ocsinventory-ng.org/open-api-reference/dashboard.md).

# Dashboard

## GET /dashboard/chart/

> Return the list of available dashboard charts.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PaginatedDashboardChartDescriptorList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}}},"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}},"paths":{"/dashboard/chart/":{"get":{"operationId":"dashboard_chart_list","description":"Return the list of available dashboard charts.","parameters":[{"in":"query","name":"agent","schema":{"type":"string"}},{"in":"query","name":"description","schema":{"type":"string"}},{"in":"query","name":"domain","schema":{"type":"string"}},{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"query","name":"is_template_forced","schema":{"type":"boolean"}},{"in":"query","name":"last_update","schema":{"type":"string","format":"date-time"}},{"name":"limit","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"in":"query","name":"name","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","description":"The initial index from which to return the results.","schema":{"type":"integer"}},{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"osname","schema":{"type":"string"}},{"in":"query","name":"osversion","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}},{"in":"query","name":"serial","schema":{"type":"string"}},{"in":"query","name":"srcip","schema":{"type":"string"}},{"in":"query","name":"srcmac","schema":{"type":"string"}},{"in":"query","name":"template","schema":{"type":"integer"}},{"in":"query","name":"uuid","schema":{"type":"string"}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDashboardChartDescriptorList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaginatedDashboardChartDescriptorList"}}},"description":""}}}}}}
```

## POST /dashboard/chart/

> Handle post request, suitable for single and multi creation\
> \
> Args:\
>     request (\[dict]): can be dict or list of dicts\
> \
> Returns:\
>     \[type]: \[description]

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}},"paths":{"/dashboard/chart/":{"post":{"operationId":"dashboard_chart_create","description":"Handle post request, suitable for single and multi creation\n\nArgs:\n    request ([dict]): can be dict or list of dicts\n\nReturns:\n    [type]: [description]","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}},"description":""}}}}}}
```

## GET /dashboard/chart/{id}/

> This class allows the frontend to request data for the dashboard charts

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}},"paths":{"/dashboard/chart/{id}/":{"get":{"operationId":"dashboard_chart_retrieve","description":"This class allows the frontend to request data for the dashboard charts","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this inventory base.","required":true}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}},"description":""}}}}}}
```

## PUT /dashboard/chart/{id}/

> This class allows the frontend to request data for the dashboard charts

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}},"paths":{"/dashboard/chart/{id}/":{"put":{"operationId":"dashboard_chart_update","description":"This class allows the frontend to request data for the dashboard charts","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this inventory base.","required":true}],"tags":["dashboard"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}},"description":""}}}}}}
```

## DELETE /dashboard/chart/{id}/

> This class allows the frontend to request data for the dashboard charts

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}}},"paths":{"/dashboard/chart/{id}/":{"delete":{"operationId":"dashboard_chart_destroy","description":"This class allows the frontend to request data for the dashboard charts","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this inventory base.","required":true}],"tags":["dashboard"],"responses":{"204":{"description":"No response body"}}}}}}
```

## PATCH /dashboard/chart/{id}/

> This class allows the frontend to request data for the dashboard charts

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PatchedDashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}}},"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}},"paths":{"/dashboard/chart/{id}/":{"patch":{"operationId":"dashboard_chart_partial_update","description":"This class allows the frontend to request data for the dashboard charts","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this inventory base.","required":true}],"tags":["dashboard"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedDashboardChartDescriptor"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedDashboardChartDescriptor"}},"application/json":{"schema":{"$ref":"#/components/schemas/PatchedDashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchedDashboardChartDescriptor"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}},"description":""}}}}}}
```

## GET /dashboard/chart/lastcontacted/

> Devices count per last contacted date (7 days).

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartSeries":{"type":"object","description":"Response shape shared by the series-based charts\n(oscount, lastcontacted, networks)","properties":{"options":{},"series":{}},"required":["options","series"]}}},"paths":{"/dashboard/chart/lastcontacted/":{"get":{"operationId":"dashboard_chart_lastcontacted_retrieve","description":"Devices count per last contacted date (7 days).","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartSeries"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartSeries"}}},"description":""}}}}}}
```

## GET /dashboard/chart/nb\_netdevices/

> Total netdevices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartTotal":{"type":"object","description":"Response shape for the simple totals (nb_netdevices, nb_networks)","properties":{"total":{"type":"integer"}},"required":["total"]}}},"paths":{"/dashboard/chart/nb_netdevices/":{"get":{"operationId":"dashboard_chart_nb_netdevices_retrieve","description":"Total netdevices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartTotal"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartTotal"}}},"description":""}}}}}}
```

## GET /dashboard/chart/nb\_networks/

> Total networks count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartTotal":{"type":"object","description":"Response shape for the simple totals (nb_netdevices, nb_networks)","properties":{"total":{"type":"integer"}},"required":["total"]}}},"paths":{"/dashboard/chart/nb_networks/":{"get":{"operationId":"dashboard_chart_nb_networks_retrieve","description":"Total networks count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartTotal"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartTotal"}}},"description":""}}}}}}
```

## GET /dashboard/chart/networks/

> Devices count per network.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartSeries":{"type":"object","description":"Response shape shared by the series-based charts\n(oscount, lastcontacted, networks)","properties":{"options":{},"series":{}},"required":["options","series"]}}},"paths":{"/dashboard/chart/networks/":{"get":{"operationId":"dashboard_chart_networks_retrieve","description":"Devices count per network.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartSeries"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartSeries"}}},"description":""}}}}}}
```

## GET /dashboard/chart/oscount/

> Unique OS names and their associated count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartSeries":{"type":"object","description":"Response shape shared by the series-based charts\n(oscount, lastcontacted, networks)","properties":{"options":{},"series":{}},"required":["options","series"]}}},"paths":{"/dashboard/chart/oscount/":{"get":{"operationId":"dashboard_chart_oscount_retrieve","description":"Unique OS names and their associated count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartSeries"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartSeries"}}},"description":""}}}}}}
```

## GET /dashboard/chart/total\_ALL/

> Total devices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}},"paths":{"/dashboard/chart/total_ALL/":{"get":{"operationId":"dashboard_chart_total_ALL_retrieve","description":"Total devices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}}},"description":""}}}}}}
```

## GET /dashboard/chart/total\_LEG/

> Total Legacy devices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}},"paths":{"/dashboard/chart/total_LEG/":{"get":{"operationId":"dashboard_chart_total_LEG_retrieve","description":"Total Legacy devices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}}},"description":""}}}}}}
```

## GET /dashboard/chart/total\_LIN/

> Total Linux devices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}},"paths":{"/dashboard/chart/total_LIN/":{"get":{"operationId":"dashboard_chart_total_LIN_retrieve","description":"Total Linux devices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}}},"description":""}}}}}}
```

## GET /dashboard/chart/total\_MAC/

> Total MacOS devices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}},"paths":{"/dashboard/chart/total_MAC/":{"get":{"operationId":"dashboard_chart_total_MAC_retrieve","description":"Total MacOS devices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}}},"description":""}}}}}}
```

## GET /dashboard/chart/total\_SNMP/

> Total SNMP devices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}},"paths":{"/dashboard/chart/total_SNMP/":{"get":{"operationId":"dashboard_chart_total_SNMP_retrieve","description":"Total SNMP devices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}}},"description":""}}}}}}
```

## GET /dashboard/chart/total\_WIN/

> Total Windows devices count.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}},"paths":{"/dashboard/chart/total_WIN/":{"get":{"operationId":"dashboard_chart_total_WIN_retrieve","description":"Total Windows devices count.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardChartCounter"}}},"description":""}}}}}}
```

## GET /dashboard/layout/

> this class will permit the frontend server to manage configuration\
> for the dashboard.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PaginatedDashboardLayoutList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DashboardLayout"}}}},"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}},"paths":{"/dashboard/layout/":{"get":{"operationId":"dashboard_layout_list","description":"this class will permit the frontend server to manage configuration\nfor the dashboard.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"name":"limit","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"name":"offset","required":false,"in":"query","description":"The initial index from which to return the results.","schema":{"type":"integer"}}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDashboardLayoutList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaginatedDashboardLayoutList"}}},"description":""}}}}}}
```

## POST /dashboard/layout/

> Handle post request, suitable for single and multi creation\
> \
> Args:\
>     request (\[dict]): can be dict or list of dicts\
> \
> Returns:\
>     \[type]: \[description]

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}},"paths":{"/dashboard/layout/":{"post":{"operationId":"dashboard_layout_create","description":"Handle post request, suitable for single and multi creation\n\nArgs:\n    request ([dict]): can be dict or list of dicts\n\nReturns:\n    [type]: [description]","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"tags":["dashboard"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/json":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}}},"description":""}}}}}}
```

## GET /dashboard/layout/{id}/

> this class will permit the frontend server to manage configuration\
> for the dashboard.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}},"paths":{"/dashboard/layout/{id}/":{"get":{"operationId":"dashboard_layout_retrieve","description":"this class will permit the frontend server to manage configuration\nfor the dashboard.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this dashboard layout.","required":true}],"tags":["dashboard"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}}},"description":""}}}}}}
```

## PUT /dashboard/layout/{id}/

> this class will permit the frontend server to manage configuration\
> for the dashboard.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}},"paths":{"/dashboard/layout/{id}/":{"put":{"operationId":"dashboard_layout_update","description":"this class will permit the frontend server to manage configuration\nfor the dashboard.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this dashboard layout.","required":true}],"tags":["dashboard"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/json":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}}},"description":""}}}}}}
```

## DELETE /dashboard/layout/{id}/

> this class will permit the frontend server to manage configuration\
> for the dashboard.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}}},"paths":{"/dashboard/layout/{id}/":{"delete":{"operationId":"dashboard_layout_destroy","description":"this class will permit the frontend server to manage configuration\nfor the dashboard.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this dashboard layout.","required":true}],"tags":["dashboard"],"responses":{"204":{"description":"No response body"}}}}}}
```

## PATCH /dashboard/layout/{id}/

> this class will permit the frontend server to manage configuration\
> for the dashboard.

```json
{"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"security":[{"knoxApiToken":[]}],"components":{"securitySchemes":{"knoxApiToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PatchedDashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}}},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"},"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]}}},"paths":{"/dashboard/layout/{id}/":{"patch":{"operationId":"dashboard_layout_partial_update","description":"this class will permit the frontend server to manage configuration\nfor the dashboard.","parameters":[{"in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}},{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this dashboard layout.","required":true}],"tags":["dashboard"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedDashboardLayout"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedDashboardLayout"}},"application/json":{"schema":{"$ref":"#/components/schemas/PatchedDashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PatchedDashboardLayout"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DashboardLayout"}}},"description":""}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.ocsinventory-ng.org/open-api-reference/dashboard.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.