Skip to content

Commit a3cff01

Browse files
committed
Update REST API documentation
1 parent dd608d3 commit a3cff01

File tree

67 files changed

+850
-95
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+850
-95
lines changed

docs/rest-api/create-alarm.api.mdx

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/rest-api/create-asset.api.mdx

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

docs/rest-api/create-dashboard.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Create a dashboard"
55
sidebar_label: "Create a dashboard"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJztWVFz4jYQ/iuefWpnDHa4S6/1UzlCLswlgRJyaZthMoq9gC625JNEgGP4752VMTbg3IW0nWlnkgdirN3VarXa79OyBMPGGoJbOGF6ci+ZimDogkxRMcOl6EQQQKiQGSwEXEiZYgkaVKS6BMEShACaUzORin+1muACFxDABFmEClzQ4QQTBsESzCIlcW0UF2NYrdyNhd9rp1LNmIowqvWUNPJvWzmT2hxgZOiCwi9T1Oa9jBYkEUphUBh6ZGka89CuzvuspaB3hSnS4wojCqbBJI2ZQYrlegp5/xlDciVVFF3DUZMWjyrccNchj7pif9SFkVQJMxBAxAzWDE+QVBSyOCHxhM3PUYzNBILG8bELCRf59yN3f6pHVJrL8kRcGBzbQG1m4sL89Jak5Uyg6lQ7zcIQta7yGMU0obj0rt+fd1rgwtVZs98+ARd6/c6n5qANw5ULEddpzBaXdheX3/N7E+Od2OtQIYqeQo1Gv3wDZDxNhF77wRPyv/CiOkJvGqSZsPmVdeGGR+T7wQYUjhTqSUcYVI8s/lY8u6en4EL3sn130bkEF047n/LH366b/UG7vx4+6173bYy3o1OYZkqxBR0Ug4neDymLuRhnWi8O6WHbe6+QPaSSZ0fvwBBuO/yNAN70m727QffuqnP54bx91+qeX19Q9D6227278+Yf3esBuNBvn3T67RY9vj/vtj7enbQ/dVpZ0iqMuMLQbMpj5eGgfOUmplcbwavSVliJGY/GB+xKOZ4ujBWPOgYTyO0MFil2on9qt/bGN/MVg4dNMP9uxcn2cvFMudkL8uQlxzPh4uyZLiVc3DxftMfnGB9g2so/176QfdT8a3kv76WMkYls9EI+PjEWy/ABo6qxqqT+kKfFaicPq1IgE2hJMeLj/TyqtH9jVWBVOTjIIaFylJTsgdWpFDrLzYbv078Idah4anlLABGO2DQ2Ti4J7isLeGUBryzglQW8soBXFvDKAv7/LIAyewvyWxZpHeZEpS5HgmYiqQGSZk2ElFGZAq8so1E95m2QqYqpy2BMqgPPizCRdZmiUJhIg3UuPZZyb2kReuWBC49McXYf4/pMr4F7zT4ggIRpg4ocHtJE4VRxs7AzkVk6ULfD8tAVsZDMWi5QRJNNzaRBSRHLmRUJY47CtBRGKAxncVZx5AOKa7sOjzQ865b2Mle8lHoyoYy9zH4tlEJgaDyrBhvQerkBHco0W0Gq5IjbrcufaNdYucXUkpHN1q2Xh89NouD+x5duc5boZr9oT7XnLEljzKtrgWsl3ggNv/G25r+rNX4ZHB0Hx0dB4+e6/+7oT9hwxUJvQwL9EsUrhnNmVxC4LXgoBMukbMeznFD5+xTJryA9a26zw1dud80+4UeZPfh7fOBJ2K8E803BGpYg+rmOlGFyW2FuPVvYz5n9zCKR4Yufo4e/hQ3+VuX3y3XdqCkWlTz7ltdu+rZXkAtXdurwajWknONiJG1lWBfSboqibyuac8EEG6Ny+u2rgdPsdWC3qg4mXDtcO2aCTiTDaYLC2EPqjKSybyusnQ0GvY3JuuP0YmQaHY1oNW63DA1/2JRbGertcvujnSWRCh1aRH19jWOh5YKYMB5bbBzJX7f0LNzxEOnmFxTN7Q+9c+dN3Qd3p87PZrP6WEzrUo29tZr22DiNa2/qfh1FfWKSeOuKBTTg0ysCloSJ0jSVQLQV1U1JNzg3XhozbgHaOrVcY9QtROV2/oTwK7iF5fKeabxW8WpFr79MURGeDAsospDi5p1yyu+IaxqIIBixWOOeM5ubMYBb7dkDLp5o7T+yeEryQM37f2Oidfd/a55MqpVZq9ExKEnsXe4LjWYYYmq+KTsscYZe94puCvfrnxESi1Wg2IwKDJtly5B2dRn+M0tdYybGUzYm2cwm/f0FQoqmDA==
8+
api: eJztWW1z4jYQ/iue/dTOGOxwl17rT+UIuTBNAuXl0jbDZBR7AV1sySeJEI7hv3dWBmyDkyZpO9OZJh+Ibe2bVqt9HssrMGyqIbiGE6Znt5KpCMYuyBQVM1yKTgQBhAqZwVzAhZQplqBBRaorECxBCKA5NzOp+DerCS5wAQHMkEWowAUdzjBhEKzALFMS10ZxMYX12t1Z+K12KtWCqQijWk9JI/+2lTOpzQuMjF1Q+HWO2nyU0ZIkQikMCkOXLE1jHtrZeV+0FPQsN0V6XGFEyYy4TmO2vKR4yCKLE3DBYJLGzCBleONY3n7BkAJMFeXccNRki0cVwbmbhYi64nDUhYlUCTMQQMQM1gxPkFQy38EKEvZwjmJqZhA0jo9dSLjY3h+5h67uUWkui464MDi16dt54sL88J6k5UKg6lQHzcIQta6KGMU8oWz1Rh/POy1wYXDW7LdPwIVev/O5OWzDeO2WcknzeDruXY73VkSHClH0FGo0+vULION5IvQmDp5Q/HkU1Rl61yDNhD0MbAhXPKLYX2xA4UShnnWEQXXP4qfy2T09BRe6l+2bi84luHDa+by9/HXU7A/b/c3wWXfUtzkuZyc3zZRiS9o+BhP9dJHrkMVcTDMbr07wyxb7ViG7SyXPtucLE1oO+Il0XvWbvZth92bQufx03r5pdc9HF5TLX9rt3s158/fuaAgu9NsnnX67RZcfz7utX25O2p87rayEFUZcYWh2LbRyq1D1chPTo53goLAwVmLBo+mr12iqeNQxSL0oszNcptiJ/qnVOhjf+csHX+bg4S/7T7aWy2fKLV5RJ6/ZrAkXZ88MKeHi6vmiPf6A8QtMW/nn2heyj5p/K67lrZQxMpGNXsj7R8ZiGd5hVDVWVdSftmWx3qvDqhLIBFpSTPj0sI4q7V9ZFVhXDg63AFE5Skp2w+pUCp3VZsP36V+EOlQ8tdwmgAgnbB4bZysJ7htTeGMKb0zhjSm8MYU3pvDGFP4fTIEqu0QLWhZ3HeZEhdOSBM1M0kFKmh1GpIzaFHhFGY3qfnucMlcxnVYYk+rA8yJMZF2mKBQm0mCdS4+l3FtZvF574MI9U5zdxrjZ0xsY3zAUCCBh2qCigMfkKJwrbpbWE5mlDXU9Lg4NiKlk1rYCeTbZ3MwaVBSxXFiRMOYoTEthhMJwFmcdR96hGNl5eKTh2bC0l4XipXS2E8rYy+zXQikEhsazarCDsNcb0KFMsxmkSk64XbrtFa0aKx5VtWRkq7X08OW+SZS423966rZmiZL282Ou9gNL0hi33TXHtQKLhIbfeF/zP9QaPw2PjoPjo6DxY93/cPTHjrUW9HaU0C8Qvnx4y/NyOleCh1ywSNH2ItvSK/+QMPkVFGjDdPbYy/W+2UfiKLIH/4APPAr7lWC+a1jjAkQ/N5AiTJYVHmxkS/u7sL9ZJjJ88bfo4ZewwS91fr/Y142aY97Js7tt76a7g4ach7LXh9frMdUcFxNpO8OmkXZTFH3b0ZwLJtgUldNvD4ZOs9eB/a46nHHtcO2YGTqRDOcJCmM3qTORyj6tsHY2HPZ2JuuO04uRaXQ0otW4Lhkaf7drtzLU5Xb7vfWSSIUOTaK+edVjoeWCmDAeW2ycyJ9LehbueIj0dhjkh+SfeufOu7oP7l6fXywW9amY16Waehs17bFpGtfe1f06ivrMJHHphQtowKdHBCwJEwU3lUBUyuqupRt8MF4aM24B2ga12mDUNUTFzwIzwq/gGlarW6ZxpOL1mh5/naMiPBnnUGQhxd2euFN9R1zTQATBhMUaD4LZvT0DuNWR3eHykU8E9yyekzzQR4B/w9HmK0LJTybVyqzVaBsUJA4OAHKNZhhiap6UHRc4Q687oDeF283niMRiFSi2oAbDFtk0pJ1dhv/MUteYiemcTUk2s0l/fwKrb76q
99
sidebar_class_name: "post api-method"
1010
info_path: docs/rest-api/openremote-manager-rest-api
1111
custom_edit_url: null
@@ -54,15 +54,15 @@ Create a dashboard
5454

5555
<RequestSchema
5656
title={"Body"}
57-
body={{"content":{"application/json":{"schema":{"required":["template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"access":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}
57+
body={{"content":{"application/json":{"schema":{"required":["displayName","realm","template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"access":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["displayName","scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
6363
id={undefined}
6464
label={undefined}
65-
responses={{"200":{"description":"default response","content":{"application/json":{"schema":{"required":["template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"access":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}}
65+
responses={{"200":{"description":"default response","content":{"application/json":{"schema":{"required":["displayName","realm","template"],"type":"object","properties":{"id":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"realm":{"maxLength":255,"minLength":1,"type":"string"},"version":{"type":"integer","format":"int64"},"ownerId":{"type":"string"},"access":{"type":"string","enum":["PUBLIC","SHARED","PRIVATE"]},"displayName":{"minLength":1,"type":"string"},"template":{"required":["screenPresets"],"type":"object","properties":{"id":{"type":"string"},"columns":{"minimum":1,"type":"integer","format":"int32"},"maxScreenWidth":{"minimum":1,"type":"integer","format":"int32"},"refreshInterval":{"type":"string","enum":["OFF","ONE_MIN","FIVE_MIN","QUARTER","ONE_HOUR"]},"screenPresets":{"type":"array","items":{"required":["displayName","scalingPreset"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"minLength":1,"type":"string"},"breakpoint":{"minimum":1,"type":"integer","format":"int32"},"scalingPreset":{"type":"string","enum":["WRAP_TO_SINGLE_COLUMN","KEEP_LAYOUT","REDIRECT","BLOCK_DEVICE"]},"redirectDashboardId":{"type":"string"}},"title":"DashboardScreenPreset"}},"widgets":{"type":"array","items":{"required":["displayName","gridItem","widgetTypeId"],"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"gridItem":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"},"w":{"minimum":1,"type":"integer","format":"int32"},"h":{"minimum":1,"type":"integer","format":"int32"},"minH":{"type":"integer","format":"int32"},"minW":{"type":"integer","format":"int32"},"minPixelH":{"type":"integer","format":"int32"},"minPixelW":{"type":"integer","format":"int32"},"noResize":{"type":"boolean"},"noMove":{"type":"boolean"},"locked":{"type":"boolean"}},"title":"DashboardGridItem"},"widgetTypeId":{"type":"string"},"widgetConfig":{"type":"object"}},"title":"DashboardWidget"}}},"title":"DashboardTemplate"}},"title":"Dashboard"}}}}}}
6666
>
6767

6868
</StatusCodes>

docs/rest-api/create-provisioning-config.api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Create a provisioning configuration"
55
sidebar_label: "Create a provisioning configuration"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: eJzNVktv20YQ/ivEnFqAEik5blqe6hpBGyCpBVu+VNBhRI7ITfbB7C4tK4L+ezFLUiIVI3V7qg/yzuy8d+YbHsBj6SBbwcKaJ+GE0UKXsI7B1GTRC6PfF5BBbgk9DWVujd6KEmKw9KUh538zxR6yA+RGe9Kej1jXUuTBSPLJGc08l1ekkE+sJywV7FyjInbq9zVBBmbziXIPMdSWw/CCHGuIgn+V0EI1CrLZSV5oTyVZiGFrrELfsn56A8e4i7y4C947eectZzkQL9DTxAtFrCLR+Y+mEFtBxeu1Qg4cHz5/IF36CrL59XXM8fb0OeLO1rFnjNRmaTpSu3pBzRJK9W1wxxjQOfJLUrVETy9KWOJz7ql4dGQHIhtjJKFmmcaRvTeyLXx3jdbiHmIQnpR7qTCk+V1WHFyRYaGEDv2BRSZN6fozmz4RCuv+GAI/XdiGnXeE0E6U1fkSJVrF1M4KT8Hiiej9tlTnuLvqPXSk91ZsGk9nVu+1pQZuO43eL0fRc2F9PMZQCIcbOWqYQTkL9Di46Rq808utUEKjN+Etup7f/xn6qdXgPhFeMv3tDN4FY3e9yWP7wrXRrn29eZryv4LYUc3TyK1LW2ykj3pJiF8/uf84dW0QY4e3YQ4jjOpBAlEeMmhapIEYFPnKMODUxgUAQB4ASIZKEIMj+8RNlK0O0FgJGVTe1y5LkoKUmZqatCVlPE2FSbAWySHMyzGBGJ7QCn4p14JQN0ZdPSADhc6T5STW7ChvrPD74InNMgat1sOrB65La60XOL8zNr6ac4Wk2QWRXArS/tZSQdoLlO0cmc+kH0MeCWskISyXtKFw8t7kRiat/UlutKbcJ0EtNOPWkqv+uwGXm7rNoLZmK0Kf9Sd+STZprPgaXunWFAFWRsx/75tFIf6fpx76mAfg/rzk3j2jqiX1CykdrRiYp/M3k/TtZP7LcnadXc+y+c/T9O3sL7hcK9+TbFfJGVcvcbbr2jPjAvOHkmOo97ahEbiPwHo9hLFWtAMuroPQWxO6tUOiu5r0fZiy6CNqLMlG9+8eltHN4j1cTv+yEi4SLvIVRYXJG0Xah8aJtsYG7gvW/lguFyeT0yhaSEJHkSMKGquRofUPJwgwuRtDwI/BizKWIk5i2oEd5gHsSKGQAby25teRXvgYEDkxPmaH/llufl98iK6mKcQX2LPb7aalbqbGlkmn5hIsazm5mqZT0tPKK8k2GbvauvBFyizGO4V64OZ1gDkq8wl3PD37pJYo2l3OUR46LF1BffGlVzHUZis4HDbo6NHK45HZXxqyjHvrM2QG6IuhIiy4mVYH+Ex7DrXdHJMle2dx2YTvhcstcox7jZs8p9p/V3Y92AaLu4clxLDpvjFVgCCwuOMWxx1kAPzFytotrDPvABJ12WDJsq1N/vsbB1bL0w==
8+
api: eJzNVktv20YQ/ivEnFqAImU5bhqe6hpBGyCpBVu+RNBhRI7ITfbB7C4tK4L+ezFLUiJlI3V7qg/y7uw8vtmd+YZ78Fg6yJYwt+ZROGG00CWsYjA1WfTC6A8FZJBbQk9DnRujN6KEGCx9a8j5302xg2wPudGetOcl1rUUeXCSfnFGs8zlFSnkFdsJSwUH16iIg/pdTZCBWX+h3EMMtWUYXpBjC1HwrxJaqEZBdnHUF9pTSRZi2Bir0LeiX97AIe6QF7cheqfvvOUsB+oFepp4oYhNJDr/yRRiI6h4vVXIgfHh00fSpa8gm11dxYy3358Qd74OvWBkdjGdjswuXzCzhFI9B3eIAZ0jvyBVS/T0ooYlXueeigdHdqCyNkYSatZpHNk7I9uL747RWtxBDMKTci9dDGl+lyWDKzIslNChPrDIpCldv2bXx43Cul8G4McD23DwbiO0E2V1OkSJVh13juyjyIP21gpPzwUc8rjpgbW7Dll31EPott5bsW78wFMPq90NcHUWQ2C9FFaHQwyFcLiWo4oa3HeBHgcnXQd0drkVSmj0JjxW1xS7v0LBtRZcSMJL3j9v0tvg7LZ3eWhLoDbatc87m075X0EcqOZ25dqmDTbSR70mxK9v7X9syxbEOOBNaNQIo3qQQJSHDJqWiiAGRb4yzEi1cYEhkDsE0qERxMAVwFWWLffQWAkZVN7XLkvTgpRJTE3akjKeEmFSrEW6Dw11SCGGR7SCX8q1LNX1WXcfkIFC58lyEisOlDdW+F2IxG6ZpJar4dE930vrrVc4vTM2vprxDUmzDSq5FKT9jaWCtBco20YzX0k/hDxStkgDLJe2UDh5b3Ij09b/JDdaU+7TYBaKcWPJVf/dgctN3WZQW7MRoc76Fb8kuzRWfA+vdGOKwDsj4b+PzaoQ/89TD3XMDXB3moLvn1DVkvqJNR3NIJhNZ28m07eT2bvFxVV2dZHNfk2mby8+w/nc+ZFmO2tOxHtOxF3VngRnQ2GoOZ4F3jY0Yv8Rm6+GNNaqdsTF9yD0xoRq7ZjotiZ9F7os+oQaS7LR3fv7RXQ9/wDn3b+ohIuEi3xFUWHyRpH2oXCijbFB+oK3PxeL+dFlEkVzSegockTBYjlytPrpSAEmd2MK+DlEUcZSxEkkHdlhHsiOFAoZyGtjfhvZha8FkRPzY7bvn+X6j/nH6DKZQnzGPdvtNil1kxhbpp2ZS7Gs5eQymSakk8oryT6Zu9p74YMpi5jvFOpBmNcR5uiaj7zj6cmntUTRDntGue+4dAn12adgxVSbLWG/X6OjBysPBxZ/a8gy761OlBmoL4aKsOBiWu7hK+0Yajs5JguOzuqyCR8U51PkEPcW13lOtf+h7mowDea39wuIYd19hKpAQWBxyyWOW8gA+JOWrVtaZ9keJOqywZJ1W5/89zdSVNe2
99
sidebar_class_name: "post api-method"
1010
info_path: docs/rest-api/openremote-manager-rest-api
1111
custom_edit_url: null
@@ -54,7 +54,7 @@ Create a provisioning configuration
5454

5555
<RequestSchema
5656
title={"Body"}
57-
body={{"content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"name":{"maxLength":255,"minLength":1,"type":"string"},"type":{"maxLength":100,"minLength":3,"type":"string"},"realm":{"type":"string"},"assetTemplate":{"type":"string"},"restrictedUser":{"type":"boolean"},"userRoles":{"type":"array","items":{"type":"string","enum":["read:admin","read:logs","read:users","read:map","read:assets","read:rules","read:insights","read:alarms","write:user","write:admin","write:logs","write:assets","write:attributes","write:rules","write:insights","write:alarms","read","write"]}},"disabled":{"type":"boolean"},"data":{"type":"object"}},"discriminator":{"propertyName":"type"},"title":"ProvisioningConfigObjectObject"}}}}}
57+
body={{"content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"name":{"maxLength":255,"minLength":1,"type":"string"},"type":{"maxLength":100,"minLength":3,"type":"string"},"realm":{"type":"string"},"assetTemplate":{"type":"string"},"restrictedUser":{"type":"boolean"},"userRoles":{"type":"array","items":{"type":"string","enum":["read:admin","read:logs","read:users","read:map","read:assets","read:rules","read:insights","read:alarms","read:services","write:services","write:user","write:admin","write:logs","write:assets","write:attributes","write:rules","write:insights","write:alarms","read","write"]}},"disabled":{"type":"boolean"},"data":{"type":"object"}},"discriminator":{"propertyName":"type"},"title":"ProvisioningConfigObjectObject"}}}}}
5858
>
5959

6060
</RequestSchema>

0 commit comments

Comments
 (0)