diff --git a/docs/assets/downloads/openapi.setup.json b/docs/assets/downloads/openapi.setup.json
index 608e8854..73e58efa 100644
--- a/docs/assets/downloads/openapi.setup.json
+++ b/docs/assets/downloads/openapi.setup.json
@@ -1 +1 @@
-{"openapi":"3.0.2","info":{"title":"HCL Domino REST API setup","version":"1.1.2","description":"REST APIs for Domino and more done right.\nWith declarative security and access to Code, Design and data\nAdministrative Portion","contact":{"name":"HCL America Inc","url":"https://opensource.hcltechsw.com/Domino-rest-api/","email":"HeyHCL@pnp-hcl.com"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"servers":[{"url":"/api/setup-v1","description":"KEEP enabled server"}],"paths":{"/dxl":{"summary":"Actions on DXL of a database.","description":"Get raw DXL of a given database, upload DXL to alter design elements, or removes DXL from cache. ","get":{"tags":["design"],"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"examples":{"nsfAtDataDir":{"value":"Demo.nsf"},"nsfInADirectoryOffDataDir":{"value":"testdir/Data.nsf"}},"name":"nsfPath","description":"Path relative to the notesdata directory of the nsf to access.","schema":{"type":"string"},"in":"query"}],"responses":{"200":{"content":{"text/xml":{"schema":{"type":"string"},"examples":{"dxlSimple":{"value":"\r\n \r\n \r\n \r\n 20190712T192246,44+08\r\n \r\n \r\n 20220407T151018,22+08\r\n \r\n \r\n 20220407T151018,21+08\r\n \r\n \r\n 20220407T151018,21+08\r\n \r\n \r\n 20190712T192246,45+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n SELECT @All\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n @DocNumber\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n @Created\r\n \r\n \r\n \r\n \r\n \r\n \r\n 20190712T194148,22+08\r\n \r\n \r\n 20220407T151018,03+08\r\n \r\n \r\n 20220407T151018,02+08\r\n \r\n \r\n 20220407T151018,02+08\r\n \r\n \r\n 20190712T194148,22+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n .settings/org.eclipse.wst.validation.prefs\r\n
\r\n - \r\n ~C4g\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 39\r\n
\r\n - \r\n \r\nYQAYAAAAAAAnAAAAAQAAAAAAAAAAAAAAYAA5AAAAJwAoAAAAAAAAAAAAb3ZlcnJpZGU9dHJ1ZQpz\r\ndXNwZW5kPXRydWUKdmYudmVyc2lvbj0zAA==\r\n\r\n
\r\n - \r\n .settings/org.eclipse.wst.validation.prefs\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194153,51+08\r\n \r\n \r\n 20220407T151018,04+08\r\n \r\n \r\n 20220407T151018,03+08\r\n \r\n \r\n 20220407T151018,03+08\r\n \r\n \r\n 20190712T194153,51+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n w\r\n
\r\n - \r\n WEB-INF/xsp.properties\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 211\r\n
\r\n - \r\n \r\nYQAYAAAAAADTAAAAAQAAAAAAAAAAAAAAYADlAAAA0wDUAAAAAAAAAAAAeHNwLmFqYXgucmVuZGVy\r\nd2hvbGV0cmVlPWZhbHNlDQp4c3AuY2xpZW50LnNjcmlwdC5yYWRpb0NoZWNrYm94LmllLm9uY2hh\r\nbmdlLnRyaWdnZXI9ZWFybHktb25jbGljaw0KeHNwLmNzcmYucHJvdGVjdGlvbj10cnVlDQp4c3Au\r\ncGVyc2lzdGVuY2UubW9kZT1maWxlDQp4c3AucmVzb3VyY2VzLmFnZ3JlZ2F0ZT10cnVlDQp4c3Au\r\nZXJyb3IucGFnZS5kZWZhdWx0PXRydWUNCmU=\r\n\r\n
\r\n - \r\n WEB-INF/xsp.properties\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194241,92+08\r\n \r\n \r\n 20220407T151018,05+08\r\n \r\n \r\n 20220407T151018,04+08\r\n \r\n \r\n 20220407T151018,04+08\r\n \r\n \r\n 20190712T194241,92+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .classpath\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 329\r\n
\r\n - \r\n \r\nYQAYAAAAAABJAQAAAQAAAAAAAAAAAAAAYABbAQAASQFKAQAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGNsYXNzcGF0aD4KICA8Y2xhc3NwYXRoZW50cnkga2lu\r\nZD0ic3JjIiBwYXRoPSJMb2NhbCIvPgogIDxjbGFzc3BhdGhlbnRyeSBraW5kPSJjb24iIHBhdGg9\r\nIm9yZy5lY2xpcHNlLmpkdC5sYXVuY2hpbmcuSlJFX0NPTlRBSU5FUiIvPgogIDxjbGFzc3BhdGhl\r\nbnRyeSBraW5kPSJjb24iIHBhdGg9Im9yZy5lY2xpcHNlLnBkZS5jb3JlLnJlcXVpcmVkUGx1Z2lu\r\ncyIvPgogIDxjbGFzc3BhdGhlbnRyeSBraW5kPSJvdXRwdXQiIHBhdGg9IldlYkNvbnRlbnQvV0VC\r\nLUlORi9jbGFzc2VzIi8+CjwvY2xhc3NwYXRoPgoA\r\n\r\n
\r\n - \r\n .classpath\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194241,96+08\r\n \r\n \r\n 20220407T151018,06+08\r\n \r\n \r\n 20220407T151018,05+08\r\n \r\n \r\n 20220407T151018,05+08\r\n \r\n \r\n 20190712T194241,97+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.name\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 6\r\n
\r\n - \r\n \r\nYQAYAAAAAAAGAAAAAQAAAAAAAAAAAAAAYAAYAAAABgAGAAAAAAAAAAAAV2luZG93\r\n\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.name\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194241,99+08\r\n \r\n \r\n 20220407T151018,07+08\r\n \r\n \r\n 20220407T151018,06+08\r\n \r\n \r\n 20220407T151018,06+08\r\n \r\n \r\n 20190712T194242,02+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.container\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 49\r\n
\r\n - \r\n \r\nYQAYAAAAAAAxAAAAAQAAAAAAAAAAAAAAYABDAAAAMQAyAAAAAAAAAAAAb3JnLmVjbGlwc2Uud3N0\r\nLmpzZHQubGF1bmNoaW5nLmJhc2VCcm93c2VyTGlicmFyeQA=\r\n\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.container\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,06+08\r\n \r\n \r\n 20220407T151018,08+08\r\n \r\n \r\n 20220407T151018,07+08\r\n \r\n \r\n 20220407T151018,07+08\r\n \r\n \r\n 20190712T194242,07+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .settings/.jsdtscope\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 339\r\n
\r\n - \r\n \r\nYQAYAAAAAABTAQAAAQAAAAAAAAAAAAAAYABlAQAAUwFUAQAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxjbGFzc3BhdGg+DQoJPGNsYXNzcGF0aGVudHJ5IGtp\r\nbmQ9InNyYyIgcGF0aD0iQ29kZS9TY3JpcHRMaWJyYXJpZXMiLz4NCgk8Y2xhc3NwYXRoZW50cnkg\r\na2luZD0iY29uIiBwYXRoPSJvcmcuZWNsaXBzZS53c3QuanNkdC5sYXVuY2hpbmcuSlJFX0NPTlRB\r\nSU5FUiIvPg0KCTxjbGFzc3BhdGhlbnRyeSBraW5kPSJjb24iIHBhdGg9Im9yZy5lY2xpcHNlLndz\r\ndC5qc2R0LmxhdW5jaGluZy5iYXNlQnJvd3NlckxpYnJhcnkiLz4NCgk8Y2xhc3NwYXRoZW50cnkg\r\na2luZD0ib3V0cHV0IiBwYXRoPSIiLz4NCjwvY2xhc3NwYXRoPg0KAA==\r\n\r\n
\r\n - \r\n .settings/.jsdtscope\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,24+08\r\n \r\n \r\n 20220407T151018,09+08\r\n \r\n \r\n 20220407T151018,08+08\r\n \r\n \r\n 20220407T151018,08+08\r\n \r\n \r\n 20190712T194242,25+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n w\r\n
\r\n - \r\n WEB-INF/faces-config.xml\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 234\r\n
\r\n - \r\n \r\nYQAYAAAAAADqAAAAAQAAAAAAAAAAAAAAYAD8AAAA6gDqAAAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGZhY2VzLWNvbmZpZz4KICA8IS0tQVVUT0dFTi1TVEFS\r\nVC1CVUlMREVSOiBBdXRvbWF0aWNhbGx5IGdlbmVyYXRlZCBieSBJQk0gRG9taW5vIERlc2lnbmVy\r\nLiBEbyBub3QgbW9kaWZ5Li0tPgogIDwhLS1BVVRPR0VOLUVORC1CVUlMREVSOiBFbmQgb2YgYXV0\r\nb21hdGljYWxseSBnZW5lcmF0ZWQgc2VjdGlvbi0tPgo8L2ZhY2VzLWNvbmZpZz4K\r\n\r\n
\r\n - \r\n WEB-INF/faces-config.xml\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,29+08\r\n \r\n \r\n 20220407T151018,10+08\r\n \r\n \r\n 20220407T151018,09+08\r\n \r\n \r\n 20220407T151018,09+08\r\n \r\n \r\n 20190712T194242,30+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4gP\r\n
\r\n - \r\n build.properties\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 84\r\n
\r\n - \r\n \r\nYQAYAAAAAABUAAAAAQAAAAAAAAAAAAAAYABmAAAAVABUAAAAAAAAAAAAc291cmNlLi4gPSBMb2Nh\r\nbC8sXA0KICAgICAgICAgICBDb2RlL0phdmEvDQpvdXRwdXQuLiA9IFdlYkNvbnRlbnQvV0VCLUlO\r\nRi9jbGFzc2VzLw0K\r\n\r\n
\r\n - \r\n build.properties\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,43+08\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n 20220407T151018,10+08\r\n \r\n \r\n 20220407T151018,10+08\r\n \r\n \r\n 20190712T194242,44+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4gP\r\n
\r\n - \r\n plugin.xml\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 1189\r\n
\r\n - \r\n \r\nYQAYAAAAAAClBAAAAQAAAAAAAAAAAAAAYAC3BAAApQSmBAAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHBsdWdpbiBjbGFzcz0icGx1Z2luLkFjdGl2YXRvciIK\r\nICBpZD0iTFAyMmRBUDJkNTE3MjM1NTFfMmZIQ0xQTlBfRGVtb19uc2YiIG5hbWU9IkRvbWlubyBE\r\nZXNpZ25lciIKICBwcm92aWRlcj0iVE9ETyIgdmVyc2lvbj0iMS4wLjAiPgogIDxyZXF1aXJlcz4K\r\nICAgIDwhLS1BVVRPR0VOLVNUQVJULUJVSUxERVI6IEF1dG9tYXRpY2FsbHkgZ2VuZXJhdGVkIGJ5\r\nIG51bGwuIERvIG5vdCBtb2RpZnkuLS0+CiAgICA8aW1wb3J0IHBsdWdpbj0ib3JnLmVjbGlwc2Uu\r\ndWkiLz4KICAgIDxpbXBvcnQgcGx1Z2luPSJvcmcuZWNsaXBzZS5jb3JlLnJ1bnRpbWUiLz4KICAg\r\nIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0iY29tLmlibS5jb21tb25zIi8+CiAgICA8\r\naW1wb3J0IG9wdGlvbmFsPSJ0cnVlIiBwbHVnaW49ImNvbS5pYm0uY29tbW9ucy54bWwiLz4KICAg\r\nIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0iY29tLmlibS5jb21tb25zLnZmcyIvPgog\r\nICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJjb20uaWJtLmpzY3JpcHQiLz4KICAg\r\nIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0iY29tLmlibS5kZXNpZ25lci5ydW50aW1l\r\nLmRpcmVjdG9yeSIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJjb20uaWJt\r\nLmRlc2lnbmVyLnJ1bnRpbWUiLz4KICAgIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0i\r\nY29tLmlibS54c3AuY29yZSIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJj\r\nb20uaWJtLnhzcC5leHRzbiIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJj\r\nb20uaWJtLnhzcC5kZXNpZ25lciIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2lu\r\nPSJjb20uaWJtLnhzcC5kb21pbm8iLz4KICAgIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdp\r\nbj0iY29tLmlibS5ub3Rlcy5qYXZhLmFwaSIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIg\r\ncGx1Z2luPSJjb20uaWJtLnhzcC5yY3AiLz4KICAgIDwhLS1BVVRPR0VOLUVORC1CVUlMREVSOiBF\r\nbmQgb2YgYXV0b21hdGljYWxseSBnZW5lcmF0ZWQgc2VjdGlvbi0tPgogIDwvcmVxdWlyZXM+Cjwv\r\ncGx1Z2luPgo8P2VjbGlwc2UgdmVyc2lvbj0iMy4wIj8+CmU=\r\n\r\n
\r\n - \r\n plugin.xml\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194247,03+08\r\n \r\n \r\n 20220407T151018,12+08\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n 20190712T194247,03+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n .project\r\n
\r\n - \r\n ~C4gP\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 1771\r\n
\r\n - \r\n \r\nYQAYAAAAAADrBgAAAQAAAAAAAAAAAAAAYAD9BgAA6wbsBgAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHByb2plY3REZXNjcmlwdGlvbj4KICA8bmFtZT5EZW1v\r\nLm5zZjwvbmFtZT4KICA8Y29tbWVudC8+CiAgPHByb2plY3RzLz4KICA8YnVpbGRTcGVjPgogICAg\r\nPGJ1aWxkQ29tbWFuZD4KICAgICAgPG5hbWU+Y29tLmlibS5kZXNpZ25lci5kb21pbm8uamF2YWxp\r\nYi5qYXZhbGlibWFya2VyYnVpbGRlcjwvbmFtZT4KICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1\r\naWxkQ29tbWFuZD4KICAgIDxidWlsZENvbW1hbmQ+CiAgICAgIDxuYW1lPmNvbS5pYm0uZGVzaWdu\r\nZXIuZG9taW5vLmRlc2lnbi5qc3ZhbGlkYXRpb25idWlsZGVyPC9uYW1lPgogICAgICA8YXJndW1l\r\nbnRzLz4KICAgIDwvYnVpbGRDb21tYW5kPgogICAgPGJ1aWxkQ29tbWFuZD4KICAgICAgPG5hbWU+\r\nY29tLmlibS5kZXNpZ25lci5kb21pbm8uaWRlLnJlc291cmNlcy5mYWNlc0NvbmZpZ2J1aWxkZXI8\r\nL25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8YnVpbGRD\r\nb21tYW5kPgogICAgICA8bmFtZT5jb20uaWJtLmRlc2lnbmVyLmRvbWluby5pZGUucmVzb3VyY2Vz\r\nLkJ1aWxkUHJvcGVydGllc0J1aWxkZXI8L25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9i\r\ndWlsZENvbW1hbmQ+CiAgICA8YnVpbGRDb21tYW5kPgogICAgICA8bmFtZT5jb20uaWJtLmRlc2ln\r\nbmVyLmRvbWluby5pZGUucmVzb3VyY2VzLnBsdWdpblhNTGJ1aWxkZXI8L25hbWU+CiAgICAgIDxh\r\ncmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8YnVpbGRDb21tYW5kPgogICAgICA8\r\nbmFtZT5jb20uaWJtLmRlc2lnbmVyLmRvbWluby54c3AuZWRpdG9yLnhwYWdlc2J1aWxkZXI8L25h\r\nbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8YnVpbGRDb21t\r\nYW5kPgogICAgICA8bmFtZT5vcmcuZWNsaXBzZS5qZHQuY29yZS5qYXZhYnVpbGRlcjwvbmFtZT4K\r\nICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1aWxkQ29tbWFuZD4KICAgIDxidWlsZENvbW1hbmQ+\r\nCiAgICAgIDxuYW1lPmNvbS5pYm0uZGVzaWduZXIuZG9taW5vLmlkZS5yZXNvdXJjZXMuTFdQREJ1\r\naWxkZXI8L25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8\r\nYnVpbGRDb21tYW5kPgogICAgICA8bmFtZT5jb20uaWJtLmRlc2lnbmVyLmRvbWluby5sc2NyaXB0\r\nLkxTQnVpbGRlcjwvbmFtZT4KICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1aWxkQ29tbWFuZD4K\r\nICAgIDxidWlsZENvbW1hbmQ+CiAgICAgIDxuYW1lPm9yZy5lY2xpcHNlLnBkZS5NYW5pZmVzdEJ1\r\naWxkZXI8L25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8\r\nYnVpbGRDb21tYW5kPgogICAgICA8bmFtZT5vcmcuZWNsaXBzZS5wZGUuU2NoZW1hQnVpbGRlcjwv\r\nbmFtZT4KICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1aWxkQ29tbWFuZD4KICA8L2J1aWxkU3Bl\r\nYz4KICA8bmF0dXJlcz4KICAgIDxuYXR1cmU+Y29tLmlibS53b3JrcGxhY2Uubm90ZXMuZmlsZXN5\r\nc3RlbS5ERE5hdHVyZTwvbmF0dXJlPgogICAgPG5hdHVyZT5vcmcuZWNsaXBzZS5qZHQuY29yZS5q\r\nYXZhbmF0dXJlPC9uYXR1cmU+CiAgICA8bmF0dXJlPm9yZy5lY2xpcHNlLnBkZS5QbHVnaW5OYXR1\r\ncmU8L25hdHVyZT4KICAgIDxuYXR1cmU+b3JnLmVjbGlwc2Uud3N0LmpzZHQuY29yZS5qc05hdHVy\r\nZTwvbmF0dXJlPgogIDwvbmF0dXJlcz4KPC9wcm9qZWN0RGVzY3JpcHRpb24+CgA=\r\n\r\n
\r\n - \r\n .project\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194248,10+08\r\n \r\n \r\n 20220407T151048,02+08\r\n \r\n \r\n 20220407T151048,01+08\r\n \r\n \r\n 20220407T151048,01+08\r\n \r\n \r\n 20190712T194248,09+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n w\r\n
\r\n - \r\n WEB-INF/classes/plugin/Activator.class\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 1069\r\n
\r\n - \r\n \r\nYQAYAAAAAAAtBAAAAQAAAAAAAAAAAAAAYAA/BAAALQQuBAAAAAAAAAAAyv66vgAAADQAKwcAAgEA\r\nEHBsdWdpbi9BY3RpdmF0b3IHAAQBACZvcmcvZWNsaXBzZS91aS9wbHVnaW4vQWJzdHJhY3RVSVBs\r\ndWdpbgEABnBsdWdpbgEAEkxwbHVnaW4vQWN0aXZhdG9yOwEABjxpbml0PgEAAygpVgEABENvZGUK\r\nAAMACwwABwAICQABAA0MAAUABgEAD0xpbmVOdW1iZXJUYWJsZQEAEkxvY2FsVmFyaWFibGVUYWJs\r\nZQEABHRoaXMBAAVzdGFydAEAJShMb3JnL29zZ2kvZnJhbWV3b3JrL0J1bmRsZUNvbnRleHQ7KVYB\r\nAApFeGNlcHRpb25zBwAVAQATamF2YS9sYW5nL0V4Y2VwdGlvbgoAAwAXDAARABIBAAdjb250ZXh0\r\nAQAiTG9yZy9vc2dpL2ZyYW1ld29yay9CdW5kbGVDb250ZXh0OwEABHN0b3AKAAMAHAwAGgASAQAK\r\nZ2V0RGVmYXVsdAEAFCgpTHBsdWdpbi9BY3RpdmF0b3I7AQASZ2V0SW1hZ2VEZXNjcmlwdG9yAQBA\r\nKExqYXZhL2xhbmcvU3RyaW5nOylMb3JnL2VjbGlwc2UvamZhY2UvcmVzb3VyY2UvSW1hZ2VEZXNj\r\ncmlwdG9yOwgAIgEACERlbW8ubnNmCgADACQMACUAJgEAGWltYWdlRGVzY3JpcHRvckZyb21QbHVn\r\naW4BAFIoTGphdmEvbGFuZy9TdHJpbmc7TGphdmEvbGFuZy9TdHJpbmc7KUxvcmcvZWNsaXBzZS9q\r\nZmFjZS9yZXNvdXJjZS9JbWFnZURlc2NyaXB0b3I7AQAEcGF0aAEAEkxqYXZhL2xhbmcvU3RyaW5n\r\nOwEAClNvdXJjZUZpbGUBAA5BY3RpdmF0b3IuamF2YQAhAAEAAwAAAAEACgAFAAYAAAAFAAEABwAI\r\nAAEACQAAADsAAQABAAAACSq3AAoqswAMsQAAAAIADgAAAA4AAwAAABgABAAZAAgAGgAPAAAADAAB\r\nAAAACQAQAAYAAAABABEAEgACABMAAAAEAAEAFAAJAAAAPgACAAIAAAAGKiu3ABaxAAAAAgAOAAAA\r\nCgACAAAAIAAFACEADwAAABYAAgAAAAYAEAAGAAAAAAAGABgAGQABAAEAGgASAAIAEwAAAAQAAQAU\r\nAAkAAABGAAIAAgAAAAoqK7cAGwGzAAyxAAAAAgAOAAAADgADAAAAJwAFACgACQApAA8AAAAWAAIA\r\nAAAKABAABgAAAAAACgAYABkAAQAJAB0AHgABAAkAAAAkAAEAAAAAAASyAAywAAAAAgAOAAAABgAB\r\nAAAALwAPAAAAAgAAAAkAHwAgAAEACQAAADEAAgABAAAABxIhKrgAI7AAAAACAA4AAAAGAAEAAAA6\r\nAA8AAAAMAAEAAAAHACcAKAAAAAEAKQAAAAIAKlA=\r\n\r\n
\r\n - \r\n WEB-INF/classes/plugin/Activator.class\r\n
\r\n \r\n \r\n \r\n \r\n \r\n 20190712T200521,54+08\r\n \r\n \r\n 20220407T151018,14+08\r\n \r\n \r\n 20220407T151018,13+08\r\n \r\n \r\n 20220407T151018,13+08\r\n \r\n \r\n 20190712T200521,57+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n AppProperties/xspdesign.properties\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 31\r\n
\r\n - \r\n \r\nYQAYAAAAAAAfAAAAAQAAAAAAAAAAAAAAYAAxAAAAHwAgAAAAAAAAAAAAI0ZyaSBKdWwgMTIgMjA6\r\nMTA6NDcgU0dUIDIwMTkNCgo=\r\n\r\n
\r\n - \r\n xspdesign.properties\r\n
\r\n \r\n \r\n \r\n \r\n \r\n 20190712T210038,90+08\r\n \r\n \r\n 20220407T151018,23+08\r\n \r\n \r\n 20220407T151018,22+08\r\n \r\n \r\n 20220407T151018,22+08\r\n \r\n \r\n 20190712T210038,94+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n %REM\r\n\tAgent SalesforceProcessing\r\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\r\n\tDescription: Comments for Agent\r\n%END REM\r\nOption Public\r\nOption Declare\r\n\r\n\r\n\r\n \r\n \r\n Sub Initialize\r\n\tDim s As New NotesSession\r\n\tDim db As NotesDatabase\r\n\tDim dcol As NotesDocumentCollection\r\n\tDim doc As NotesDocument\r\n\tDim nextDoc As NotesDocument\r\n\tSet db = s.Currentdatabase\r\n\tSet dcol = db.Unprocesseddocuments\r\n\tSet doc = dcol.Getfirstdocument()\r\n\tWhile Not doc Is Nothing\r\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\r\n\t\tCall handleOneDoc(doc)\r\n\t\tCall s.Updateprocesseddoc(doc)\r\n\t\tSet doc = nextDoc\r\n\tWend\r\nEnd Sub\r\n\r\n\r\n\r\n\r\n \r\n \r\n %REM\r\n\tSub handleOneDoc\r\n\tDescription: Creates a RichTextItem for all Fields\r\n%END REM\r\nSub handleOneDoc(doc As NotesDocument)\r\n\tDim rt As NotesRichTextItem\r\n\tDim item As NotesItem\r\n\tSet rt = doc.Createrichtextitem(\"Body\")\r\n\tForall i In doc.Items\r\n\t\tSet item = i\r\n\t\tIf item.name <> \"Body\" Then\r\n\t\t\trt.Appendtext(item.Name)\r\n\t\t\trt.Appendtext(\": \")\r\n\t\t\trt.Appendtext(item.Text)\r\n\t\t\trt.Addnewline(1)\r\n\t\tEnd If\r\n\tEnd Forall\t\r\n\r\n\tCall doc.save(True,True)\r\nEnd Sub\r\n \r\n \r\n \r\n \r\n \r\n 20190712T213039,48+08\r\n \r\n \r\n 20220407T151018,24+08\r\n \r\n \r\n 20220407T151018,23+08\r\n \r\n \r\n 20220407T151018,23+08\r\n \r\n \r\n 20190712T213039,53+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n 20220407T151018,14+08\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n %REM\r\n\tAgent SalesforceProcessing\r\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\r\n\tDescription: Comments for Agent\r\n%END REM\r\nOption Public\r\nOption Declare\r\n\r\n\r\n\r\n \r\n \r\n Sub Initialize\r\n\tDim s As New NotesSession\r\n\tDim db As NotesDatabase\r\n\tDim dcol As NotesDocumentCollection\r\n\tDim doc As NotesDocument\r\n\tDim nextDoc As NotesDocument\r\n\tSet db = s.Currentdatabase\r\n\tSet dcol = db.Unprocesseddocuments\r\n\tSet doc = dcol.Getfirstdocument()\r\n\tWhile Not doc Is Nothing\r\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\r\n\t\tCall handleOneDoc(doc)\r\n\t\tCall s.Updateprocesseddoc(doc)\r\n\t\tSet doc = nextDoc\r\n\tWend\r\nEnd Sub\r\n\r\n\r\n\r\n\r\n \r\n \r\n %REM\r\n\tSub handleOneDoc\r\n\tDescription: Creates a RichTextItem for all Fields\r\n%END REM\r\nSub handleOneDoc(doc As NotesDocument)\r\n\tDim rt As NotesRichTextItem\r\n\tDim item As NotesItem\r\n\tSet rt = doc.Createrichtextitem(\"Body\")\r\n\tForall i In doc.Items\r\n\t\tSet item = i\r\n\t\tIf item.name <> \"Body\" Then\r\n\t\t\trt.Appendtext(item.Name)\r\n\t\t\trt.Appendtext(\": \")\r\n\t\t\trt.Appendtext(item.Text)\r\n\t\t\trt.Addnewline(1)\r\n\t\tEnd If\r\n\tEnd Forall\t\r\n\r\n\tCall doc.save(True,True)\r\nEnd Sub\r\n \r\n \r\n \r\n \r\n \r\n 20190910T180253,01+08\r\n \r\n \r\n 20220407T151018,25+08\r\n \r\n \r\n 20220407T151018,24+08\r\n \r\n \r\n 20220407T151018,24+08\r\n \r\n \r\n 20190910T180253,07+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n SELECT (Form = \"Customer\")\r\n \r\n \r\n \r\n \r\n \r\n \r\n @DocNumber\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n @Created\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 20220407T101537,01+08\r\n \r\n \r\n 20220408T102424,75+08\r\n \r\n \r\n 20220408T102424,74+08\r\n \r\n \r\n 20220408T102424,74+08\r\n \r\n \r\n 20220407T101537,00+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=John Doe/O=ProjectKeep\r\n \r\n \r\n SELECT Form = \"Entry\"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 20220407T101713,03+08\r\n \r\n \r\n 20220408T102538,75+08\r\n \r\n \r\n 20220408T102538,74+08\r\n \r\n \r\n 20220408T102538,74+08\r\n \r\n \r\n 20220407T101713,03+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=John Doe/O=ProjectKeep\r\n \r\n \r\n SELECT Form = \"SampleEntry\"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"}}}},"description":"Get full DXL"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getDxl","summary":"Get all DXL","description":"Raw DXL of a given database","x-keep-version":1},"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":true}]},"/admin/access":{"summary":"Provide information on access to Domino REST API DB configuration settings","description":"Provide information on access to Domino REAT API DB configuration settings","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepAccessShort"}}},"description":"Provide access info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getKeepAccess","summary":"Check if user has the right to update mappings","description":"Retrieve the information whether the user has right to update mappings.","x-keep-version":1,"x-keep-scope":"ANY"},"post":{"requestBody":{"description":"Details to be checked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepAccessQuery"}}},"required":true},"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeepAccessDetail"}}}},"description":"Access details"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"queryKeepAccess","summary":"Check for admin access permissions","description":"Check for access permission of operating mappings.","x-keep-version":1,"x-keep-scope":"ANY"}},"/admin/application/{client_id}":{"summary":"Endpoint for approving / rejecting an application request","description":"Endpoint for approving / rejecting an application request","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationResponse"}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getKeepApplication","summary":"Retrieve application configuration","description":"Retrieve application configuration","x-keep-version":1},"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationRequestUpdate"}}},"required":true},"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationResponse"}}},"description":"Successful update"},"400":{"$ref":"#/components/responses/400BadRequest"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"updateKeepApplication","summary":"Updates an application configuration","description":"Update an application does not new application secret","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"success":{"value":{"status":"OK","statusCode":200,"message":"deletion complete","details":{"appId":"1fe2cd-ac38-26c7d6"}}}}}},"description":"Successful deletion"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteKeepApplication","summary":"Delete an external application","description":"Delete an external application","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"Sample":{"value":"1fe2cd-ac38-26c7d6"}},"name":"client_id","description":"App ID","schema":{"type":"string"},"in":"path","required":true}]},"/admin/application":{"summary":"Creates an external application","description":"Creates an external application","post":{"requestBody":{"description":"client_name, client_uri, redirect_uris, scope are requested. Other properties will be generated by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationRequest"},"examples":{"applicationSimpleRequest":{"value":{"client_name":"My App","description":"Super cool demo App","redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","contacts":["admin@projectcastle.io"],"status":"isActive"}}}}},"required":true},"tags":["admin"],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationResponse"},"examples":{"applicationResponseSimple":{"value":{"@unid":"B7EF2F8AC28AEDC44825882B000AD946","author":"CN=John Doe/O=Mauraders","client_name":"My App","description":"Super cool demo App","client_id":"abcdef-1234-567890","hasSecret":false,"redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","token_endpoint_auth_method":"client_secret_basic","contacts":["admin@projectcastle.io"],"status":"isActive"}}}}},"description":"Successful creation"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"createKeepApplication","summary":"Create an external application","description":"Create an external application","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/application/{client_id}/secret":{"summary":"Generates a new app secret for the application and changes status to active, if appropriate","description":"Generates a new app secret for the application and changes status to active, if appropriate","post":{"requestBody":{"description":"'status' must be provided. Sample value 'isActive', 'disabled'","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationSecretRequest"},"examples":{"CreateAppSecret":{"value":{"status":"isActive"}}}}},"required":true},"tags":["admin"],"parameters":[{"examples":{"ForceOverwrite":{"value":"true"},"KeepExsisting":{"value":"false"}},"name":"force","description":"when set to true, an existing secret will get overwritten.\nNo effect if no secret exists","schema":{"type":"boolean"},"in":"query"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationSecretResponse"},"examples":{"AppSecretResponse":{"value":{"client_id":"9c5fed-38c4-441808","client_secret":"7e368d-6b3b-54eda8"}}}}},"description":"Successful created."},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"generateKeepApplicationSecret","summary":"Generates a new client_secret","description":"The client_secret is used as app password in the oauth Dance","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"StatusMessageDeleteSecret":{"value":{"statusText":"OK","status":200,"message":"App Secret removed for 429022-562b-641620"}}}}},"description":"Successfull deletion"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteKeepApplicationSecret","summary":"Remove an application secret","description":"Remove an application secret","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"Sample":{"value":"1fe2cd-ac38-26c7d6"}},"name":"client_id","description":"App ID","schema":{"type":"string"},"in":"path","required":true}]},"/admin/applications":{"summary":"Gets all external applications created by current user.","description":"Used to show the AdminUI","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApplicationResponse"}},"examples":{"Sample":{"value":[{"@unid":"B7EF2F8AC28AEDC44825882B000AD946","author":"CN=John Doe/O=Mauraders","client_id":"9c5fed-38c4-441808","client_name":"My App","hasSecret":false,"client_uri":"https://www.projectcastle.io/coolapp","contacts":["admin@projectcastle.io","CN=John Doe/O=Mauraders"],"description":"Super cool demo App","logo_uri":"https://www.projectcastle.io/castle.jpg","redirect_uris":["https://www.projectcastle.io/oauth","http://localhost/callback","https://domino.projectcastle.io/identity"],"scope":"demo $DECRYPT","status":"isActive","token_endpoint_auth_method":"client_secret_basic"},{"@unid":"ED192F6438FDE92B4825882B000D33CE","author":"CN=John Doe/O=Mauraders","client_id":"1814ef-0ea9-fa81cc","client_name":"My App1","hasSecret":false,"client_uri":"https://www.projectcastle.io/coolapp","contacts":["admin@projectcastle.io","CN=John Doe/O=Mauraders"],"description":"Super cool demo App","logo_uri":"https://www.projectcastle.io/castle.jpg","redirect_uris":["https://www.projectcastle.io/oauth","http://localhost/callback","https://domino.projectcastle.io/identity"],"scope":"demo $DECRYPT","status":"isActive","token_endpoint_auth_method":"client_secret_basic"}]}}}},"description":"Successful retrieval"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchAllApplications","summary":"Get my applications","description":"Get my applications","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/applications/all":{"summary":"DEPRECATED use /admin/applications","description":"DEPRECATED use /admin/applications","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApplicationResponse"}}}},"description":"Successful retrieval"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"deprecated":true,"security":[{"jwt":[]}],"operationId":"fetchAllApplicationsDeprecates","summary":"Get applications","description":"Get applications","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/backup":{"summary":"Backup / Restore of entire Domino REST API configuration","description":"Everything that is in KeepConfig, so it can be applied else where\nor reapplied after version change","get":{"tags":["admin"],"parameters":[{"examples":{"default":{"value":"attachment; filename=\"backup.json\""}},"name":"Content-Disposition","description":"","schema":{"type":"string"},"in":"header","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBackup"},"examples":{"adminBackupSample":{"value":{"version":{"keep-name":"HCL Domino REST API core API","keep-desc":"Next generation APIs for HCL Domino","image-build":"2022-10-14T03:03:04Z","keep-vendor":"HCL Labs","keep-version":"v1.0 (Build 1.9.0-SNAPSHOT-LocalBuild)"},"databases":{"demort":{"apiName":"demort","nsfPath":"Demo.nsf","iconName":"beach","icon":"Base64 stuff, preferably SVG","description":"test","formulaEngine":"domino","schemaName":"demort","requireRevisionToUpdate":false,"allowDecryption":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"allowCode":true,"openAccess":true,"unid":"6C726915B22B8439482588DA00042F96","forms":[{"formName":"fromSalesforce","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"views":[{"name":"Customers","alias":[],"unid":"86C72C1BF64B6DF04825847100373215"}],"agents":[],"formAliases":{},"isActive":true},"names":{"apiName":"names","nsfPath":"names.nsf","iconName":"mountain","schemaName":"names","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":false,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":false,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":false},"keepconfig":{"apiName":"keepconfig","nsfPath":"KeepConfig.nsf","iconName":"mountain","icon":"Base64 stuff, preferably SVG","description":"Primary directory of this Domain","schemaName":"keepconfig","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":true,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":true}},"apps":{"unknown":{"@unid":"0952193E783BF633C12588DB003AA430","author":"CN=chan clement/O=ProjectKeep","client_id":"7a2e3e-bfbc-eb6dfd","client_name":"Manager App","hasSecret":false,"client_uri":"http://test.local","contacts":["CN=chan clement/O=ProjectKeep"],"description":"Created by MANAGER","logo_uri":"cruise","redirect_uris":["http://test.local"],"scope":"managerscope","status":"isActive","token_endpoint_auth_method":"client_secret_basic"}}}}}}},"description":"Successful retrieval"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getKeepConfig","summary":"Retrieve Domino REST API configuration","description":"Retrieve Domino REST API configuration","x-keep-version":1,"x-keep-scope":"$SETUP","x-content-disposition":"attachment; filename=\"backup.json\""}},"/admin/cache":{"summary":"Access Domino REST API cache of design element summaries","description":"Get information about the Domino REST API Cache object and eventually clear it","delete":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"statusMessage":{"value":{"status":"OK","statusCode":200,"message":"cache reset"}}}}},"description":"Cache cleared"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteCache","summary":"Reset the Domino REST API cache","description":"Reset the Domino REST API cache","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/quickconfig":{"summary":"Quick config a nsf database to be available for Domino REST API access","description":"For a nsf database, this endpoint can be used to create a scope and config schema automatically. After configuration, user can access the database through provided scope name directly. No need to manually config schema any more. By default, all visible forms and views will be configured. All configured forms will contain all fields in original forms.","post":{"requestBody":{"description":"In the request body, the following attributes can be specified:\n\"nsfPath\" (required): a nsf database path,\n\"schemaName\" : schema name to be used for the schema name. By default, it is \"default\"\n\"scopeName\" : scope name used to access the database. If not specified, nsf database file name will be used\n\"create\" : If it is true and the nsf database does not exist, a empty database will be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickConfigParam"},"examples":{"QuickConfigSample":{"value":{"nsfPath":"some/path/to/database.nsf","schemaName":"somename","scopeName":"somescope","description":"some description","create":true,"iconName":"beach","isActive":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"allowCode":false,"openAccess":true,"requireRevisionToUpdate":false,"allowDecryption":false}}}}},"required":true},"tags":["admin"],"responses":{"200":{"content":{"application/json":{"examples":{"scopeSimple":{"value":{"@unid":"22D5E55E8FA1389A48258844006681A7","@noteid":4718,"@created":"2022-05-16T18:39:38Z","@lastmodified":"2022-05-17T08:51:54Z","@revision":"ac8ca0d967c9a40b0c9c07aecf87377d","@lastaccessed":"2022-05-17T08:51:54Z","@size":258,"@unread":true,"@etag":"W/\" 6283622a\"","Subject":"The famous demo database","apiName":"demo","schemaName":"demo","nsfPath":"Demo.nsf","isActive":true,"ISiteNameFull":"REST Database Site: demo (active)","ISiteOrg":"Domino REST access","Form":"KeepDatabase","Type":"KeepDatabase","$UpdatedBy":["CN=John Doe/O=Mauraders"],"$Revisions":["2022-05-17T02:39:38+08:00","2022-05-17T09:35:05+08:00"]}}}}},"description":"Config successfully"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"quickConfig","summary":"Create a scope and config schema","description":"Create a scope and config schema","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/scope":{"summary":"Connection of scope (public name) to a defined schema (a.k.a KeepDbConfig) in a NSF","description":"scope names are unique to a Domino server, while schema definitions are unique only to the nsf they reside in.\nThis endpoint allows to CRUD on the mappings between scope and schema","get":{"tags":["admin"],"parameters":[{"name":"scopeName","description":"Scope name of the mapping","schema":{"type":"string"},"in":"query","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMapping"}}},"description":"List of configs"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"getScopeMapping","summary":"Retrieves rest configuration from the server","description":"Maps a schema to a scope","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMappingRequest"},"examples":{"simpleScopeRequest":{"value":{"description":"The famous demo database","apiName":"demoapi","schemaName":"demoapi","nsfPath":"Demo.nsf","isActive":true,"icon":"Base64 stuff, preferably SVG","iconName":"beach","createSchema":false,"server":"*"}}}}},"required":true},"tags":["admin"],"parameters":[{"name":"createSchema","description":"If the database mentioned has no Schema of the given name, create an empty one.\nRequires designer access to the target database","schema":{"type":"boolean"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMapping"},"examples":{"scopeSimple":{"value":{"@meta":{"noteid":2342,"unid":"1E280A1798C5C313482588D9002671A2","created":"2022-10-12T14:59:54.58+08:00","lastmodified":"2022-10-12T15:13:36.56+08:00","lastaccessed":"2022-10-12T15:10:26.59+08:00","lastmodifiedinfile":"2022-10-12T15:13:36.57+08:00","addedtofile":"2022-10-12T14:59:54.7+08:00","noteclass":["DATA","DOCUMENT"],"unread":true,"revision":"000000060027B2B8482588D9"},"$UpdatedBy":["CN=John Doe/O=ProjectKeep"],"$Revisions":["2022-10-12T14:59:54.7+08:00","2022-10-12T15:09:02.71+08:00","2022-10-12T15:09:25.33+08:00","2022-10-12T15:09:45.99+08:00"],"apiName":"demoapi","createSchema":0,"description":"The famous demo database","isActive":true,"nsfPath":"Demo.nsf","schemaName":"demoapi","Form":"KeepDatabase","Type":"KeepDatabase"}}}}},"description":"successful creation"}},"security":[{"jwt":[]}],"operationId":"createUpdateScopeMapping","summary":"Create a rest configuration","description":"Create a rest configuration","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["admin"],"parameters":[{"name":"scopeName","description":"API Name of the mapping","schema":{"type":"string"},"in":"query","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMapping"}}},"description":"Successful delete"}},"security":[{"jwt":[]}],"operationId":"deleteScopeMapping","summary":"Delete a rest mapping from the directory","description":"Delete a rest mapping from the directory","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/scopes":{"summary":"Connection of scope (public name) to a defined schema (a.k.a KeepDbConfig) in a NSF","description":"scope names are unique to a Domino domain, while schema definitions are unique only to the nsf they reside in.\nThis endpoint allows to CRUD on the mappings between scope and schema. It will show active and inactive scopes and is for use of the admin. API consumerss rather use /scope instead of /admin/scope","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestMapping"}}}},"description":"List of configs"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"fetchScopeMappings","summary":"Get all of the rest mappings on the server,","description":"Return the list of scopes and their details.","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/design":{"summary":"Retrieve JSON formatted design elements info about a database.","description":"- forms\n- views / folders\n- agents\n- libraries\n- itemdefinitions\n- pages\n- subforms\n- outlines\n- navigators\n- actions\n- columns\n- fields","get":{"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"DesignSample":{"value":{"forms":{"fromSalesforce":{"@hide":"","@conflictation":"createconflicts","@unid":"639C1AE5A68680C2482584350046F7C3","@alias":[],"@noteid":"196","@name":"fromSalesforce","Body":{"allowmultivalues":false,"kind":"","type":"text"}},"SampleForm":{"@hide":"","@conflictation":"createconflicts","@unid":"A0DC3840E8CC9615482584350041A8CF","@alias":[],"@noteid":"182","@name":"SampleForm","Shape":{"allowmultivalues":false,"kind":"editable","type":"text"},"Color":{"allowmultivalues":false,"kind":"editable","type":"text"},"Taste":{"allowmultivalues":false,"kind":"editable","type":"text"},"Name":{"allowmultivalues":true,"kind":"editable","type":"text"},"Age":{"allowmultivalues":true,"kind":"editable","type":"number"}}},"subforms":{},"pages":{},"views":{"Customers":{"@alias":[],"@unid":"86C72C1BF64B6DF04825847100373215","@selectionFormula":"SELECT (Form = \"Customer\")","@name":"Customers","@noteid":"1be","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}},"($All)":{"@alias":[],"@unid":"0E35D520A1EBBB5B48258435003E8284","@selectionFormula":"SELECT @All","@name":"($All)","@noteid":"11a","$0":{"title":"#","formula":"@DocNumber"},"Form":{"title":"Form","formula":""},"$2":{"title":"Created","formula":"@Created"}}},"folders":{},"navigators":{},"outlines":{},"agents":{"Fix Body":{"Options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub\r\n","Forward":"Declare Sub Initialize\nDeclare Sub handleOneDoc(doc As NotesDocument)\n\n","Declarations":"\n","Initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","@trigger":"manual","@noteid":"1aa","@validForKeep":false,"@documentset":"selected","@unid":"3F8E64B529DA6CF848258435004A37CC","@type":"lotusscript","@name":"Fix Body"},"SalesforceProcessing":{"Options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub\r\n","Forward":"Declare Sub Initialize\nDeclare Sub handleOneDoc(doc As NotesDocument)\n\n","Declarations":"\n","Initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","@trigger":"docupdate","@noteid":"19e","@validForKeep":true,"@documentset":"none","@unid":"56D541DC5BCAF1384825843500477872","@type":"lotusscript","@name":"SalesforceProcessing"}},"libraries":{},"actions":{},"columns":{},"fields":{},"apiName":"","nsfPath":"Demo.nsf","cacheTimestamp":1653544543527}}}}},"description":"Successful design retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchDesignAll","summary":"Return list of design elements for a database","description":"List design information in JSON format for all types of design elements in JSON format.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition","schema":{"type":"string"},"in":"query"}]},"/design/nsf":{"summary":"Create a database, based on a template if required","description":"Create a database, in the meanwhile configure it known to Domino REST API. \n\nDefault ACL values for the database:\n- -default-, Editor\n- Anonymous, No Access\n- LocalDomainAdmins, Manager\n- LocalDomainServers, Manager\n- , Manager\n- OtherDomainServers, No Access\n- , Manager","post":{"requestBody":{"description":"Just 'nsfPath' and 'title' are requested. 'templateName' is not required.\n'nsfPath' should be the path of the database you want to create. 'templateName' should be the path of the template being located. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignNSFSimple"},"examples":{"sampleDb":{"value":{"nsfPath":"sampleDb.nsf","templateName":"DAOSsnap.ntf","title":"SampleDb"}}}}},"required":true},"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignNSFSimple"},"examples":{"database":{"value":{"formulaEngine":"domino","icon":"Base64 stuff, preferably SVG","iconName":"KEEP","nsfPath":"demo.nsf","openAccess":true,"requireRevisionToUpdate":false,"agents":[],"allowCode":false,"dqlAccess":true,"formAliases":{},"forms":[],"description":"Blank Demo","schemaName":"demo","@unid":"3EBD0971F82CC4DD482588760017A48B"}}}}},"description":"success"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"createNSF","summary":"Create a database, based on a template if required","description":"Create a database, based on the nsfPath and title in the request body, if required you can also configure the template in request body. ","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"Demo":{"value":"demo"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":true}]},"/designlist/{designType}":{"get":{"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignElementSummaryResponse"},"examples":{"forms":{"value":[{"@name":"Person Form","@alias":["Person"],"@unid":"639C1AE5A68680C2482584350046F7C3"}]}}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchDesignTypeList","summary":"Retrieve summary of design elements for a database for a specific type","description":"List design summary information in JSON format for a subset of design elements.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"designType","schema":{"enum":["agents","forms","libraries","views","folders","pages","subforms","outlines","navigators","actions","columns","fields","itemdefinitions"],"type":"string"},"in":"path","required":true},{"name":"dataSource","description":"Scope name, required if nsfPath is not specified","schema":{"type":"string"},"in":"query","required":false},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition, required if dataSource is not specified","schema":{"type":"string"},"in":"query"}]},"/schema":{"summary":"DBConfig objects for one NSF","description":"Checks for JSON resources following the naming scheme. The json file should be stored in Resources->Files in the database. ","get":{"tags":["schema"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"},"examples":{"schemaSimple":{"value":{"description":"test","nsfPath":"Demo.nsf","schemaName":"testschema","icon":"Base64 stuff, preferably SVG","iconName":"beach","formulaEngine":"domino","isActive":true,"agents":[{"name":"SalesforceProcessing","alias":[],"unid":"56D541DC5BCAF1384825843500477872"}],"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"forms":[{"formName":"SampleForm","formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"dqlAccess":true,"allowCode":true,"openAccess":true,"requireRevisionToUpdate":false,"allowDecryption":true,"owners":[]}}}}},"description":"List of configs"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFoundSchema":{"value":{"status":404,"message":"Config not found: REST/demoodata.json","errorId":1037}}}}},"description":"No such schema"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"getSchema","summary":"Get a REST configuration (Schema) from the specified database","description":"Used to get a REST configuration (Schema) from the specified database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"},"examples":{"restconfigSimpleRequest":{"value":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"MarketingInfo","alias":["MarketingInfo"],"unid":"10EA9EC66EA748BC4825851100420810"},{"name":"ChineseCustomers","alias":["ChineseCustomers"],"unid":"3FE5CD63E179F21600258680006DB25B"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"},{"name":"Samples","alias":["Samples"],"unid":"5318911D496571410025860D00544B17"}],"agents":[],"forms":[{"formName":"Customer","formModes":[{"modeName":"default","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Pet","type":"string"},{"name":"color","type":"string"},{"name":"email","type":"string"},{"name":"employee_count","type":"integer"},{"name":"first_name","type":"string"},{"name":"last_name","type":"string"},{"name":"hobbies","type":"array","items":{"type":"string"}},{"name":"Owner","type":"string","format":"authors"},{"name":"Body","type":"object","format":"richtext"}],"required":["Form","email","first_name"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false},{"modeName":"dql","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Pet","type":"string"},{"name":"color","type":"string"},{"name":"email","type":"string"},{"name":"first_name","type":"string"},{"name":"last_name","type":"string"},{"name":"hobbies","type":"array","items":{"type":"string"}}],"required":["Form","email","first_name"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]},{"formName":"Marketing","formModes":[{"modeName":"default","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Assets","type":"string"},{"name":"Country","type":"string"},{"name":"FullName","type":"string"},{"name":"Industry","type":"string"},{"name":"Newsletter","type":"string"},{"name":"email","type":"string"},{"name":"gender","type":"string","writeOnly":true}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]},{"formName":"SampleForm","formModes":[{"modeName":"default","fields":[{"name":"Color","type":"string"},{"name":"Form","type":"string"},{"name":"Shape","type":"string"},{"name":"Taste","type":"string"}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false},{"modeName":"odata","fields":[{"name":"Color","type":"string"},{"name":"Form","type":"string"},{"name":"Shape","type":"string"},{"name":"Taste","type":"string"}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]},{"formName":"TestForm","formModes":[{"modeName":"default","fields":[{"name":"colour","type":"string","fieldAccess":"RO"},{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"name","type":"string"}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"}}},"simpleRequestWithFieldGroup":{"value":{"schemaName":"demofieldGroup","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","formModes":[{"modeName":"default","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Pet","type":"string"},{"name":"Color","type":"string"},{"name":"Shape","type":"string"},{"name":"Taste","type":"string"},{"name":"Age","type":"array","items":{"type":"integer"},"fieldGroup":"person"},{"name":"Name","type":"array","items":{"type":"string"},"fieldGroup":"person"}],"required":["Form"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false},{"modeName":"dql","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Color","type":"string"}],"required":["Form"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"}}}}}},"required":true},"tags":["schema"],"parameters":[{"name":"prohibitRefresh","description":"default = true,\nWhen set, schema written to the database design are flagged so the\nDomino design task won't replace/delete the schema","schema":{"type":"boolean"},"in":"query"},{"name":"dryRun","description":"A flag whether indicating if creating or updating a schema will only be a dry run. This means that the request will only be simulated and no actual changes will take place in the database. This can be used to check for warnings when trying to create or update a schema. This flag is set to false by default.","schema":{"type":"boolean"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"},"examples":{"restconfigSimpleResponse":{"value":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]},{"modeName":"dql","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"6334EDA70A42ABB948258846002F115C"}},"simpleResponseWithFieldGroup":{"value":{"schemaName":"demofieldGroup","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Age","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]},{"modeName":"dql","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"E4D51C6C127FEECB002589390014CF5D"}},"responseWithWarning":{"value":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]},{"modeName":"dql","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"6334EDA70A42ABB948258846002F115C","@warnings":["Location form does not exist in the database.","Sort\\by location view does not exist in the database."]}}}}},"description":"successful creation"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"Forbidden":{"value":{"status":403,"message":"You need Designer access for this operation","errorId":1033}}}}},"description":"Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"createUpdateSchema","summary":"Create or Update a REST configuration (Schema) in the specified database","description":"Used to create or update a REST configuration (Schema) in the specified database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["schema"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"restconfigDeleteSimpleMessage":{"value":{"statusText":"OK","status":200,"message":"Deleted restcon from demo.nsf"}}}}},"description":"Successful delete"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteSchema","summary":"Delete a REST configuration (Schema) from the specified database","description":"Used to delete a REST configuration (Schema) from the specified database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"nsfPath","description":"Path in internet style relative to the Domino data directory.\ne.g. \"demo.nsf\" or \"sales/england/crm_gb.nsf\"","schema":{"type":"string"},"in":"query","required":true},{"name":"configName","description":"Schema name you want to retrieve.","schema":{"type":"string"},"in":"query","required":true}]},"/schemas":{"summary":"KeepDbConfig objects for one NSF","description":"Checks for JSON resources following the naming scheme","get":{"tags":["schema"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestConfigShort"}},"examples":{"simpleRestconfigsResponse":{"value":[{"apiName":"restcon2","comment":"REST API configuration restcon2","prohibitRefresh":false},{"apiName":"restcon","comment":"REST API configuration restcon","prohibitRefresh":false}]}}}},"description":"List of Schemas."},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"fetchSchemas","summary":"Get a list of all REST configurations (Schemas) from a database","description":"Used to get all REST configurations (Schemas) from a database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"nsfPath","description":"Path in internet style relative to the Domino data directory.\ne.g. \"demo.nsf\" or \"sales/england/crm_gb.nsf\"","schema":{"type":"string"},"in":"query","required":true}]},"/design/{designType}":{"summary":"Get Design related information","description":"Retrieve design information for a subset of design elements","get":{"tags":["design"],"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"designType","description":"Type of design to query","schema":{"enum":["agents","forms","libraries","views","itemdefinitions","folders","pages","subforms","outlines","navigators","actions","columns","fields"],"type":"string"},"in":"path","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/DesignFormSimple"},{"$ref":"#/components/schemas/DesignSubFormSimple"},{"$ref":"#/components/schemas/DesignViewSimple"},{"$ref":"#/components/schemas/DesignAgentSimple"}]}},"examples":{"forms":{"value":[{"@hide":"","@conflictation":"createconflicts","@unid":"639C1AE5A68680C2482584350046F7C3","@alias":[],"@noteid":"196","@name":"fromSalesforce","Body":{"allowmultivalues":false,"kind":"","type":"text"}},{"@hide":"","@conflictation":"createconflicts","@unid":"A0DC3840E8CC9615482584350041A8CF","@alias":[],"@noteid":"182","@name":"SampleForm","Shape":{"allowmultivalues":false,"kind":"editable","type":"text"},"Color":{"allowmultivalues":false,"kind":"editable","type":"text"},"Taste":{"allowmultivalues":false,"kind":"editable","type":"text"},"Age":{"allowmultivalues":true,"kind":"editable","type":"number"},"Name":{"allowmultivalues":true,"kind":"editable","type":"text"}}]},"agents":{"value":[{"@documentset":"Defined by selection formula, check in Domino Designer","@name":"SalesforceProcessing","@noteid":"19e","@trigger":"docupdate","@type":"lotusscript","@unid":"56D541DC5BCAF1384825843500477872","@validForKeep":true,"":"\n \n fromSalesforce\n \n ","options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub"},{"@documentset":"Defined by selection formula, check in Domino Designer","@name":"FixBody","@noteid":"1aa","@trigger":"actionsmenu","@type":"lotusscript","@unid":"3F8E64B529DA6CF848258435004A37CC","@validForKeep":false,"":"\n \n fromSalesforce\n \n ","options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub"}]},"views":{"value":[{"@alias":[],"@unid":"86C72C1BF64B6DF04825847100373215","@selectionFormula":"SELECT (Form = \"Customer\")","@name":"Customers","@noteid":"1be","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}},{"@alias":[],"@unid":"0E35D520A1EBBB5B48258435003E8284","@selectionFormula":"SELECT @All","@name":"($All)","@noteid":"11a","$0":{"title":"#","formula":"@DocNumber"},"Form":{"title":"Form","formula":""},"$2":{"title":"Created","formula":"@Created"}}]},"subForms":{"value":[{"@alias":"subFormAlias","@conflictaction":"createconflicts","@hide":"","@name":"subFormSharedField","@noteid":"282","@unid":"CC96242D1260ED3B4825881E002A410B","Group":{"kind":"editable","type":"text","allowmultivalues":false},"Group_Leader":{"kind":"editable","type":"text","allowmultivalues":false}},{"@alias":"","@conflictaction":"createconflicts","@hide":"","@name":"subFormCommon","@noteid":"28e","@unid":"90FCDCE1F75415004825881E002A9A48","Company":{"kind":"editable","type":"text","allowmultivalues":false},"Company_Address":{"kind":"editable","type":"text","allowmultivalues":false}}]}}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFound":{"value":{"status":404,"message":"demo doesn't have the design element actions named SampleForm ","errorId":0}}}}},"description":"No such design"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchDesignType","summary":"Retrieve list of design elements for a database for a specific type","description":"List design information in JSON format for a subset of design elements in JSON format.","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"description":"a simplified view or form description as JSON element","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"}}},"required":true},"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCreateDesignResponse"}},"examples":{"Created views":{"value":[{"success":true,"type":"view","name":"Customers Categorized","log":"\n\n"},{"success":true,"type":"view","name":"Customers","log":"\n\n"}]},"Created forms":{"value":[{"success":true,"type":"form","name":"Contacts","log":"\n\n"},{"success":true,"type":"form","name":"Customers","log":"\n\n"}]}}}},"description":"Successful update of design element"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"updateDesignFromSchema","summary":"Uses a schema to create forms matching the default","description":"Shortcut for schema first development, forms only","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"designType","description":"Type of design to query","schema":{"enum":["agents","forms","libraries","views","itemdefinitions","folders","pages","subforms","outlines","navigators","actions","columns","fields"],"type":"string"},"in":"path","required":true},{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition","schema":{"type":"string"},"in":"query","required":false}]},"/design/{designType}/{designName}":{"summary":"Get design information for a specific design element.","description":"Retrieve design information for a specific design element in json format.\n\nFor designType 'forms', the 'designName' you should give a value of the specfic name of the form you have configure. You can configure other designType likewise.","get":{"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DesignFormSimple"},{"$ref":"#/components/schemas/DesignSubFormSimple"},{"$ref":"#/components/schemas/DesignViewSimple"},{"$ref":"#/components/schemas/DesignAgentSimple"}]},"examples":{"ViewSample":{"value":{"@alias":[],"@unid":"86C72C1BF64B6DF04825847100373215","@selectionFormula":"SELECT (Form = \"Customer\")","@name":"Customers","@noteid":"1be","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}}},"FormSample":{"value":{"@hide":"","@conflictation":"createconflicts","@alias":[],"@name":"SampleForm","Shape":{"allowmultivalues":false,"kind":"editable","type":"text"},"Color":{"allowmultivalues":false,"kind":"editable","type":"text"},"Taste":{"allowmultivalues":false,"kind":"editable","type":"text"},"Age":{"allowmultivalues":true,"kind":"editable","type":"number"},"Name":{"allowmultivalues":true,"kind":"editable","type":"text"}}},"AgentSample":{"value":"\r\n \r\n fromSalesforce\r\n \r\n %REM\r\n\tAgent SalesforceProcessing\r\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\r\n\tDescription: Comments for Agent\r\n%END REM\r\nOption Public\r\nOption Declare\r\n\r\n\r\nSub Initialize\r\n\tDim s As New NotesSession\r\n\tDim db As NotesDatabase\r\n\tDim dcol As NotesDocumentCollection\r\n\tDim doc As NotesDocument\r\n\tDim nextDoc As NotesDocument\r\n\tSet db = s.Currentdatabase\r\n\tSet dcol = db.Unprocesseddocuments\r\n\tSet doc = dcol.Getfirstdocument()\r\n\tWhile Not doc Is Nothing\r\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\r\n\t\tCall handleOneDoc(doc)\r\n\t\tCall s.Updateprocesseddoc(doc)\r\n\t\tSet doc = nextDoc\r\n\tWend\r\nEnd Sub\r\n\r\n\r\n\r\n%REM\r\n\tSub handleOneDoc\r\n\tDescription: Creates a RichTextItem for all Fields\r\n%END REM\r\nSub handleOneDoc(doc As NotesDocument)\r\n\tDim rt As NotesRichTextItem\r\n\tDim item As NotesItem\r\n\tSet rt = doc.Createrichtextitem(\"Body\")\r\n\tForAll i In doc.Items\r\n\t\tSet item = i\r\n\t\tIf item.name <> \"Body\" Then\r\n\t\t\trt.Appendtext(item.Name)\r\n\t\t\trt.Appendtext(\": \")\r\n\t\t\trt.Appendtext(item.Text)\r\n\t\t\trt.Addnewline(1)\r\n\t\tEnd If\r\n\tEnd ForAll\t\r\n\r\n\tCall doc.save(True,True)\r\nEnd Sub"},"SubFormSample":{"value":{"@alias":"subFormAlias","@conflictaction":"createconflicts","@hide":"","@name":"subFormSharedField","@noteid":"282","@unid":"CC96242D1260ED3B4825881E002A410B","Group":{"kind":"editable","type":"text","allowmultivalues":false},"Group_Leader":{"kind":"editable","type":"text","allowmultivalues":false}}}}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFound":{"value":{"status":404,"message":"demo has no design element of type actions","errorId":0}}}}},"description":"No such design"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getDesign","summary":"Retrieve individual design element for a database","description":"Retrieve design information in JSON format for a specific design element in JSON format.","x-keep-version":1,"x-keep-scope":"$SETUP"},"put":{"requestBody":{"description":"a simplified view or form description as JSON element","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DesignFormSimpleRequest"},{"$ref":"#/components/schemas/DesignViewSimpleRequest"}]},"examples":{"formRequest":{"value":{"name":"NewEntry","alias":"","fields":[{"name":"name","type":"text","allowmultivalues":false},{"name":"email","type":"text","allowmultivalues":false},{"name":"newField","type":"text","allowmultivalues":true}]}},"viewRequest":{"value":{"name":"newentries","selectionFormula":"Form = \"NewEntry\"","columns":[{"name":"name","title":"name","separatemultiplevalues":false,"sort":"ascending","formula":"name"},{"name":"email","title":"email","separatemultiplevalues":false,"sort":"ascending","formula":"email"}]}}}}},"required":true},"tags":["design"],"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name, required if nsfPath is not specified","schema":{"type":"string"},"in":"query","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCreateDesignResponse"},"examples":{"Created view":{"value":{"success":true,"type":"view","name":"Customers","log":"\n\n"}},"Created form":{"value":{"success":true,"type":"form","name":"Contacts","log":"\n\n"}}}}},"description":"Successful update of design element"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"updateCreateDesign","summary":"Updates a view, form, agent or library","description":"Updates or creates Domino design elements based on simplified JSON","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"sampleFormName":{"value":"SampleForm"}},"name":"designName","description":"Name of design element to retrieve","schema":{"type":"string"},"in":"path","required":true},{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name, required if nsfPath is not specified","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"designType","description":"Type of design element to query","schema":{"enum":["agents","forms","libraries","views","folders","pages","subforms","outlines","navigators","actions","columns","fields","itemdefinitions"],"type":"string"},"in":"path","required":true},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition, required if dataSource is not specified","schema":{"type":"string"},"in":"query","required":false}]},"/admin/purge":{"summary":"Cleanup Keep's missing configurations","description":"When loading KEEP it tries to load all scope/schema combinations showing errors in the log when nsf or schema is missing. This endpoint will clean this up","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeepMissingConfigurations"}}}},"description":"List of Scopes that are invalid (Missing schema or Missing NSFs on the data directory)"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"fetchMissingKeepConfigurations","summary":"Get scope-schema missing configurations","description":"Get scope-schema missing configurations","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"description":"Details to be checked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePurgeBody"},"examples":{"ValidPurges":{"value":{"schemaScopeCombinations":[{"nsfName":"Demo.nsf","scope":"brokendemo","schema":"sampleschema","server":"","unid":"0E35D520A1EBBB5B48258435003E8284"},{"nsfName":"Demo.nsf","scope":"brokendemo2","schema":"sampleschema","server":"","unid":"0E35D520A1EBBB5B48258435003E8285"}]}}}}},"required":true},"tags":["admin"],"parameters":[{"name":"deleteInvestigate","description":"If the action is investigate on GET /admin/purge, delete the scope as well.","schema":{"type":"boolean"},"in":"query","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestMapping"}}}},"description":"Config successfully"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"deleteMissingKeepConfigurations","summary":"Delete scope-schema combinations","description":"Delete scope-schema combinations","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"includeEmptyTrue":{"value":"true"}},"name":"includeEmpty","description":"To include empty or null value in the Scope Document's server field.","schema":{"type":"boolean"},"in":"query","required":false}]}},"components":{"schemas":{"DesignElementSummary":{"title":"Root Type for DesignElementSummary","description":"Summary information for a design element, including basic information for listings","type":"object","properties":{"@name":{"type":"string"},"@alias":{"type":"array","items":{"type":"string"}},"@unid":{"type":"string"},"@flags":{"type":"string"}},"example":{"@name":"Person Form","@alias":["Person"],"@unid":"12345678901234567890123456789012","@flags":"w1"}},"DesignElementSummaryResponse":{"title":"Root Type for DesignElementSummaryResponse","description":"Response object containing an array of design element summary information","type":"object","properties":{"forms":{"type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"agents":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"libraries":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"views":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"folders":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"pages":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"subforms":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"outlines":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"navigators":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"actions":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"columns":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"fields":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}}},"example":{"forms":[{"@name":"Person Form","@alias":["Person"],"@flags":"w1","@unid":"5B157EFC7DD24693852587C70083C6DF"}]}},"AdminBackup":{"title":"Root Type for AdminBackup","description":"Definition of a Domino REST API configuration.","type":"object","properties":{"version":{"description":"Basic information about Domino REST API. ","type":"object"},"databases":{"description":"All database configuration, including keepconfig(KeepConfig.nsf) which has configuration settings for the Domino REST API. ","type":"object"},"apps":{"description":"Application configuration. ","type":"object"}},"example":{"version":{"keep-name":"HCL Domino REST API core API","keep-desc":"Next generation APIs for HCL Domino","image-build":"2022-10-14T03:03:04Z","keep-vendor":"HCL Labs","keep-version":"v1.0 (Build 1.9.0-SNAPSHOT-LocalBuild)"},"databases":{"demort":{"apiName":"demort","nsfPath":"Demo.nsf","iconName":"beach","icon":"Base64 stuff, preferably SVG","description":"test","formulaEngine":"domino","schemaName":"demort","requireRevisionToUpdate":false,"allowDecryption":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"allowCode":true,"openAccess":true,"unid":"6C726915B22B8439482588DA00042F96","forms":[{"formName":"fromSalesforce","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"views":[{"name":"Customers","alias":[],"unid":"86C72C1BF64B6DF04825847100373215"}],"agents":[],"formAliases":{},"isActive":true},"names":{"apiName":"names","nsfPath":"names.nsf","iconName":"mountain","schemaName":"names","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":false,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":false,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":false},"keepconfig":{"apiName":"keepconfig","nsfPath":"KeepConfig.nsf","iconName":"mountain","icon":"Base64 stuff, preferably SVG","description":"Primary directory of this Domain","schemaName":"keepconfig","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":true,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":true}},"apps":{"unknown":{"@unid":"0952193E783BF633C12588DB003AA430","author":"CN=chan clement/O=ProjectKeep","client_id":"7a2e3e-bfbc-eb6dfd","client_name":"Manager App","hasSecret":false,"client_uri":"http://test.local","contacts":["CN=chan clement/O=ProjectKeep"],"description":"Created by MANAGER","logo_uri":"cruise","redirect_uris":["http://test.local"],"scope":"managerscope","status":"isActive","token_endpoint_auth_method":"client_secret_basic"}}}},"AdminCache":{"title":"Root Type for AdminCache","description":"Definition of a Domino REST API cache of design element summaries.","type":"object","properties":{"cached":{"description":"If the specified database has been cached, then return true. Otherwise false. ","type":"boolean"},"apiName":{"description":"How this database is known to the API.","type":"string"},"nsfPath":{"description":"Location on Domino server.","type":"string"},"formcount":{"format":"int32","description":"Form count exsit in the Domino REST API cache folder. ","type":"integer"},"viewcount":{"format":"int32","description":"View count exsit in the Domino REST API cache folder. ","type":"integer"},"agentcount":{"format":"int32","description":"Agent count exsit in the Domino REST API cache folder. ","type":"integer"},"librarycount":{"format":"int32","description":"Library count exsit in the Domino REST API cache folder. ","type":"integer"},"replicaid":{"description":"A 16-character combination of letters and numbers that represents the replica ID of a Notes database.","type":"string"},"title":{"description":"The title of the database.","type":"string"}},"example":{"cached":true,"apiName":"testdb","nsfPath":"Demo.nsf","formcount":8,"viewcount":5,"agentcount":2,"librarycount":0}},"AgentInfo":{"title":"Root Type for AgentInfo","description":"Definition of agent information","type":"object","properties":{"name":{"description":"Name of the agent, matches design","type":"string"},"alias":{"description":"Collection of alternate names, might match aliases of the Domino design","type":"array","items":{"type":"string"}},"unid":{"description":"Primary key to find the agent","type":"string"}},"example":{"name":"(CustomerUpdates)","alias":["KundenAbruf","ग्राहकों"],"unid":"ABCD12345"}},"DesignAgentSimple":{"title":"Root Type for DesignAgentSimple","description":"Definition design information for specific design element Agent.","type":"object","properties":{"@trigger":{"description":"Indicates when this agent runs.","type":"string","readOnly":true},"@documentset":{"description":"Represents a specified set of target documents that are manipulated by an agent.\n\nThe following types run an agent on:\n\nall - All the documents in the database.\n\nallinview - All documents in a view.\n\nmodified - All new and modified documents.\n\nrunonce - The current document once.\n\nselected - Only the selected documents.\n\nunreadinview - All unread documents in a view.\n\nnone","type":"string"},"@unid":{"description":"The Note UNID of the agent.","type":"string"},"@name":{"description":"The name of the agent.","type":"string"},"@validForKeep":{"description":"If this agent has been configured to use in Domino REST API. ","type":"boolean","readOnly":true},"@noteid":{"description":"The note ID of the agent, which is uniquely identifies a document within a particular database.","type":"string"},"@type":{"description":"Indicates the type of the agent (simple action, formula, LotusScript, imported Java, or Java).","type":"string"}},"example":{"@trigger":"MANUAL","@documentset":"SELECTED","@unid":"3F8E64B529DA6CF848258435004A37CC","@name":"Fix Body","@validForKeep":"","@noteid":"","@type":"LOTUSSCRIPT"}},"DesignColumnSimple":{"description":"This is one Datatype used to compose other schemas, DesignViewSimple and DesignViewSimpleRequest","required":["name","formula","separateMultipleValues"],"type":"object","properties":{"name":{"description":"","type":"string"},"title":{"description":"","type":"string"},"formula":{"description":"","type":"string"},"sort":{"description":"","enum":["ascending","descending","none"],"type":"string"},"separateMultipleValues":{"description":"","type":"boolean"}}},"DesignFieldSimple":{"description":"This is one Datatype used to compose other schemas, DesignFormSimple, DesignFormSimpleRequest and DesignSubFormSimple","required":["name","type"],"type":"object","properties":{"name":{"description":"","type":"string"},"type":{"description":"","enum":["text","number","richtext","datetime"],"type":"string"},"allowMultiValues":{"description":"","type":"boolean"}}},"DesignFormSimple":{"description":"Definition design information for specific design element Form.","required":["name","fields"],"type":"object","properties":{"@conflictaction":{"description":"Indicates how to handle form replication conflicts. ","type":"string","readOnly":true,"example":"createconflicts"},"@hide":{"type":"string","readOnly":true},"@name":{"description":"The name of the form.","type":"string","readOnly":true,"example":"TestForm"},"@noteid":{"description":"The note ID of a document, which is uniquely identifies a document within a particular database.","type":"string","readOnly":true,"example":"276"},"@unid":{"description":"Universal Id of the document, uniquely identifies a document across all replicas of a database","type":"string","readOnly":true,"example":"360A6B7035CD03C248258816000DDB47"},"@alias":{"description":"Alternate names or alias of the form.","type":"string","readOnly":true,"example":"TestForm"},"fields":{"description":"The fields on a forms. ","type":"array","items":{"$ref":"#/components/schemas/DesignFieldSimple"}}},"example":{"@alias":"TestForm","@conflictaction":"createconflicts","@hide":"web mobile","@name":"TestForm","@noteid":"276","@unid":"360A6B7035CD03C248258816000DDB47","first_name":{"kind":"editable","type":"text"},"last_name":{"kind":"editable","type":"text"},"email":{"kind":"editable","type":"text"},"gender":{"kind":"editable","type":"text"},"ip_address":{"kind":"editable","type":"text"},"Color":{"kind":"editable","type":"text"},"Pet":{"kind":"editable","type":"text"},"@created":{"kind":"editable","type":"datetime"},"$FILES":{"kind":"editable","type":"attachment"}}},"DesignFormSimpleRequest":{"title":"Root Type for DesignFormSimpleRequest","description":"Definition of request to create specific design element Form.","type":"object","properties":{"name":{"description":"The name of the form.","type":"string"},"alias":{"description":"Alternate names or alias of the form.","type":"string"},"fields":{"description":"The fields on a forms. ","type":"array","items":{"$ref":"#/components/schemas/DesignFieldSimple"}}},"example":{"name":"Entry","alias":"","fields":[{"name":"name","type":"text","allowmultivalues":false},{"name":"email","type":"text","allowmultivalues":false},{"name":"newField","type":"text","allowmultivalues":true}]}},"DesignNSFSimple":{"description":"Basic database object. NOTE: This is fit for limited current purpose, not complete for production","required":["title","nsfPath"],"type":"object","properties":{"title":{"description":"Datbase title","type":"string","example":"Our esteemed customers"},"templateName":{"description":"programmatic filename of the template, like 'demo.ntf'","type":"string","example":"DAOSsnap.ntf"},"nsfPath":{"description":"Path in internet style relative to the Domino data directory","type":"string","example":"crm/customers.nsf"}},"additionalProperties":false},"DesignSubFormSimple":{"title":"Root Type for DesignSubFormSimple","description":"Definition design information for specific design element Form.","type":"object","properties":{"@conflictaction":{"description":"Indicates how to handle form replication conflicts. ","type":"string","readOnly":true,"example":"createconflicts"},"@hide":{"type":"string","readOnly":true},"@name":{"description":"The name of the form.","type":"string","readOnly":true,"example":"subFormSharedField"},"@noteid":{"description":"The note ID of a document, which is uniquely identifies a document within a particular database.","type":"string","readOnly":true,"example":"276"},"@unid":{"description":"Universal Id of the document, uniquely identifies a document across all replicas of a database","type":"string","readOnly":true,"example":"360A6B7035CD03C248258816000DDB47"},"@alias":{"description":"Alternate names or alias of the form.","type":"string","readOnly":true,"example":"subFormAlias"},"fields":{"description":"The fields on a subform. ","type":"array","items":{"$ref":"#/components/schemas/DesignFieldSimple"}}},"example":{"@alias":"subFormAlias","@conflictaction":"createconflicts","@hide":"","@name":"subFormSharedField","@noteid":"282","@unid":"CC96242D1260ED3B4825881E002A410B","Group":{"kind":"editable","type":"text","allowmultivalues":false},"Group_Leader":{"kind":"editable","type":"text","allowmultivalues":false}}},"DesignViewSimple":{"description":"Definition design information for specific design element View.","required":["name","columns","selectionFormula"],"type":"object","properties":{"@name":{"description":"The name of the view.","type":"string","readOnly":true,"example":"Customers"},"@noteid":{"description":"The note ID of a view, which is uniquely identifies a view within a particular database.","type":"string","readOnly":true,"example":"222"},"@unid":{"description":"Universal Id of the view, uniquely identifies a view across all replicas of a database","type":"string","readOnly":true,"example":"86C72C1BF64B6DF04825847100373215"},"@alias":{"description":"Alternate names or alias of the view.","type":"string","readOnly":true},"selectionFormula":{"description":"","type":"string"},"columns":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignColumnSimple"}}},"example":{"@alias":"","@name":"Customers","@noteid":"1be","@unid":"86C72C1BF64B6DF04825847100373215","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}}},"DesignViewSimpleRequest":{"title":"Root Type for DesignViewSimpleRequest","description":"Definition of request to create specific design element View.","type":"object","properties":{"name":{"description":"The name of the view.","type":"string"},"selectionFormula":{"description":"The formula to select documents for a view. ","type":"string"},"columns":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignColumnSimple"}}},"example":{"name":"entries","selectionFormula":"Form = \"Entry\"","columns":[{"name":"name","title":"name","separatemultiplevalues":false,"sort":"ascending","formula":"name"},{"name":"email","title":"email","separatemultiplevalues":false,"sort":"ascending","formula":"email"}]}},"ErrorMessage":{"title":"Root Type for ErrorMessage","description":"Detailed error message, might contain stacktrace","type":"object","properties":{"details":{"type":"string"},"message":{"type":"string"},"status":{"format":"int32","type":"integer"}},"example":{"details":"Long list of details","message":"We screwed up","status":500}},"KeepAccess":{"title":"Root Type for KeepAccess","description":"Provides information of access level required for Domino REST API operations:\n- Domino REST API mapping in Domino directory\n- Domino REST API configuration in individual databases\n\nMasks ACL and Role checks for users of the API","required":["CreateDbMapping","DeleteDbMapping"],"type":"object","properties":{"CreateDbMapping":{"description":"Can the current user create Domino REST API configuration mappings","type":"boolean"},"DeleteDbMapping":{"description":"Can the current user delete Domino REST API configuration mappings","type":"boolean"},"databases":{"description":"Details of access to a given database","type":"array","items":{"$ref":"#/components/schemas/KeepAccessDetail"}}},"example":{"CreateDbMapping":true,"DeleteDbMapping":true,"databases":[{"path":"demo.nsf","readKeepConfig":true,"createDeleteKeepConfig":true,"configurations":["demotest"],"activeConfigurations":{"demotest":"demotest"}},{"path":"names.nsf","readKeepConfig":true,"createDeleteKeepConfig":true,"configurations":["names"],"activeConfigurations":{"names":"names"}}]}},"KeepAccessDetail":{"title":"Root Type for KeepAccessDetail","description":"Information about access to an individual database and, if access is sufficient, information about available configurations","type":"object","properties":{"path":{"description":"Path relativ to the data directory of an NSF","type":"string","example":"apps/demo.nsf"},"readKeepConfig":{"description":"Can the given user read existing Domino REST API configurations","type":"boolean","example":"true"},"createDeleteKeepConfig":{"description":"Can the current user create or delete Domino REST API configurations","type":"boolean","example":"true"},"configurations":{"description":"List of Domino REST API configurations, ready to be mapped, in the design of a database","type":"array","items":{"$ref":"#/components/schemas/KeepAccessQuery"},"example":"[\n {\n \"name\": \"alternateapprovals\",\n \"description\": \"Schema alternateapprovals\",\n \"iconName\": \"mountain\"\n },\n {\n \"name\": \"capprov\",\n \"description\": \"central approval\",\n \"iconName\": \"archeology\"\n },\n {\n \"name\": \"default2\",\n \"description\": \"Get approvals for training, travel and gear\",\n \"iconName\": \"sell\"\n }\n]"},"activeConfigurations":{"description":"Map of confgurations in use. Key is the public name, value the NSF internal name","type":"array","items":{"type":"object"},"example":"{\n \"demo\": \"demo\"\n}"}},"example":{"path":"demo.nsf","readKeepConfig":true,"createDeleteKeepConfig":true,"configurations":[{"name":"alternateapprovals","description":"Schema alternateapprovals","iconName":"mountain"},{"name":"capprov","description":"central approval","iconName":"archeology"},{"name":"default2","description":"Get approvals for training, travel and gear","iconName":"sell"}],"activeConfigurations":{"demo":"demo"}}},"KeepAccessQuery":{"title":"Root Type for KeepAccessQuery","description":"Query to be send to check if user can read/update/delete Domino REST API configurations","required":["checkAllNsf","onlyConfigured"],"type":"object","properties":{"databases":{"description":"List of file path to enquiry","type":"array","items":{"type":"string"}},"checkAllNsf":{"description":"Should the query check all databases on the current server - might take a while. Excludes mail files","type":"boolean","example":"false"},"onlyConfigured":{"description":"Should only databases with existing Domino REST API configurations be returned","type":"boolean"}},"example":{"checkAllNsf":false,"onlyConfigured":false,"databases":["demo.nsf","apps/crm.nsf"]}},"KeepAccessShort":{"title":"Root Type for KeepAccessShort","description":"Provides simple information of access level required for Domino REST API access get operations:\n- Domino REST API mapping in Domino directory\n- Domino REST API configuration in individual databases\n\nMasks ACL and Role checks for users of the API","type":"object","properties":{"CreateDbMapping":{"description":"Can the current user create Domino REST API configuration mappings","type":"boolean"},"DeleteDbMapping":{"description":"Can the current user delete Domino REST API configuration mappings","type":"boolean"}},"example":{"CreateDbMapping":true,"DeleteDbMapping":true}},"KeepDatabase":{"title":"Root Type for KeepDatabase","description":"REST API Configuration of a domino database including views, forms, agents, modes. Used only for admin endpoints.","required":["nsfPath","formulaEngine","isActive"],"type":"object","properties":{"apiName":{"description":"How this database is known to the API","type":"string"},"description":{"description":"Description with human readable details of the database's purpose","type":"string"},"formulaEngine":{"description":"Script engine to be used to resolve permission formulas in FormModes or DQL access.\nNative Domino, OpenFormula or JavaScript\n\nCurrently only Native Domino is implemented","enum":["domino","openformula","javascript"],"type":"string"},"icon":{"description":"Base64 of an icon. SVG preferred","type":"string"},"iconName":{"description":"alt text for icon","type":"string"},"isActive":{"description":"Allows to enable/disable API access without removing cofiguration. This is used for scope. active is used for schema. ","type":"boolean"},"agents":{"description":"List of agents that are permitted to be called from the API","type":"array","items":{"$ref":"#/components/schemas/AgentInfo"}},"allowCode":{"description":"Can JS code be submitted for execution","type":"boolean"},"configuredForms":{"description":"All forms that are configured for access via the Domino REST API. Details in keepdatabaseconfig_formmode","type":"array","items":{"type":"string","readOnly":true}},"dqlAccess":{"description":"Does the API allow DQL queries to be submitted? DQL can query any document. Handle with care","type":"boolean"},"forms":{"description":"Array with form configurations including form modes","type":"array","items":{"$ref":"#/components/schemas/KeepForm"}},"openAccess":{"description":"Can this database be accessed from a browser e.g. in a React app) or app without providing AppId and AppSecret. Still proper authentication using a JWT bearer is required","type":"boolean"},"dqlFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to execute when DQL Access is permitted to determine if it is permitted for the current user.\nDomino or OpenFormula"},"formAliases":{"description":"Collection of key / value pairs to map primary form names to potential alias values. A Notes document created with a form containing the alias will have the last alias value in its Form field","type":"object"},"requireRevisionToUpdate":{"description":"If db config \"requireRevisionToUpdate\" is enabled, then revision is required when update document and only update document when revision version is right.\r\n ","type":"boolean"},"views":{"description":"Array of Views that are available in the Domino REST API","type":"array","items":{"$ref":"#/components/schemas/ViewInfo"}},"nsfPath":{"description":"Location on Domino server","type":"string"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources","type":"string"},"allowDecryption":{"description":"Allow decrypt the database","type":"boolean"},"cacheTimestamp":{"description":"timestamp for when design data were last added","type":"integer"},"@unid":{"description":"Universal Id of the document to be acted upon","type":"string","readOnly":true},"dxlpath":{"description":"DXL path for this database","type":"string","readOnly":true},"availableViews":{"description":"Array of Views that are available in the Domino REST API","type":"array","items":{"$ref":"#/components/schemas/ViewInfo"}},"prohibitRefresh":{"description":"indicates if the schema is protected against refresh by the design tast","type":"boolean"},"@warnings":{"description":"List of design elements that are not in the database.","type":"array","items":{"type":"string"}}},"example":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"MarketingInfo","alias":["MarketingInfo"],"unid":"10EA9EC66EA748BC4825851100420810"},{"name":"ChineseCustomers","alias":["ChineseCustomers"],"unid":"3FE5CD63E179F21600258680006DB25B"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"},{"name":"Samples","alias":["Samples"],"unid":"5318911D496571410025860D00544B17"}],"agents":[],"forms":[{"formName":"Customer","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form","first_name","email"],"fields":[{"name":"Body","fieldAccess":"RW","type":"object","format":"richtext","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":[],"summaryField":false},{"name":"color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"email","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"employee_count","fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"first_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"hobbies","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"last_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Owner","fieldAccess":"RW","type":"string","format":"authors","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY","READWRITERS"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Body","fieldAccess":"RW","type":"object","format":"richtext","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":[],"summaryField":false},{"name":"color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"email","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"employee_count","fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"first_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"hobbies","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"last_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Owner","fieldAccess":"RW","type":"string","format":"authors","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY","READWRITERS"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Body","fieldAccess":"RW","type":"object","format":"richtext","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":[],"summaryField":false},{"name":"color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"email","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"employee_count","fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"first_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"hobbies","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"last_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Owner","fieldAccess":"RW","type":"string","format":"authors","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY","READWRITERS"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]},{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"3D59BBE2676B2A45002588FD001E4B2A"}},"KeepField":{"title":"Root Type for KeepField","description":"Field description for fields / items in a KeepFormMode.\nDescribes name, type, and multi-value capability.\nModeled after json-schema where multi-value = array\nextension to json-schema limited to x-access-name\nto specify Domino Names, Reader, Author nature\nAll other field copied from JSON Schema","required":["type","name"],"type":"object","properties":{"name":{"description":"Field name. While anything theoretical is possible we stick to letters and numbers with the first letter capitalized. Not a hard rule to accomodate existing data","type":"string","example":"Form"},"type":{"description":"Data type, from JSON spec. Can be:\n- object\n- array\n- string\n- number\n- integer\n- boolean","enum":["object","array","string","number","integer","boolean"],"type":"string","example":"string"},"multivalue":{"description":"Can the field process multiple values, HCL Domino style.\nWhen missing => false","type":"boolean","readOnly":true,"example":"true"},"fieldGroup":{"description":"Domino multi-value fields can be grouped together to form a kind oc child record in a document. The fieldGroup defines such a grouping. It only is relevant for multi-value fields and isn't populated by default","type":"string","example":"recipients"},"description":{"description":"Long text explanation what the field is about","type":"string","example":"Enter the following information yada yada yada"},"format":{"description":"Format definition for Strings, extended from json-schema with readers, authors, names, json","enum":["authors","binary","byte","date","date-time","double","float","int32","int64","names","password","readers","richtext","boolean","string","json","attachments"],"type":"string","example":"names"},"items":{"description":"Item description can contain type and format","type":"object"},"minitems":{"description":"for array type: minimum number of items","type":"integer","example":"2"},"uniqueitems":{"description":"Shall array members be unique","type":"boolean","example":"true"},"minimum":{"description":"lowest value, value included","type":"number","example":"2"},"maximum":{"description":"maximum value, not included","type":"number","example":"42"},"exclusiveMinimum":{"description":"Minimum value, not included","type":"number","example":"4"},"maxLength":{"description":"not longer than that","type":"integer","example":"93"},"minLength":{"description":"Low long is a String","type":"integer","example":"4"},"fieldAccess":{"description":"Determines the access to a field as Read/Write, ReadOnly or WriteOnly","enum":["RW","RO","WO"],"type":"string"}},"example":{"name":"Age","type":"array","fieldGroup":"person","items":{"type":"integer","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1}},"KeepFieldGroup":{"title":"Root Type for KeepFieldGroup","description":"A KeepFieldGroup describes the properites of a group of multi-value Notes items that form \"child records\" inside a single Notes document. Besides multi-value items, items with a common name and a counting suffix can form a field group","required":["type","name","suffix"],"type":"object","properties":{"name":{"description":"Name tha links this definition to fieldGroup entries in KeepFields","type":"string","example":"itemLine"},"type":{"description":"How is the group formed: by multi-value or common field name with counting suffix ","enum":["byName","multiValue"],"type":"string","example":"multiValue"},"suffix":{"description":"Separation character(s) between item name and counter","type":"string","example":"_"},"firstWithoutSuffix":{"description":"For name linked items, does the first have the suffix (Name_1) or not (Name)","type":"boolean","example":"true"},"max":{"format":"int32","description":"MAximum number of rows/item names to use","type":"integer","example":"42"}},"example":{"name":"OrderLine","type":"byName","suffix":"_","firstWithoutSuffix":true,"max":50}},"KeepForm":{"description":"Definition of a Domino REST API form including form modes","required":["formName","formModes"],"type":"object","properties":{"formName":{"description":"Name of the form as stored in the document, might be an alias","type":"string"},"fieldGroups":{"description":"Definition of fieldgroups that form detail records inside a document","type":"array","items":{"$ref":"#/components/schemas/KeepFieldGroup"}},"formModes":{"description":"Array of FormModes configured for this database. Might be empty","minItems":1,"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/KeepFormMode"}},"alias":{"description":"Alternate names or alias of the form.","type":"array","items":{"type":"string"}}}},"KeepFormMode":{"title":"Root Type for KeepFormMode","description":"Form modes for Domino REST API Database config","required":["deleteAccessFormula","modeName","fields","readAccessFormula","writeAccessFormula"],"type":"object","properties":{"computeWithForm":{"description":"Compute with form before saving","type":"boolean"},"deleteAccessFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formuls to determine delete access"},"modeName":{"description":"lowercase, name of the mode. Special names are default and odata ","type":"string"},"onLoad":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to run after loading a document, before returning to the caller"},"onSave":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to run after receiving a document, before save"},"readAccessFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to determine read access for this mode"},"writeAccessFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to determine write permissions"},"validationRules":{"description":"formula rules to determine access","type":"array","items":{"$ref":"#/components/schemas/KeepFormula"}},"fields":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/components/schemas/KeepField"}}],"description":"all fields in this mode","type":"array","items":{"$ref":"#/components/schemas/KeepField"}},"required":{"description":"List of fields that are required to be provided","type":"array","items":{"type":"string"}},"readAccessFields":{"description":"read access fields in this mode","type":"array","items":{"$ref":"#/components/schemas/KeepField"}},"writeAccessFields":{"description":"write access fields in this mode","type":"array","items":{"$ref":"#/components/schemas/KeepField"}}},"example":{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false,"required":["Form","first_name","email"],"fields":[{"name":"color","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"email","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"first_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Form","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RO","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"hobbies","type":"array","format":"string","items":{"type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"last_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Pet","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true}],"readAccessFields":[{"name":"color","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"email","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"first_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Form","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RO","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"hobbies","type":"array","format":"string","items":{"type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"last_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Pet","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true}],"writeAccessFields":[{"name":"color","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"email","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"first_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"hobbies","type":"array","format":"string","items":{"type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"last_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Pet","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true}]}},"KeepFormula":{"title":"Root Type for KeepFormula","description":"Formula in a scripting environment, that can be used for true/false evaluation or as a pre-load/save execution.","required":["formulaType"],"type":"object","properties":{"formulaType":{"description":"computation model, currently Domino only","enum":["domino"],"type":"string"},"formula":{"description":"Formula code to run","type":"string"},"message":{"description":"Optional message to use for fasilure of formula","type":"string"}},"example":{"formulaType":"Domino","formula":"@IsMember(\"[RaiseRequest]\"; @UserNamesList)"}},"QuickConfigParam":{"description":"Definition of request to quick config a domino database","required":["nsfPath"],"type":"object","properties":{"scopeName":{"description":"Name that is used in ?datSsource= parameter to access configured resource","type":"string"},"nsfPath":{"description":"path relative to Domino data directory to nsf database","type":"string"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources. Default value is \"default\"","type":"string"},"create":{"description":"If nsf file not exist, create one empty database or not.","type":"boolean"},"description":{"description":"Description to the configured scope","type":"string"},"icon":{"description":"Base64 of an icon. SVG preferred","type":"string"},"iconName":{"description":"alt text for icon","type":"string"},"maximumAccessLevel":{"description":"Determines the maximum ACL Level for the scope definition.\nDefault if not provided is Editor","enum":["NoAccess","Depositor","Reader","Author","Editor","Designer","Manager"],"type":"string"}}},"RestConfigShort":{"title":"Root Type for RestConfigShort","description":"Short summary of a rest configuration","type":"object","properties":{"apiName":{"description":"How this database is known to the API","type":"string"},"comment":{"description":"The comment assigned to the design element","type":"string"},"template":{"description":"The name of the note-specific template this design element is set to derive from","type":"string"},"prohibitRefresh":{"description":"When notes database has been configured \"Inherit from the design template\", if \"Prohibit design refresh or replace to modify\" is checked, the design element will not be affected when you replace or refresh the design.","type":"boolean"}},"additionalProperties":false,"example":{"apiName":"restcon","comment":"REST API configuration restcon2","template":"","prohibitRefresh":false}},"OAuthApplicationRequest":{"title":"Root Type for OAuthApplicationRequest","description":"Meta data to register an application for OAuth IdP","required":["client_name","scope","client_uri","redirect_uris"],"type":"object","properties":{"client_name":{"description":"Human readable Application name","type":"string"},"description":{"description":"Description what the application does","type":"string"},"redirect_uris":{"description":"List of callback URLs after consent is given. Must use https with the exception of http://localhost/some_url","type":"array","items":{"type":"string"}},"scope":{"description":"Scopes the application can (and will) request. When the application requests other scopes, token is denied","type":"string"},"client_uri":{"description":"Start page of application. Can be used to create list of apps","type":"string"},"logo_uri":{"description":"Optional: application logo URL","type":"string"},"status":{"description":"Is this application active","enum":["isActive","disabled"]},"contacts":{"description":"URL, eMail, handles to contact people responsible for the app","type":"array","items":{"type":"string"}},"token_endpoint_auth_method":{"description":"Token endpoint authentication","type":"string"},"client_id":{"description":"Application ID. Empty on creation, required for update","type":"string"}},"additionalProperties":false,"example":{"client_name":"My App","description":"Super cool demo App","redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","contacts":["admin@projectcastle.io"],"token_endpoint_auth_method":"client_secret_basic","status":"isActive"}},"OAuthApplicationRequestUpdate":{"title":"Root Type for OAuthApplicationRequestUpdate","description":"Meta data to register an application for updating OAuth IdP","type":"object","properties":{"client_name":{"description":"Human readable Application name","type":"string"},"description":{"description":"Description what the application does","type":"string"},"redirect_uris":{"description":"List of callback URLs after consent is given. Must use https with the exception of http://localhost/some_url","type":"array","items":{"type":"string"}},"scope":{"description":"Scopes the application can (and will) request. When the application requests other scopes, token is denied","type":"string"},"client_uri":{"description":"Start page of application. Can be used to create list of apps","type":"string"},"logo_uri":{"description":"Optional: application logo URL","type":"string"},"status":{"description":"Is this application active","enum":["isActive","disabled"]},"contacts":{"description":"URL, eMail, handles to contact people responsible for the app","type":"array","items":{"type":"string"}},"token_endpoint_auth_method":{"description":"Token endpoint authentication","type":"string"},"isActive":{"description":"DEPRECATED, Don't use","type":"string"},"client_id":{"description":"Internal application id. Ignored here, taken from URL query parameter","type":"string"}},"additionalProperties":false,"example":{"client_name":"My App","description":"Super cool demo App","redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","contacts":["admin@projectcastle.io"],"token_endpoint_auth_method":"client_secret_basic","status":"isActive"}},"OAuthApplicationResponse":{"title":"Root Type for OAuthApplicationResponse","description":"Response for registering an application for OAuth IdP","required":["client_id","client_name","client_uri","redirect_uris","scope","status","token_endpoint_auth_method"],"type":"object","properties":{"client_name":{"description":"Human readable Application name","type":"string"},"description":{"description":"Desscription what the application does","type":"string"},"client_id":{"description":"System generated client Id. Used for auth request and as user name for Token requests","type":"string"},"redirect_uris":{"description":"List of callback URLs after consent is given. Must use https with the exception of http://localhost/some_url","type":"array","items":{"type":"string"}},"scope":{"description":"Scopes the application can (and will) request. When the application requests other scopes, token is denied","type":"string"},"client_uri":{"description":"Start page of application. Can be used to create list of apps","type":"string"},"logo_uri":{"description":"Optional: application logo URL","type":"string"},"token_endpoint_auth_method":{"description":"Token endpoint authentication","enum":["client_secret_basic"],"type":"string"},"status":{"description":"Is this application active","enum":["isActive","disabled"],"type":"string"},"contacts":{"description":"URL, eMail, handles to contact people responsible for the app","type":"array","items":{"type":"string"}},"@unid":{"description":"Universal Id of the document.","type":"string","readOnly":true},"@author":{"description":"The person who created the external application","type":"string","readOnly":true},"hasSecret":{"description":"Flag to indicate if an application has a secret configured","type":"boolean"}},"additionalProperties":false,"example":{"@unid":"F1490F201EB9D8C5482588B50013F519","author":"CN=John Doe/O=ProjectKeep","client_id":"429022-562b-641620","client_name":"My App","hasSecret":false,"client_uri":"https://www.projectcastle.io/coolapp","contacts":["admin@projectcastle.io","CN=John Doe/O=ProjectKeep"],"description":"Super cool demo App-testupdate","logo_uri":"http://www.projectcastle.io/castle.jpg","redirect_uris":["http://domino.projectcastle.io/identity","http://localhost/callback","http://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","status":"disabled","token_endpoint_auth_method":"client_secret_basic"}},"OAuthApplicationSecretRequest":{"title":"Root Type for OAuthApplicationSecretRequest","description":"Meta data to generated secret for an application.","required":["status"],"type":"object","properties":{"status":{"description":"Whether the application is active or disabled.","enum":["isActive","disabled"],"type":"string","example":"isActive"},"client_id":{"description":"Parameter to prevent error for apps that call this API. Value of this gets ignored internally. Use the path parameter for passing client_id.","type":"string"}},"additionalProperties":false,"example":{"status":"isActive"}},"OAuthApplicationSecretResponse":{"title":"Root Type for OAuthApplicationSecretResponse","description":"Response for a client_secret request. Client seccret is returned once","required":["client_id","client_secret"],"type":"object","properties":{"client_id":{"description":"application ID, required as header for access","type":"string"},"client_secret":{"description":"The application secret generated by Domino REST API for the external application","type":"string"}},"additionalProperties":false,"example":{"client_id":"9c5fed-38c4-441808","client_secret":"7e368d-6b3b-54eda8"}},"ViewInfo":{"title":"Root Type for ViewInfo","description":"","type":"object","properties":{"name":{"description":"Name of the view, matches design","type":"string"},"alias":{"description":"Collection of alternate names, might match aliases of the Domino design","type":"array","items":{"type":"string"}},"unid":{"description":"Primary key to find the view","type":"string"},"selectionFormula":{"description":"The formula to select documents for a view.","type":"string"},"columns":{"description":"List of columns in the view","type":"array","items":{"type":"object","properties":{"title":{"description":"Title of the column.","type":"string"},"formula":{"description":"Formula of the column.","type":"string"},"name":{"description":"Name of the column.","type":"string"},"externalName":{"description":"Another name for the column, if this is present, this will be what the column will be known as.","type":"string"}}}}},"example":{"name":"(Customers)","alias":["Kunden","ग्राहकों"],"unid":"ABCD12345","selectionFormula":"SELECT (Form = \"Customer\")","columns":[{"title":"CustomerID","formula":"@DocNumber","name":"$1"},{"title":"FirstName","formula":"","name":"first_name"},{"title":"LastName","formula":"","name":"last_name"}]}},"Unid":{"description":"32 char universalId A-Z0-9, primary key unique across replicas","maxLength":32,"minLength":32,"pattern":"[0-9A-F]*","type":"string","readOnly":true,"example":"6834F14BE9CA69F68525871E00583D1B"},"StatusMessage":{"title":"Root Type for StatusMessage","description":"Keep-formatted status message","required":["message","status","statusCode"],"type":"object","properties":{"status":{"description":"Success / failure status","type":"string"},"statusCode":{"format":"int32","description":"HTTP status code","type":"integer"},"message":{"description":"Short descriptive message","type":"string"},"unid":{"$ref":"#/components/schemas/Unid","description":"Document primary key"},"details":{"description":"Json Object containing further details, if appropriate","type":"string"}},"example":{"status":"OK","statusCode":200,"message":"deletion complete","unid":"61CCE871E79E8DDB8025852F004DFF2D"}},"RestMapping":{"title":"Root Type for RestMapping","description":"Maps a rest config from its internal name to the name it is visible. Info can be seen in the Internet sites of the domino directory. Also known as scope","required":["apiName","nsfPath","schemaName","isActive"],"type":"object","properties":{"@meta":{"description":"Document meta data.","type":"object"},"apiName":{"description":"Name that is used in ?datSsource= parameter to access mapped resource","pattern":"[a-z0-9]","type":"string"},"isActive":{"description":"Allows to enable/disable API access without removing cofiguration","type":"boolean"},"@Revisions":{"description":"This field records the current revision version of document. It's a 32-character hex-encoded string of date. ","type":"array","items":{"type":"string"},"example":"[\r\n \"2022-08-03T18:10:22.72+08:00\",\r\n \"2022-08-08T10:14:30.19+08:00\"\r\n]"},"@UpdatedBy":{"description":"The user who update the doc.","type":"array","items":{"type":"string"},"example":"[\r\n \"CN=John Doe/O=ProjectKeep\"\r\n]"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources","pattern":"[a-z0-9]","type":"string"},"nsfPath":{"description":"path relative to Domino data directory to nsf database","type":"string"},"description":{"description":"Human readable explanation","type":"string"},"Form":{"description":"Form name","type":"string","example":"KeepDatabase"},"Type":{"description":"","type":"string","example":"KeepDatabase"},"createSchema":{"description":"Default to be false if you don't set this property. It won't create the schema. When set to be true, it will create schema using given schemaName. ","type":"integer"},"server":{"description":"Domino server name that this scope is enabled on. Empty or '*' mean that this scope is enabled on all Domino servers. ","type":"string"},"maximumAccessLevel":{"description":"Limits, but not extends the access level granted to an API user.\nMirrors the MaximumInternetAccess in DB ACLs.\nDefault if not provided is Editor","enum":["NoAccess","Depositor","Author","Editor","Designer","Manager","Reader"],"type":"string"}},"additionalProperties":false,"example":{"@meta":{"noteid":2342,"unid":"1E280A1798C5C313482588D9002671A2","created":"2022-10-12T14:59:54.58+08:00","lastmodified":"2022-10-12T15:13:36.56+08:00","lastaccessed":"2022-10-12T15:10:26.59+08:00","lastmodifiedinfile":"2022-10-12T15:13:36.57+08:00","addedtofile":"2022-10-12T14:59:54.7+08:00","noteclass":["DATA","DOCUMENT"],"unread":true,"revision":"000000060027B2B8482588D9"},"$UpdatedBy":["CN=John Doe/O=ProjectKeep"],"$Revisions":["2022-10-12T14:59:54.7+08:00","2022-10-12T15:09:02.71+08:00","2022-10-12T15:09:25.33+08:00","2022-10-12T15:09:45.99+08:00"],"apiName":"demoapi","createSchema":0,"description":"The famous demo database","isActive":true,"nsfPath":"Demo.nsf","schemaName":"demoapi","Form":"KeepDatabase","Type":"KeepDatabase","server":"*"}},"RestMappingRequest":{"title":"Root Type for RestMappingRequest","description":"Definition for meta data information to create scope.\nProperty 'createSchema' should be 'true' if you want to create schema with schemaName.","required":["apiName","schemaName","nsfPath"],"type":"object","properties":{"description":{"description":"Human readable explanation","type":"string"},"apiName":{"description":"Name that is used in ?datSsource= parameter to access mapped resource","type":"string"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources","type":"string"},"nsfPath":{"description":"path relative to Domino data directory to nsf database","type":"string"},"isActive":{"description":"Allows to enable/disable API access without removing cofiguration","type":"boolean"},"createSchema":{"description":"Default to be false if you don't set this property. It won't create the schema. When set to be true, it will create schema using given schemaName. ","type":"boolean","example":"false"},"icon":{"description":"Base64 of an icon. SVG preferred","type":"string"},"iconName":{"description":"alt text for icon","type":"string"},"server":{"description":"Domino server name that this scope is enabled on. Empty or '*' mean that this scope is enabled on all Domino servers. ","type":"string"},"maximumAccessLevel":{"description":"Limits, but not extends the access level granted to an API user.\nMirrors the MaximumInternetAccess in DB ACLs.\nDefault if not provided is Editor","enum":["NoAccess","Depositor","Author","Editor","Designer","Manager","Reader"],"type":"string"}},"additionalProperties":false,"example":{"description":"The famous demo database","apiName":"demoapi","schemaName":"demoapi","nsfPath":"Demo.nsf","isActive":true,"icon":"Base64 stuff, preferably SVG","iconName":"beach","createSchema":false,"server":"*"}},"KeepAccessSchema":{"title":"Root Type for KeepAccessSchema","description":"Short description of a schema stored in the resources of a NSF database","required":["name"],"type":"object","properties":{"name":{"description":"Unique name inside the database","type":"string","example":"\"default\""},"description":{"description":"Human readable description of a schema","type":"string","example":"Default access to database assets"},"iconName":{"description":"Name of the assigned svg icon from the list of available icons","type":"string","example":"\"sell\""}},"example":{"name":"default","description":"Standard access to a database","iconName":"archeology"}},"KeepMissingConfigurations":{"description":"Definition for Keep's Missing configuration details when /purge is called","type":"object","properties":{"nsfName":{"description":"Indicates the nsf path of a configuration in the KeepConfig.nsf that has error on load","type":"string","example":"Demo.nsf"},"scope":{"description":"The apiName in the KeepConfig.nsf.","type":"string","example":"shinyscope"},"schema":{"description":"The schemaName in the KeepConfig.nsf.","type":"string","example":"shinyschema"},"server":{"description":"The server in the KeepConfig.nsf.","type":"string","example":"frascati"},"unid":{"description":"Universal Id of the document, uniquely identifies a document across all replicas of a database","type":"string","readOnly":true,"example":"360A6B7035CD03C248258816000DDB47"},"action":{"description":"Determine what the Action will be to be used for the POST /purge endpoint","type":"string","readOnly":true,"example":"removeScope"}},"example":{"nsfName":"Demo.nsf","scope":"shinyscope","schema":"schemagone","action":"removeScope","server":"","unid":"360A6B7035CD03C248258816000DDB47"}},"UpdateCreateDesignResponse":{"description":"KEEP formatted response for UpdateCreateDesign","required":["success","type","name","log"],"type":"object","properties":{"success":{"description":"States whether the design is created or not.","type":"boolean"},"type":{"description":"Type of design created.","enum":["view","form"],"type":"string"},"name":{"description":"Name of design created.","type":"string"},"log":{"description":"Log of design importer","type":"string"}},"example":{"success":true,"type":"form","name":"Customers","log":"\n\n"}},"DeletePurge":{"title":"Root Type for DeletePurge","description":"Collection of objects for delete of documents in /admin/purge under schemaScopeCombinations property ","required":["schemaScopeCombinations"],"type":"object","properties":{"schemaScopeCombinations":{"description":"JSON source for new schema-scope combinations to be purged","type":"array","items":{"$ref":"#/components/schemas/DeletePurgeBody"}}},"additionalProperties":false,"example":{"schemaScopeCombinations":[{"nsfName":"demo.nsf","scope":"brokendemo","schema":"sampleschema","serverName":"","unid":"0E35D520A1EBBB5B48258435003E8284"},{"nsfName":"demo2.nsf","scope":"brokendemo2","schema":"sampleschema2","serverName":"","unid":"0E35D520A1EBBB5B4825843503431V32"}]}},"DeletePurgeBody":{"title":"Root Type for DeletePurge","description":"Collection of objects for delete of documents in /admin/purge","type":"object","properties":{"nsfName":{"description":"Indicates the nsf path of a configuration in the KeepConfig.nsf that has error on load","type":"string"},"scope":{"description":"Scope name of the mapping","type":"string"},"schema":{"description":"name (without .json extension) of schema file in nsf REST file resources","type":"string"},"serverName":{"description":"The server where the schema-scope is pointing to","type":"string"},"unid":{"description":"32 char universalId A-Z0-9, primary key unique across replicas","type":"string"}},"example":{"nsfName":"demo.nsf","scope":"brokendemo","schema":"sampleschema","serverName":"","unid":"0E35D520A1EBBB5B48258435003E8284"}}},"responses":{"400BadRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Invalid request. Shows up when submission is flaky:\n- Wrong authentication\n- Wrong content-type\n- Missing or wrong parameter types"},"401Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"Unauthorized":{"value":{"status":401,"message":"Invalid credentials or account locked"}}}}},"description":"401 Unauthorized"},"403Forbidden":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"Forbidden":{"value":{"message":"Nice try chap, ask before next time","status":403}}}}},"description":"Forbidden"},"404NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFound":{"value":{"message":"This is not the data you seek!","status":404}}}}},"description":"Content not found"},"405MethodNotAllowed":{"description":"Method not allowed"},"406NotAcceptable":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"GenericRejection":{"value":{"details":"The haferlup needs left turning shrufti","message":"This is not a supported operation. Try again","status":406}}}}},"description":"Invalid operation - something got requested that isn't supported"},"500InternalServerError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"GenericError":{"value":{"details":"Dreaded pirate NullPointer","message":"Sorry pal, we screwed up","status":500}}}}},"description":"The server screwed up"},"501NotImplemented":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NextVersion":{"value":{"details":"We do sprints, not marathons","message":"Not now, maybe tomorrow","status":501}}}}},"description":"Working on it, just not yet"}},"securitySchemes":{"jwt":{"scheme":"bearer","type":"http","description":"OICD access token or compliant JWT"}}},"tags":[{"name":"admin","description":"The endpoints allow to manage scopes (the Domino databases exposed), OAuth application registration and the general setup of Domino REST API. Accessing these endpoints requires a [KEEPAdmin] role for the user"},{"name":"schema","description":"Data definitions how the API returns and accepts data, creating independence from Domino design elements. Creating or altering a schema requires designer access to the respective database"},{"name":"design","description":"Domino design elements including internal Source Code"}],"x-keep-version":1}
\ No newline at end of file
+{"openapi":"3.0.2","info":{"title":"HCL Domino REST API setup","version":"1.1.2","description":"REST APIs for Domino and more done right.\nWith declarative security and access to Code, Design and data\nAdministrative Portion","contact":{"name":"HCL America Inc","url":"https://opensource.hcltechsw.com/Domino-rest-api/","email":"HeyHCL@pnp-hcl.com"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"servers":[{"url":"/api/setup-v1","description":"KEEP enabled server"}],"paths":{"/dxl":{"summary":"Actions on DXL of a database.","description":"Get raw DXL of a given database, upload DXL to alter design elements, or removes DXL from cache. ","get":{"tags":["design"],"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"examples":{"nsfAtDataDir":{"value":"Demo.nsf"},"nsfInADirectoryOffDataDir":{"value":"testdir/Data.nsf"}},"name":"nsfPath","description":"Path relative to the notesdata directory of the nsf to access.","schema":{"type":"string"},"in":"query"}],"responses":{"200":{"content":{"text/xml":{"schema":{"type":"string"},"examples":{"dxlSimple":{"value":"\r\n \r\n \r\n \r\n 20190712T192246,44+08\r\n \r\n \r\n 20220407T151018,22+08\r\n \r\n \r\n 20220407T151018,21+08\r\n \r\n \r\n 20220407T151018,21+08\r\n \r\n \r\n 20190712T192246,45+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n SELECT @All\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n @DocNumber\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n @Created\r\n \r\n \r\n \r\n \r\n \r\n \r\n 20190712T194148,22+08\r\n \r\n \r\n 20220407T151018,03+08\r\n \r\n \r\n 20220407T151018,02+08\r\n \r\n \r\n 20220407T151018,02+08\r\n \r\n \r\n 20190712T194148,22+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n .settings/org.eclipse.wst.validation.prefs\r\n
\r\n - \r\n ~C4g\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 39\r\n
\r\n - \r\n \r\nYQAYAAAAAAAnAAAAAQAAAAAAAAAAAAAAYAA5AAAAJwAoAAAAAAAAAAAAb3ZlcnJpZGU9dHJ1ZQpz\r\ndXNwZW5kPXRydWUKdmYudmVyc2lvbj0zAA==\r\n\r\n
\r\n - \r\n .settings/org.eclipse.wst.validation.prefs\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194153,51+08\r\n \r\n \r\n 20220407T151018,04+08\r\n \r\n \r\n 20220407T151018,03+08\r\n \r\n \r\n 20220407T151018,03+08\r\n \r\n \r\n 20190712T194153,51+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n w\r\n
\r\n - \r\n WEB-INF/xsp.properties\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 211\r\n
\r\n - \r\n \r\nYQAYAAAAAADTAAAAAQAAAAAAAAAAAAAAYADlAAAA0wDUAAAAAAAAAAAAeHNwLmFqYXgucmVuZGVy\r\nd2hvbGV0cmVlPWZhbHNlDQp4c3AuY2xpZW50LnNjcmlwdC5yYWRpb0NoZWNrYm94LmllLm9uY2hh\r\nbmdlLnRyaWdnZXI9ZWFybHktb25jbGljaw0KeHNwLmNzcmYucHJvdGVjdGlvbj10cnVlDQp4c3Au\r\ncGVyc2lzdGVuY2UubW9kZT1maWxlDQp4c3AucmVzb3VyY2VzLmFnZ3JlZ2F0ZT10cnVlDQp4c3Au\r\nZXJyb3IucGFnZS5kZWZhdWx0PXRydWUNCmU=\r\n\r\n
\r\n - \r\n WEB-INF/xsp.properties\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194241,92+08\r\n \r\n \r\n 20220407T151018,05+08\r\n \r\n \r\n 20220407T151018,04+08\r\n \r\n \r\n 20220407T151018,04+08\r\n \r\n \r\n 20190712T194241,92+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .classpath\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 329\r\n
\r\n - \r\n \r\nYQAYAAAAAABJAQAAAQAAAAAAAAAAAAAAYABbAQAASQFKAQAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGNsYXNzcGF0aD4KICA8Y2xhc3NwYXRoZW50cnkga2lu\r\nZD0ic3JjIiBwYXRoPSJMb2NhbCIvPgogIDxjbGFzc3BhdGhlbnRyeSBraW5kPSJjb24iIHBhdGg9\r\nIm9yZy5lY2xpcHNlLmpkdC5sYXVuY2hpbmcuSlJFX0NPTlRBSU5FUiIvPgogIDxjbGFzc3BhdGhl\r\nbnRyeSBraW5kPSJjb24iIHBhdGg9Im9yZy5lY2xpcHNlLnBkZS5jb3JlLnJlcXVpcmVkUGx1Z2lu\r\ncyIvPgogIDxjbGFzc3BhdGhlbnRyeSBraW5kPSJvdXRwdXQiIHBhdGg9IldlYkNvbnRlbnQvV0VC\r\nLUlORi9jbGFzc2VzIi8+CjwvY2xhc3NwYXRoPgoA\r\n\r\n
\r\n - \r\n .classpath\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194241,96+08\r\n \r\n \r\n 20220407T151018,06+08\r\n \r\n \r\n 20220407T151018,05+08\r\n \r\n \r\n 20220407T151018,05+08\r\n \r\n \r\n 20190712T194241,97+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.name\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 6\r\n
\r\n - \r\n \r\nYQAYAAAAAAAGAAAAAQAAAAAAAAAAAAAAYAAYAAAABgAGAAAAAAAAAAAAV2luZG93\r\n\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.name\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194241,99+08\r\n \r\n \r\n 20220407T151018,07+08\r\n \r\n \r\n 20220407T151018,06+08\r\n \r\n \r\n 20220407T151018,06+08\r\n \r\n \r\n 20190712T194242,02+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.container\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 49\r\n
\r\n - \r\n \r\nYQAYAAAAAAAxAAAAAQAAAAAAAAAAAAAAYABDAAAAMQAyAAAAAAAAAAAAb3JnLmVjbGlwc2Uud3N0\r\nLmpzZHQubGF1bmNoaW5nLmJhc2VCcm93c2VyTGlicmFyeQA=\r\n\r\n
\r\n - \r\n .settings/org.eclipse.wst.jsdt.ui.superType.container\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,06+08\r\n \r\n \r\n 20220407T151018,08+08\r\n \r\n \r\n 20220407T151018,07+08\r\n \r\n \r\n 20220407T151018,07+08\r\n \r\n \r\n 20190712T194242,07+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n .settings/.jsdtscope\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 339\r\n
\r\n - \r\n \r\nYQAYAAAAAABTAQAAAQAAAAAAAAAAAAAAYABlAQAAUwFUAQAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxjbGFzc3BhdGg+DQoJPGNsYXNzcGF0aGVudHJ5IGtp\r\nbmQ9InNyYyIgcGF0aD0iQ29kZS9TY3JpcHRMaWJyYXJpZXMiLz4NCgk8Y2xhc3NwYXRoZW50cnkg\r\na2luZD0iY29uIiBwYXRoPSJvcmcuZWNsaXBzZS53c3QuanNkdC5sYXVuY2hpbmcuSlJFX0NPTlRB\r\nSU5FUiIvPg0KCTxjbGFzc3BhdGhlbnRyeSBraW5kPSJjb24iIHBhdGg9Im9yZy5lY2xpcHNlLndz\r\ndC5qc2R0LmxhdW5jaGluZy5iYXNlQnJvd3NlckxpYnJhcnkiLz4NCgk8Y2xhc3NwYXRoZW50cnkg\r\na2luZD0ib3V0cHV0IiBwYXRoPSIiLz4NCjwvY2xhc3NwYXRoPg0KAA==\r\n\r\n
\r\n - \r\n .settings/.jsdtscope\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,24+08\r\n \r\n \r\n 20220407T151018,09+08\r\n \r\n \r\n 20220407T151018,08+08\r\n \r\n \r\n 20220407T151018,08+08\r\n \r\n \r\n 20190712T194242,25+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n w\r\n
\r\n - \r\n WEB-INF/faces-config.xml\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 234\r\n
\r\n - \r\n \r\nYQAYAAAAAADqAAAAAQAAAAAAAAAAAAAAYAD8AAAA6gDqAAAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGZhY2VzLWNvbmZpZz4KICA8IS0tQVVUT0dFTi1TVEFS\r\nVC1CVUlMREVSOiBBdXRvbWF0aWNhbGx5IGdlbmVyYXRlZCBieSBJQk0gRG9taW5vIERlc2lnbmVy\r\nLiBEbyBub3QgbW9kaWZ5Li0tPgogIDwhLS1BVVRPR0VOLUVORC1CVUlMREVSOiBFbmQgb2YgYXV0\r\nb21hdGljYWxseSBnZW5lcmF0ZWQgc2VjdGlvbi0tPgo8L2ZhY2VzLWNvbmZpZz4K\r\n\r\n
\r\n - \r\n WEB-INF/faces-config.xml\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,29+08\r\n \r\n \r\n 20220407T151018,10+08\r\n \r\n \r\n 20220407T151018,09+08\r\n \r\n \r\n 20220407T151018,09+08\r\n \r\n \r\n 20190712T194242,30+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4gP\r\n
\r\n - \r\n build.properties\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 84\r\n
\r\n - \r\n \r\nYQAYAAAAAABUAAAAAQAAAAAAAAAAAAAAYABmAAAAVABUAAAAAAAAAAAAc291cmNlLi4gPSBMb2Nh\r\nbC8sXA0KICAgICAgICAgICBDb2RlL0phdmEvDQpvdXRwdXQuLiA9IFdlYkNvbnRlbnQvV0VCLUlO\r\nRi9jbGFzc2VzLw0K\r\n\r\n
\r\n - \r\n build.properties\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194242,43+08\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n 20220407T151018,10+08\r\n \r\n \r\n 20220407T151018,10+08\r\n \r\n \r\n 20190712T194242,44+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4gP\r\n
\r\n - \r\n plugin.xml\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 1189\r\n
\r\n - \r\n \r\nYQAYAAAAAAClBAAAAQAAAAAAAAAAAAAAYAC3BAAApQSmBAAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHBsdWdpbiBjbGFzcz0icGx1Z2luLkFjdGl2YXRvciIK\r\nICBpZD0iTFAyMmRBUDJkNTE3MjM1NTFfMmZIQ0xQTlBfRGVtb19uc2YiIG5hbWU9IkRvbWlubyBE\r\nZXNpZ25lciIKICBwcm92aWRlcj0iVE9ETyIgdmVyc2lvbj0iMS4wLjAiPgogIDxyZXF1aXJlcz4K\r\nICAgIDwhLS1BVVRPR0VOLVNUQVJULUJVSUxERVI6IEF1dG9tYXRpY2FsbHkgZ2VuZXJhdGVkIGJ5\r\nIG51bGwuIERvIG5vdCBtb2RpZnkuLS0+CiAgICA8aW1wb3J0IHBsdWdpbj0ib3JnLmVjbGlwc2Uu\r\ndWkiLz4KICAgIDxpbXBvcnQgcGx1Z2luPSJvcmcuZWNsaXBzZS5jb3JlLnJ1bnRpbWUiLz4KICAg\r\nIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0iY29tLmlibS5jb21tb25zIi8+CiAgICA8\r\naW1wb3J0IG9wdGlvbmFsPSJ0cnVlIiBwbHVnaW49ImNvbS5pYm0uY29tbW9ucy54bWwiLz4KICAg\r\nIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0iY29tLmlibS5jb21tb25zLnZmcyIvPgog\r\nICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJjb20uaWJtLmpzY3JpcHQiLz4KICAg\r\nIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0iY29tLmlibS5kZXNpZ25lci5ydW50aW1l\r\nLmRpcmVjdG9yeSIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJjb20uaWJt\r\nLmRlc2lnbmVyLnJ1bnRpbWUiLz4KICAgIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdpbj0i\r\nY29tLmlibS54c3AuY29yZSIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJj\r\nb20uaWJtLnhzcC5leHRzbiIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2luPSJj\r\nb20uaWJtLnhzcC5kZXNpZ25lciIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIgcGx1Z2lu\r\nPSJjb20uaWJtLnhzcC5kb21pbm8iLz4KICAgIDxpbXBvcnQgb3B0aW9uYWw9InRydWUiIHBsdWdp\r\nbj0iY29tLmlibS5ub3Rlcy5qYXZhLmFwaSIvPgogICAgPGltcG9ydCBvcHRpb25hbD0idHJ1ZSIg\r\ncGx1Z2luPSJjb20uaWJtLnhzcC5yY3AiLz4KICAgIDwhLS1BVVRPR0VOLUVORC1CVUlMREVSOiBF\r\nbmQgb2YgYXV0b21hdGljYWxseSBnZW5lcmF0ZWQgc2VjdGlvbi0tPgogIDwvcmVxdWlyZXM+Cjwv\r\ncGx1Z2luPgo8P2VjbGlwc2UgdmVyc2lvbj0iMy4wIj8+CmU=\r\n\r\n
\r\n - \r\n plugin.xml\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194247,03+08\r\n \r\n \r\n 20220407T151018,12+08\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n 20190712T194247,03+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n .project\r\n
\r\n - \r\n ~C4gP\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 1771\r\n
\r\n - \r\n \r\nYQAYAAAAAADrBgAAAQAAAAAAAAAAAAAAYAD9BgAA6wbsBgAAAAAAAAAAPD94bWwgdmVyc2lvbj0i\r\nMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHByb2plY3REZXNjcmlwdGlvbj4KICA8bmFtZT5EZW1v\r\nLm5zZjwvbmFtZT4KICA8Y29tbWVudC8+CiAgPHByb2plY3RzLz4KICA8YnVpbGRTcGVjPgogICAg\r\nPGJ1aWxkQ29tbWFuZD4KICAgICAgPG5hbWU+Y29tLmlibS5kZXNpZ25lci5kb21pbm8uamF2YWxp\r\nYi5qYXZhbGlibWFya2VyYnVpbGRlcjwvbmFtZT4KICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1\r\naWxkQ29tbWFuZD4KICAgIDxidWlsZENvbW1hbmQ+CiAgICAgIDxuYW1lPmNvbS5pYm0uZGVzaWdu\r\nZXIuZG9taW5vLmRlc2lnbi5qc3ZhbGlkYXRpb25idWlsZGVyPC9uYW1lPgogICAgICA8YXJndW1l\r\nbnRzLz4KICAgIDwvYnVpbGRDb21tYW5kPgogICAgPGJ1aWxkQ29tbWFuZD4KICAgICAgPG5hbWU+\r\nY29tLmlibS5kZXNpZ25lci5kb21pbm8uaWRlLnJlc291cmNlcy5mYWNlc0NvbmZpZ2J1aWxkZXI8\r\nL25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8YnVpbGRD\r\nb21tYW5kPgogICAgICA8bmFtZT5jb20uaWJtLmRlc2lnbmVyLmRvbWluby5pZGUucmVzb3VyY2Vz\r\nLkJ1aWxkUHJvcGVydGllc0J1aWxkZXI8L25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9i\r\ndWlsZENvbW1hbmQ+CiAgICA8YnVpbGRDb21tYW5kPgogICAgICA8bmFtZT5jb20uaWJtLmRlc2ln\r\nbmVyLmRvbWluby5pZGUucmVzb3VyY2VzLnBsdWdpblhNTGJ1aWxkZXI8L25hbWU+CiAgICAgIDxh\r\ncmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8YnVpbGRDb21tYW5kPgogICAgICA8\r\nbmFtZT5jb20uaWJtLmRlc2lnbmVyLmRvbWluby54c3AuZWRpdG9yLnhwYWdlc2J1aWxkZXI8L25h\r\nbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8YnVpbGRDb21t\r\nYW5kPgogICAgICA8bmFtZT5vcmcuZWNsaXBzZS5qZHQuY29yZS5qYXZhYnVpbGRlcjwvbmFtZT4K\r\nICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1aWxkQ29tbWFuZD4KICAgIDxidWlsZENvbW1hbmQ+\r\nCiAgICAgIDxuYW1lPmNvbS5pYm0uZGVzaWduZXIuZG9taW5vLmlkZS5yZXNvdXJjZXMuTFdQREJ1\r\naWxkZXI8L25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8\r\nYnVpbGRDb21tYW5kPgogICAgICA8bmFtZT5jb20uaWJtLmRlc2lnbmVyLmRvbWluby5sc2NyaXB0\r\nLkxTQnVpbGRlcjwvbmFtZT4KICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1aWxkQ29tbWFuZD4K\r\nICAgIDxidWlsZENvbW1hbmQ+CiAgICAgIDxuYW1lPm9yZy5lY2xpcHNlLnBkZS5NYW5pZmVzdEJ1\r\naWxkZXI8L25hbWU+CiAgICAgIDxhcmd1bWVudHMvPgogICAgPC9idWlsZENvbW1hbmQ+CiAgICA8\r\nYnVpbGRDb21tYW5kPgogICAgICA8bmFtZT5vcmcuZWNsaXBzZS5wZGUuU2NoZW1hQnVpbGRlcjwv\r\nbmFtZT4KICAgICAgPGFyZ3VtZW50cy8+CiAgICA8L2J1aWxkQ29tbWFuZD4KICA8L2J1aWxkU3Bl\r\nYz4KICA8bmF0dXJlcz4KICAgIDxuYXR1cmU+Y29tLmlibS53b3JrcGxhY2Uubm90ZXMuZmlsZXN5\r\nc3RlbS5ERE5hdHVyZTwvbmF0dXJlPgogICAgPG5hdHVyZT5vcmcuZWNsaXBzZS5qZHQuY29yZS5q\r\nYXZhbmF0dXJlPC9uYXR1cmU+CiAgICA8bmF0dXJlPm9yZy5lY2xpcHNlLnBkZS5QbHVnaW5OYXR1\r\ncmU8L25hdHVyZT4KICAgIDxuYXR1cmU+b3JnLmVjbGlwc2Uud3N0LmpzZHQuY29yZS5qc05hdHVy\r\nZTwvbmF0dXJlPgogIDwvbmF0dXJlcz4KPC9wcm9qZWN0RGVzY3JpcHRpb24+CgA=\r\n\r\n
\r\n - \r\n .project\r\n
\r\n \r\n \r\n \r\n \r\n 20190712T194248,10+08\r\n \r\n \r\n 20220407T151048,02+08\r\n \r\n \r\n 20220407T151048,01+08\r\n \r\n \r\n 20220407T151048,01+08\r\n \r\n \r\n 20190712T194248,09+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n w\r\n
\r\n - \r\n WEB-INF/classes/plugin/Activator.class\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 1069\r\n
\r\n - \r\n \r\nYQAYAAAAAAAtBAAAAQAAAAAAAAAAAAAAYAA/BAAALQQuBAAAAAAAAAAAyv66vgAAADQAKwcAAgEA\r\nEHBsdWdpbi9BY3RpdmF0b3IHAAQBACZvcmcvZWNsaXBzZS91aS9wbHVnaW4vQWJzdHJhY3RVSVBs\r\ndWdpbgEABnBsdWdpbgEAEkxwbHVnaW4vQWN0aXZhdG9yOwEABjxpbml0PgEAAygpVgEABENvZGUK\r\nAAMACwwABwAICQABAA0MAAUABgEAD0xpbmVOdW1iZXJUYWJsZQEAEkxvY2FsVmFyaWFibGVUYWJs\r\nZQEABHRoaXMBAAVzdGFydAEAJShMb3JnL29zZ2kvZnJhbWV3b3JrL0J1bmRsZUNvbnRleHQ7KVYB\r\nAApFeGNlcHRpb25zBwAVAQATamF2YS9sYW5nL0V4Y2VwdGlvbgoAAwAXDAARABIBAAdjb250ZXh0\r\nAQAiTG9yZy9vc2dpL2ZyYW1ld29yay9CdW5kbGVDb250ZXh0OwEABHN0b3AKAAMAHAwAGgASAQAK\r\nZ2V0RGVmYXVsdAEAFCgpTHBsdWdpbi9BY3RpdmF0b3I7AQASZ2V0SW1hZ2VEZXNjcmlwdG9yAQBA\r\nKExqYXZhL2xhbmcvU3RyaW5nOylMb3JnL2VjbGlwc2UvamZhY2UvcmVzb3VyY2UvSW1hZ2VEZXNj\r\ncmlwdG9yOwgAIgEACERlbW8ubnNmCgADACQMACUAJgEAGWltYWdlRGVzY3JpcHRvckZyb21QbHVn\r\naW4BAFIoTGphdmEvbGFuZy9TdHJpbmc7TGphdmEvbGFuZy9TdHJpbmc7KUxvcmcvZWNsaXBzZS9q\r\nZmFjZS9yZXNvdXJjZS9JbWFnZURlc2NyaXB0b3I7AQAEcGF0aAEAEkxqYXZhL2xhbmcvU3RyaW5n\r\nOwEAClNvdXJjZUZpbGUBAA5BY3RpdmF0b3IuamF2YQAhAAEAAwAAAAEACgAFAAYAAAAFAAEABwAI\r\nAAEACQAAADsAAQABAAAACSq3AAoqswAMsQAAAAIADgAAAA4AAwAAABgABAAZAAgAGgAPAAAADAAB\r\nAAAACQAQAAYAAAABABEAEgACABMAAAAEAAEAFAAJAAAAPgACAAIAAAAGKiu3ABaxAAAAAgAOAAAA\r\nCgACAAAAIAAFACEADwAAABYAAgAAAAYAEAAGAAAAAAAGABgAGQABAAEAGgASAAIAEwAAAAQAAQAU\r\nAAkAAABGAAIAAgAAAAoqK7cAGwGzAAyxAAAAAgAOAAAADgADAAAAJwAFACgACQApAA8AAAAWAAIA\r\nAAAKABAABgAAAAAACgAYABkAAQAJAB0AHgABAAkAAAAkAAEAAAAAAASyAAywAAAAAgAOAAAABgAB\r\nAAAALwAPAAAAAgAAAAkAHwAgAAEACQAAADEAAgABAAAABxIhKrgAI7AAAAACAA4AAAAGAAEAAAA6\r\nAA8AAAAMAAEAAAAHACcAKAAAAAEAKQAAAAIAKlA=\r\n\r\n
\r\n - \r\n WEB-INF/classes/plugin/Activator.class\r\n
\r\n \r\n \r\n \r\n \r\n \r\n 20190712T200521,54+08\r\n \r\n \r\n 20220407T151018,14+08\r\n \r\n \r\n 20220407T151018,13+08\r\n \r\n \r\n 20220407T151018,13+08\r\n \r\n \r\n 20190712T200521,57+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n - \r\n ~C4g\r\n
\r\n - \r\n AppProperties/xspdesign.properties\r\n
\r\n - \r\n 8.5.3\r\n
\r\n - \r\n 31\r\n
\r\n - \r\n \r\nYQAYAAAAAAAfAAAAAQAAAAAAAAAAAAAAYAAxAAAAHwAgAAAAAAAAAAAAI0ZyaSBKdWwgMTIgMjA6\r\nMTA6NDcgU0dUIDIwMTkNCgo=\r\n\r\n
\r\n - \r\n xspdesign.properties\r\n
\r\n \r\n \r\n \r\n \r\n \r\n 20190712T210038,90+08\r\n \r\n \r\n 20220407T151018,23+08\r\n \r\n \r\n 20220407T151018,22+08\r\n \r\n \r\n 20220407T151018,22+08\r\n \r\n \r\n 20190712T210038,94+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n 20220407T151018,11+08\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n %REM\r\n\tAgent SalesforceProcessing\r\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\r\n\tDescription: Comments for Agent\r\n%END REM\r\nOption Public\r\nOption Declare\r\n\r\n\r\n\r\n \r\n \r\n Sub Initialize\r\n\tDim s As New NotesSession\r\n\tDim db As NotesDatabase\r\n\tDim dcol As NotesDocumentCollection\r\n\tDim doc As NotesDocument\r\n\tDim nextDoc As NotesDocument\r\n\tSet db = s.Currentdatabase\r\n\tSet dcol = db.Unprocesseddocuments\r\n\tSet doc = dcol.Getfirstdocument()\r\n\tWhile Not doc Is Nothing\r\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\r\n\t\tCall handleOneDoc(doc)\r\n\t\tCall s.Updateprocesseddoc(doc)\r\n\t\tSet doc = nextDoc\r\n\tWend\r\nEnd Sub\r\n\r\n\r\n\r\n\r\n \r\n \r\n %REM\r\n\tSub handleOneDoc\r\n\tDescription: Creates a RichTextItem for all Fields\r\n%END REM\r\nSub handleOneDoc(doc As NotesDocument)\r\n\tDim rt As NotesRichTextItem\r\n\tDim item As NotesItem\r\n\tSet rt = doc.Createrichtextitem(\"Body\")\r\n\tForall i In doc.Items\r\n\t\tSet item = i\r\n\t\tIf item.name <> \"Body\" Then\r\n\t\t\trt.Appendtext(item.Name)\r\n\t\t\trt.Appendtext(\": \")\r\n\t\t\trt.Appendtext(item.Text)\r\n\t\t\trt.Addnewline(1)\r\n\t\tEnd If\r\n\tEnd Forall\t\r\n\r\n\tCall doc.save(True,True)\r\nEnd Sub\r\n \r\n \r\n \r\n \r\n \r\n 20190712T213039,48+08\r\n \r\n \r\n 20220407T151018,24+08\r\n \r\n \r\n 20220407T151018,23+08\r\n \r\n \r\n 20220407T151018,23+08\r\n \r\n \r\n 20190712T213039,53+08\r\n \r\n \r\n \r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n 20220407T151018,14+08\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n %REM\r\n\tAgent SalesforceProcessing\r\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\r\n\tDescription: Comments for Agent\r\n%END REM\r\nOption Public\r\nOption Declare\r\n\r\n\r\n\r\n \r\n \r\n Sub Initialize\r\n\tDim s As New NotesSession\r\n\tDim db As NotesDatabase\r\n\tDim dcol As NotesDocumentCollection\r\n\tDim doc As NotesDocument\r\n\tDim nextDoc As NotesDocument\r\n\tSet db = s.Currentdatabase\r\n\tSet dcol = db.Unprocesseddocuments\r\n\tSet doc = dcol.Getfirstdocument()\r\n\tWhile Not doc Is Nothing\r\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\r\n\t\tCall handleOneDoc(doc)\r\n\t\tCall s.Updateprocesseddoc(doc)\r\n\t\tSet doc = nextDoc\r\n\tWend\r\nEnd Sub\r\n\r\n\r\n\r\n\r\n \r\n \r\n %REM\r\n\tSub handleOneDoc\r\n\tDescription: Creates a RichTextItem for all Fields\r\n%END REM\r\nSub handleOneDoc(doc As NotesDocument)\r\n\tDim rt As NotesRichTextItem\r\n\tDim item As NotesItem\r\n\tSet rt = doc.Createrichtextitem(\"Body\")\r\n\tForall i In doc.Items\r\n\t\tSet item = i\r\n\t\tIf item.name <> \"Body\" Then\r\n\t\t\trt.Appendtext(item.Name)\r\n\t\t\trt.Appendtext(\": \")\r\n\t\t\trt.Appendtext(item.Text)\r\n\t\t\trt.Addnewline(1)\r\n\t\tEnd If\r\n\tEnd Forall\t\r\n\r\n\tCall doc.save(True,True)\r\nEnd Sub\r\n \r\n \r\n \r\n \r\n \r\n 20190910T180253,01+08\r\n \r\n \r\n 20220407T151018,25+08\r\n \r\n \r\n 20220407T151018,24+08\r\n \r\n \r\n 20220407T151018,24+08\r\n \r\n \r\n 20190910T180253,07+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=YING FENG/O=HCLPNP\r\n \r\n \r\n SELECT (Form = \"Customer\")\r\n \r\n \r\n \r\n \r\n \r\n \r\n @DocNumber\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n @Created\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 20220407T101537,01+08\r\n \r\n \r\n 20220408T102424,75+08\r\n \r\n \r\n 20220408T102424,74+08\r\n \r\n \r\n 20220408T102424,74+08\r\n \r\n \r\n 20220407T101537,00+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=John Doe/O=ProjectKeep\r\n \r\n \r\n SELECT Form = \"Entry\"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 20220407T101713,03+08\r\n \r\n \r\n 20220408T102538,75+08\r\n \r\n \r\n 20220408T102538,74+08\r\n \r\n \r\n 20220408T102538,74+08\r\n \r\n \r\n 20220407T101713,03+08\r\n \r\n \r\n \r\n CN=LP2-AP-51723551/O=HCLPNP\r\n CN=John Doe/O=ProjectKeep\r\n \r\n \r\n SELECT Form = \"SampleEntry\"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"}}}},"description":"Get full DXL"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getDxl","summary":"Get all DXL","description":"Raw DXL of a given database","x-keep-version":1},"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":true}]},"/admin/access":{"summary":"Provide information on access to Domino REST API DB configuration settings","description":"Provide information on access to Domino REAT API DB configuration settings","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepAccessShort"}}},"description":"Provide access info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getKeepAccess","summary":"Check if user has the right to update mappings","description":"Retrieve the information whether the user has right to update mappings.","x-keep-version":1,"x-keep-scope":"ANY"},"post":{"requestBody":{"description":"Details to be checked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepAccessQuery"}}},"required":true},"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeepAccessDetail"}}}},"description":"Access details"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"queryKeepAccess","summary":"Check for admin access permissions","description":"Check for access permission of operating mappings.","x-keep-version":1,"x-keep-scope":"ANY"}},"/admin/application/{client_id}":{"summary":"Endpoint for approving / rejecting an application request","description":"Endpoint for approving / rejecting an application request","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationResponse"}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getKeepApplication","summary":"Retrieve application configuration","description":"Retrieve application configuration","x-keep-version":1},"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationRequestUpdate"}}},"required":true},"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationResponse"}}},"description":"Successful update"},"400":{"$ref":"#/components/responses/400BadRequest"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"updateKeepApplication","summary":"Updates an application configuration","description":"Update an application does not new application secret","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"success":{"value":{"status":"OK","statusCode":200,"message":"deletion complete","details":{"appId":"1fe2cd-ac38-26c7d6"}}}}}},"description":"Successful deletion"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteKeepApplication","summary":"Delete an external application","description":"Delete an external application","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"Sample":{"value":"1fe2cd-ac38-26c7d6"}},"name":"client_id","description":"App ID","schema":{"type":"string"},"in":"path","required":true}]},"/admin/application":{"summary":"Creates an external application","description":"Creates an external application","post":{"requestBody":{"description":"client_name, client_uri, redirect_uris, scope are requested. Other properties will be generated by the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationRequest"},"examples":{"applicationSimpleRequest":{"value":{"client_name":"My App","description":"Super cool demo App","redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","contacts":["admin@projectcastle.io"],"status":"isActive"}}}}},"required":true},"tags":["admin"],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationResponse"},"examples":{"applicationResponseSimple":{"value":{"@unid":"B7EF2F8AC28AEDC44825882B000AD946","author":"CN=John Doe/O=Mauraders","client_name":"My App","description":"Super cool demo App","client_id":"abcdef-1234-567890","hasSecret":false,"redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","token_endpoint_auth_method":"client_secret_basic","contacts":["admin@projectcastle.io"],"status":"isActive"}}}}},"description":"Successful creation"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"createKeepApplication","summary":"Create an external application","description":"Create an external application","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/application/{client_id}/secret":{"summary":"Generates a new app secret for the application and changes status to active, if appropriate","description":"Generates a new app secret for the application and changes status to active, if appropriate","post":{"requestBody":{"description":"'status' must be provided. Sample value 'isActive', 'disabled'","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationSecretRequest"},"examples":{"CreateAppSecret":{"value":{"status":"isActive"}}}}},"required":true},"tags":["admin"],"parameters":[{"examples":{"ForceOverwrite":{"value":"true"},"KeepExsisting":{"value":"false"}},"name":"force","description":"when set to true, an existing secret will get overwritten.\nNo effect if no secret exists","schema":{"type":"boolean"},"in":"query"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApplicationSecretResponse"},"examples":{"AppSecretResponse":{"value":{"client_id":"9c5fed-38c4-441808","client_secret":"7e368d-6b3b-54eda8"}}}}},"description":"Successful created."},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"generateKeepApplicationSecret","summary":"Generates a new client_secret","description":"The client_secret is used as app password in the oauth Dance","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"StatusMessageDeleteSecret":{"value":{"statusText":"OK","status":200,"message":"App Secret removed for 429022-562b-641620"}}}}},"description":"Successfull deletion"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteKeepApplicationSecret","summary":"Remove an application secret","description":"Remove an application secret","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"Sample":{"value":"1fe2cd-ac38-26c7d6"}},"name":"client_id","description":"App ID","schema":{"type":"string"},"in":"path","required":true}]},"/admin/applications":{"summary":"Gets all external applications created by current user.","description":"Used to show the AdminUI","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApplicationResponse"}},"examples":{"Sample":{"value":[{"@unid":"B7EF2F8AC28AEDC44825882B000AD946","author":"CN=John Doe/O=Mauraders","client_id":"9c5fed-38c4-441808","client_name":"My App","hasSecret":false,"client_uri":"https://www.projectcastle.io/coolapp","contacts":["admin@projectcastle.io","CN=John Doe/O=Mauraders"],"description":"Super cool demo App","logo_uri":"https://www.projectcastle.io/castle.jpg","redirect_uris":["https://www.projectcastle.io/oauth","http://localhost/callback","https://domino.projectcastle.io/identity"],"scope":"demo $DECRYPT","status":"isActive","token_endpoint_auth_method":"client_secret_basic"},{"@unid":"ED192F6438FDE92B4825882B000D33CE","author":"CN=John Doe/O=Mauraders","client_id":"1814ef-0ea9-fa81cc","client_name":"My App1","hasSecret":false,"client_uri":"https://www.projectcastle.io/coolapp","contacts":["admin@projectcastle.io","CN=John Doe/O=Mauraders"],"description":"Super cool demo App","logo_uri":"https://www.projectcastle.io/castle.jpg","redirect_uris":["https://www.projectcastle.io/oauth","http://localhost/callback","https://domino.projectcastle.io/identity"],"scope":"demo $DECRYPT","status":"isActive","token_endpoint_auth_method":"client_secret_basic"}]}}}},"description":"Successful retrieval"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchAllApplications","summary":"Get my applications","description":"Get my applications","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/applications/all":{"summary":"DEPRECATED use /admin/applications","description":"DEPRECATED use /admin/applications","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApplicationResponse"}}}},"description":"Successful retrieval"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"deprecated":true,"security":[{"jwt":[]}],"operationId":"fetchAllApplicationsDeprecates","summary":"Get applications","description":"Get applications","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/backup":{"summary":"Backup / Restore of entire Domino REST API configuration","description":"Everything that is in KeepConfig, so it can be applied else where\nor reapplied after version change","get":{"tags":["admin"],"parameters":[{"examples":{"default":{"value":"attachment; filename=\"backup.json\""}},"name":"Content-Disposition","description":"","schema":{"type":"string"},"in":"header","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBackup"},"examples":{"adminBackupSample":{"value":{"version":{"keep-name":"HCL Domino REST API core API","keep-desc":"Next generation APIs for HCL Domino","image-build":"2022-10-14T03:03:04Z","keep-vendor":"HCL Labs","keep-version":"v1.0 (Build 1.9.0-SNAPSHOT-LocalBuild)"},"databases":{"demort":{"apiName":"demort","nsfPath":"Demo.nsf","iconName":"beach","icon":"Base64 stuff, preferably SVG","description":"test","formulaEngine":"domino","schemaName":"demort","requireRevisionToUpdate":false,"allowDecryption":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"allowCode":true,"openAccess":true,"unid":"6C726915B22B8439482588DA00042F96","forms":[{"formName":"fromSalesforce","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"views":[{"name":"Customers","alias":[],"unid":"86C72C1BF64B6DF04825847100373215"}],"agents":[],"formAliases":{},"isActive":true},"names":{"apiName":"names","nsfPath":"names.nsf","iconName":"mountain","schemaName":"names","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":false,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":false,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":false},"keepconfig":{"apiName":"keepconfig","nsfPath":"KeepConfig.nsf","iconName":"mountain","icon":"Base64 stuff, preferably SVG","description":"Primary directory of this Domain","schemaName":"keepconfig","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":true,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":true}},"apps":{"unknown":{"@unid":"0952193E783BF633C12588DB003AA430","author":"CN=chan clement/O=ProjectKeep","client_id":"7a2e3e-bfbc-eb6dfd","client_name":"Manager App","hasSecret":false,"client_uri":"http://test.local","contacts":["CN=chan clement/O=ProjectKeep"],"description":"Created by MANAGER","logo_uri":"cruise","redirect_uris":["http://test.local"],"scope":"managerscope","status":"isActive","token_endpoint_auth_method":"client_secret_basic"}}}}}}},"description":"Successful retrieval"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getKeepConfig","summary":"Retrieve Domino REST API configuration","description":"Retrieve Domino REST API configuration","x-keep-version":1,"x-keep-scope":"$SETUP","x-content-disposition":"attachment; filename=\"backup.json\""}},"/admin/cache":{"summary":"Access Domino REST API cache of design element summaries","description":"Get information about the Domino REST API Cache object and eventually clear it","delete":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"statusMessage":{"value":{"status":"OK","statusCode":200,"message":"cache reset"}}}}},"description":"Cache cleared"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteCache","summary":"Reset the Domino REST API cache","description":"Reset the Domino REST API cache","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/quickconfig":{"summary":"Quick config a nsf database to be available for Domino REST API access","description":"For a nsf database, this endpoint can be used to create a scope and config schema automatically. After configuration, user can access the database through provided scope name directly. No need to manually config schema any more. By default, all visible forms and views will be configured. All configured forms will contain all fields in original forms.","post":{"requestBody":{"description":"In the request body, the following attributes can be specified:\n\"nsfPath\" (required): a nsf database path,\n\"schemaName\" : schema name to be used for the schema name. By default, it is \"default\"\n\"scopeName\" : scope name used to access the database. If not specified, nsf database file name will be used\n\"create\" : If it is true and the nsf database does not exist, a empty database will be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickConfigParam"},"examples":{"QuickConfigSample":{"value":{"nsfPath":"some/path/to/database.nsf","schemaName":"somename","scopeName":"somescope","description":"some description","create":true,"iconName":"beach","isActive":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"allowCode":false,"openAccess":true,"requireRevisionToUpdate":false,"allowDecryption":false}}}}},"required":true},"tags":["admin"],"responses":{"200":{"content":{"application/json":{"examples":{"scopeSimple":{"value":{"@unid":"22D5E55E8FA1389A48258844006681A7","@noteid":4718,"@created":"2022-05-16T18:39:38Z","@lastmodified":"2022-05-17T08:51:54Z","@revision":"ac8ca0d967c9a40b0c9c07aecf87377d","@lastaccessed":"2022-05-17T08:51:54Z","@size":258,"@unread":true,"@etag":"W/\" 6283622a\"","Subject":"The famous demo database","apiName":"demo","schemaName":"demo","nsfPath":"Demo.nsf","isActive":true,"ISiteNameFull":"REST Database Site: demo (active)","ISiteOrg":"Domino REST access","Form":"KeepDatabase","Type":"KeepDatabase","$UpdatedBy":["CN=John Doe/O=Mauraders"],"$Revisions":["2022-05-17T02:39:38+08:00","2022-05-17T09:35:05+08:00"]}}}}},"description":"Config successfully"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"quickConfig","summary":"Create a scope and config schema","description":"Create a scope and config schema","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/scope":{"summary":"Connection of scope (public name) to a defined schema (a.k.a KeepDbConfig) in a NSF","description":"scope names are unique to a Domino server, while schema definitions are unique only to the nsf they reside in.\nThis endpoint allows to CRUD on the mappings between scope and schema","get":{"tags":["admin"],"parameters":[{"name":"scopeName","description":"Scope name of the mapping","schema":{"type":"string"},"in":"query","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMapping"}}},"description":"List of configs"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"getScopeMapping","summary":"Retrieves rest configuration from the server","description":"Maps a schema to a scope","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMappingRequest"},"examples":{"simpleScopeRequest":{"value":{"description":"The famous demo database","apiName":"demoapi","schemaName":"demoapi","nsfPath":"Demo.nsf","isActive":true,"icon":"Base64 stuff, preferably SVG","iconName":"beach","createSchema":false,"server":"*"}}}}},"required":true},"tags":["admin"],"parameters":[{"name":"createSchema","description":"If the database mentioned has no Schema of the given name, create an empty one.\nRequires designer access to the target database","schema":{"type":"boolean"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMapping"},"examples":{"scopeSimple":{"value":{"@meta":{"noteid":2342,"unid":"1E280A1798C5C313482588D9002671A2","created":"2022-10-12T14:59:54.58+08:00","lastmodified":"2022-10-12T15:13:36.56+08:00","lastaccessed":"2022-10-12T15:10:26.59+08:00","lastmodifiedinfile":"2022-10-12T15:13:36.57+08:00","addedtofile":"2022-10-12T14:59:54.7+08:00","noteclass":["DATA","DOCUMENT"],"unread":true,"revision":"000000060027B2B8482588D9"},"$UpdatedBy":["CN=John Doe/O=ProjectKeep"],"$Revisions":["2022-10-12T14:59:54.7+08:00","2022-10-12T15:09:02.71+08:00","2022-10-12T15:09:25.33+08:00","2022-10-12T15:09:45.99+08:00"],"apiName":"demoapi","createSchema":0,"description":"The famous demo database","isActive":true,"nsfPath":"Demo.nsf","schemaName":"demoapi","Form":"KeepDatabase","Type":"KeepDatabase"}}}}},"description":"successful creation"}},"security":[{"jwt":[]}],"operationId":"createUpdateScopeMapping","summary":"Create a rest configuration","description":"Create a rest configuration","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["admin"],"parameters":[{"name":"scopeName","description":"API Name of the mapping","schema":{"type":"string"},"in":"query","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMapping"}}},"description":"Successful delete"}},"security":[{"jwt":[]}],"operationId":"deleteScopeMapping","summary":"Delete a rest mapping from the directory","description":"Delete a rest mapping from the directory","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/admin/scopes":{"summary":"Connection of scope (public name) to a defined schema (a.k.a KeepDbConfig) in a NSF","description":"scope names are unique to a Domino domain, while schema definitions are unique only to the nsf they reside in.\nThis endpoint allows to CRUD on the mappings between scope and schema. It will show active and inactive scopes and is for use of the admin. API consumerss rather use /scope instead of /admin/scope","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestMapping"}}}},"description":"List of configs"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"fetchScopeMappings","summary":"Get all of the rest mappings on the server,","description":"Return the list of scopes and their details.","x-keep-version":1,"x-keep-scope":"$SETUP"}},"/design":{"summary":"Retrieve JSON formatted design elements info about a database.","description":"- forms\n- views / folders\n- agents\n- libraries\n- itemdefinitions\n- pages\n- subforms\n- outlines\n- navigators\n- actions\n- columns\n- fields","get":{"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"DesignSample":{"value":{"forms":{"fromSalesforce":{"@hide":"","@conflictation":"createconflicts","@unid":"639C1AE5A68680C2482584350046F7C3","@alias":[],"@noteid":"196","@name":"fromSalesforce","Body":{"allowmultivalues":false,"kind":"","type":"text"}},"SampleForm":{"@hide":"","@conflictation":"createconflicts","@unid":"A0DC3840E8CC9615482584350041A8CF","@alias":[],"@noteid":"182","@name":"SampleForm","Shape":{"allowmultivalues":false,"kind":"editable","type":"text"},"Color":{"allowmultivalues":false,"kind":"editable","type":"text"},"Taste":{"allowmultivalues":false,"kind":"editable","type":"text"},"Name":{"allowmultivalues":true,"kind":"editable","type":"text"},"Age":{"allowmultivalues":true,"kind":"editable","type":"number"}}},"subforms":{},"pages":{},"views":{"Customers":{"@alias":[],"@unid":"86C72C1BF64B6DF04825847100373215","@selectionFormula":"SELECT (Form = \"Customer\")","@name":"Customers","@noteid":"1be","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}},"($All)":{"@alias":[],"@unid":"0E35D520A1EBBB5B48258435003E8284","@selectionFormula":"SELECT @All","@name":"($All)","@noteid":"11a","$0":{"title":"#","formula":"@DocNumber"},"Form":{"title":"Form","formula":""},"$2":{"title":"Created","formula":"@Created"}}},"folders":{},"navigators":{},"outlines":{},"agents":{"Fix Body":{"Options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub\r\n","Forward":"Declare Sub Initialize\nDeclare Sub handleOneDoc(doc As NotesDocument)\n\n","Declarations":"\n","Initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","@trigger":"manual","@noteid":"1aa","@validForKeep":false,"@documentset":"selected","@unid":"3F8E64B529DA6CF848258435004A37CC","@type":"lotusscript","@name":"Fix Body"},"SalesforceProcessing":{"Options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub\r\n","Forward":"Declare Sub Initialize\nDeclare Sub handleOneDoc(doc As NotesDocument)\n\n","Declarations":"\n","Initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","@trigger":"docupdate","@noteid":"19e","@validForKeep":true,"@documentset":"none","@unid":"56D541DC5BCAF1384825843500477872","@type":"lotusscript","@name":"SalesforceProcessing"}},"libraries":{},"actions":{},"columns":{},"fields":{},"apiName":"","nsfPath":"Demo.nsf","cacheTimestamp":1653544543527}}}}},"description":"Successful design retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchDesignAll","summary":"Return list of design elements for a database","description":"List design information in JSON format for all types of design elements in JSON format.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition","schema":{"type":"string"},"in":"query"}]},"/design/nsf":{"summary":"Create a database, based on a template if required","description":"Create a database, in the meanwhile configure it known to Domino REST API. \n\nDefault ACL values for the database:\n- -default-, Editor\n- Anonymous, No Access\n- LocalDomainAdmins, Manager\n- LocalDomainServers, Manager\n- , Manager\n- OtherDomainServers, No Access\n- , Manager","post":{"requestBody":{"description":"Just 'nsfPath' and 'title' are requested. 'templateName' is not required.\n'nsfPath' should be the path of the database you want to create. 'templateName' should be the path of the template being located. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignNSFSimple"},"examples":{"sampleDb":{"value":{"nsfPath":"sampleDb.nsf","templateName":"DAOSsnap.ntf","title":"SampleDb"}}}}},"required":true},"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignNSFSimple"},"examples":{"database":{"value":{"formulaEngine":"domino","icon":"Base64 stuff, preferably SVG","iconName":"KEEP","nsfPath":"demo.nsf","openAccess":true,"requireRevisionToUpdate":false,"agents":[],"allowCode":false,"dqlAccess":true,"formAliases":{},"forms":[],"description":"Blank Demo","schemaName":"demo","@unid":"3EBD0971F82CC4DD482588760017A48B"}}}}},"description":"success"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"createNSF","summary":"Create a database, based on a template if required","description":"Create a database, based on the nsfPath and title in the request body, if required you can also configure the template in request body. ","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"Demo":{"value":"demo"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":true}]},"/designlist/{designType}":{"get":{"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignElementSummaryResponse"},"examples":{"forms":{"value":[{"@name":"Person Form","@alias":["Person"],"@unid":"639C1AE5A68680C2482584350046F7C3"}]}}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchDesignTypeList","summary":"Retrieve summary of design elements for a database for a specific type","description":"List design summary information in JSON format for a subset of design elements.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"designType","schema":{"enum":["agents","forms","libraries","views","folders","pages","subforms","outlines","navigators","actions","columns","fields","itemdefinitions"],"type":"string"},"in":"path","required":true},{"name":"dataSource","description":"Scope name, required if nsfPath is not specified","schema":{"type":"string"},"in":"query","required":false},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition, required if dataSource is not specified","schema":{"type":"string"},"in":"query"}]},"/schema":{"summary":"DBConfig objects for one NSF","description":"Checks for JSON resources following the naming scheme. The json file should be stored in Resources->Files in the database. ","get":{"tags":["schema"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"},"examples":{"schemaSimple":{"value":{"description":"test","nsfPath":"Demo.nsf","schemaName":"testschema","icon":"Base64 stuff, preferably SVG","iconName":"beach","formulaEngine":"domino","isActive":true,"agents":[{"name":"SalesforceProcessing","alias":[],"unid":"56D541DC5BCAF1384825843500477872"}],"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"forms":[{"formName":"SampleForm","formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"dqlAccess":true,"allowCode":true,"openAccess":true,"requireRevisionToUpdate":false,"allowDecryption":true,"owners":[]}}}}},"description":"List of configs"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFoundSchema":{"value":{"status":404,"message":"Config not found: REST/demoodata.json","errorId":1037}}}}},"description":"No such schema"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"getSchema","summary":"Get a REST configuration (Schema) from the specified database","description":"Used to get a REST configuration (Schema) from the specified database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"},"examples":{"restconfigSimpleRequest":{"value":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"MarketingInfo","alias":["MarketingInfo"],"unid":"10EA9EC66EA748BC4825851100420810"},{"name":"ChineseCustomers","alias":["ChineseCustomers"],"unid":"3FE5CD63E179F21600258680006DB25B"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"},{"name":"Samples","alias":["Samples"],"unid":"5318911D496571410025860D00544B17"}],"agents":[],"forms":[{"formName":"Customer","formModes":[{"modeName":"default","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Pet","type":"string"},{"name":"color","type":"string"},{"name":"email","type":"string"},{"name":"employee_count","type":"integer"},{"name":"first_name","type":"string"},{"name":"last_name","type":"string"},{"name":"hobbies","type":"array","items":{"type":"string"}},{"name":"Owner","type":"string","format":"authors"},{"name":"Body","type":"object","format":"richtext"}],"required":["Form","email","first_name"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false},{"modeName":"dql","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Pet","type":"string"},{"name":"color","type":"string"},{"name":"email","type":"string"},{"name":"first_name","type":"string"},{"name":"last_name","type":"string"},{"name":"hobbies","type":"array","items":{"type":"string"}}],"required":["Form","email","first_name"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]},{"formName":"Marketing","formModes":[{"modeName":"default","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Assets","type":"string"},{"name":"Country","type":"string"},{"name":"FullName","type":"string"},{"name":"Industry","type":"string"},{"name":"Newsletter","type":"string"},{"name":"email","type":"string"},{"name":"gender","type":"string","writeOnly":true}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]},{"formName":"SampleForm","formModes":[{"modeName":"default","fields":[{"name":"Color","type":"string"},{"name":"Form","type":"string"},{"name":"Shape","type":"string"},{"name":"Taste","type":"string"}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false},{"modeName":"odata","fields":[{"name":"Color","type":"string"},{"name":"Form","type":"string"},{"name":"Shape","type":"string"},{"name":"Taste","type":"string"}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]},{"formName":"TestForm","formModes":[{"modeName":"default","fields":[{"name":"colour","type":"string","fieldAccess":"RO"},{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"name","type":"string"}],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"}}},"simpleRequestWithFieldGroup":{"value":{"schemaName":"demofieldGroup","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","formModes":[{"modeName":"default","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Pet","type":"string"},{"name":"Color","type":"string"},{"name":"Shape","type":"string"},{"name":"Taste","type":"string"},{"name":"Age","type":"array","items":{"type":"integer"},"fieldGroup":"person"},{"name":"Name","type":"array","items":{"type":"string"},"fieldGroup":"person"}],"required":["Form"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false},{"modeName":"dql","fields":[{"name":"Form","type":"string","fieldAccess":"RO"},{"name":"Color","type":"string"}],"required":["Form"],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"}}}}}},"required":true},"tags":["schema"],"parameters":[{"name":"prohibitRefresh","description":"default = true,\nWhen set, schema written to the database design are flagged so the\nDomino design task won't replace/delete the schema","schema":{"type":"boolean"},"in":"query"},{"name":"dryRun","description":"A flag whether indicating if creating or updating a schema will only be a dry run. This means that the request will only be simulated and no actual changes will take place in the database. This can be used to check for warnings when trying to create or update a schema. This flag is set to false by default.","schema":{"type":"boolean"},"in":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"},"examples":{"restconfigSimpleResponse":{"value":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]},{"modeName":"dql","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"6334EDA70A42ABB948258846002F115C"}},"simpleResponseWithFieldGroup":{"value":{"schemaName":"demofieldGroup","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Age","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","fieldGroup":"person","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]},{"modeName":"dql","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"E4D51C6C127FEECB002589390014CF5D"}},"responseWithWarning":{"value":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","owners":[],"openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"}],"agents":[],"forms":[{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Age","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Name","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]},{"modeName":"dql","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form"],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"6334EDA70A42ABB948258846002F115C","@warnings":["Location form does not exist in the database.","Sort\\by location view does not exist in the database."]}}}}},"description":"successful creation"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"Forbidden":{"value":{"status":403,"message":"You need Designer access for this operation","errorId":1033}}}}},"description":"Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"createUpdateSchema","summary":"Create or Update a REST configuration (Schema) in the specified database","description":"Used to create or update a REST configuration (Schema) in the specified database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"delete":{"tags":["schema"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMessage"},"examples":{"restconfigDeleteSimpleMessage":{"value":{"statusText":"OK","status":200,"message":"Deleted restcon from demo.nsf"}}}}},"description":"Successful delete"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"deleteSchema","summary":"Delete a REST configuration (Schema) from the specified database","description":"Used to delete a REST configuration (Schema) from the specified database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"nsfPath","description":"Path in internet style relative to the Domino data directory.\ne.g. \"demo.nsf\" or \"sales/england/crm_gb.nsf\"","schema":{"type":"string"},"in":"query","required":true},{"name":"configName","description":"Schema name you want to retrieve.","schema":{"type":"string"},"in":"query","required":true}]},"/schemas":{"summary":"KeepDbConfig objects for one NSF","description":"Checks for JSON resources following the naming scheme","get":{"tags":["schema"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestConfigShort"}},"examples":{"simpleRestconfigsResponse":{"value":[{"apiName":"restcon2","comment":"REST API configuration restcon2","prohibitRefresh":false},{"apiName":"restcon","comment":"REST API configuration restcon","prohibitRefresh":false}]}}}},"description":"List of Schemas."},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"fetchSchemas","summary":"Get a list of all REST configurations (Schemas) from a database","description":"Used to get all REST configurations (Schemas) from a database.","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"nsfPath","description":"Path in internet style relative to the Domino data directory.\ne.g. \"demo.nsf\" or \"sales/england/crm_gb.nsf\"","schema":{"type":"string"},"in":"query","required":true}]},"/design/{designType}":{"summary":"Get Design related information","description":"Retrieve design information for a subset of design elements","get":{"tags":["design"],"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"designType","description":"Type of design to query","schema":{"enum":["agents","forms","libraries","views","itemdefinitions","folders","pages","subforms","outlines","navigators","actions","columns","fields"],"type":"string"},"in":"path","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/DesignFormSimple"},{"$ref":"#/components/schemas/DesignSubFormSimple"},{"$ref":"#/components/schemas/DesignViewSimple"},{"$ref":"#/components/schemas/DesignAgentSimple"}]}},"examples":{"forms":{"value":[{"@hide":"","@conflictation":"createconflicts","@unid":"639C1AE5A68680C2482584350046F7C3","@alias":[],"@noteid":"196","@name":"fromSalesforce","Body":{"allowmultivalues":false,"kind":"","type":"text"}},{"@hide":"","@conflictation":"createconflicts","@unid":"A0DC3840E8CC9615482584350041A8CF","@alias":[],"@noteid":"182","@name":"SampleForm","Shape":{"allowmultivalues":false,"kind":"editable","type":"text"},"Color":{"allowmultivalues":false,"kind":"editable","type":"text"},"Taste":{"allowmultivalues":false,"kind":"editable","type":"text"},"Age":{"allowmultivalues":true,"kind":"editable","type":"number"},"Name":{"allowmultivalues":true,"kind":"editable","type":"text"}}]},"agents":{"value":[{"@documentset":"Defined by selection formula, check in Domino Designer","@name":"SalesforceProcessing","@noteid":"19e","@trigger":"docupdate","@type":"lotusscript","@unid":"56D541DC5BCAF1384825843500477872","@validForKeep":true,"":"\n \n fromSalesforce\n \n ","options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub"},{"@documentset":"Defined by selection formula, check in Domino Designer","@name":"FixBody","@noteid":"1aa","@trigger":"actionsmenu","@type":"lotusscript","@unid":"3F8E64B529DA6CF848258435004A37CC","@validForKeep":false,"":"\n \n fromSalesforce\n \n ","options":"%REM\n\tAgent SalesforceProcessing\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\n\tDescription: Comments for Agent\n%END REM\nOption Public\nOption Declare\n\n\n","initialize":"Sub Initialize\n\tDim s As New NotesSession\n\tDim db As NotesDatabase\n\tDim dcol As NotesDocumentCollection\n\tDim doc As NotesDocument\n\tDim nextDoc As NotesDocument\n\tSet db = s.Currentdatabase\n\tSet dcol = db.Unprocesseddocuments\n\tSet doc = dcol.Getfirstdocument()\n\tWhile Not doc Is Nothing\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\n\t\tCall handleOneDoc(doc)\n\t\tCall s.Updateprocesseddoc(doc)\n\t\tSet doc = nextDoc\n\tWend\nEnd Sub\n\n\n\n","handleOneDoc":"%REM\n\tSub handleOneDoc\n\tDescription: Creates a RichTextItem for all Fields\n%END REM\nSub handleOneDoc(doc As NotesDocument)\n\tDim rt As NotesRichTextItem\n\tDim item As NotesItem\n\tSet rt = doc.Createrichtextitem(\"Body\")\n\tForAll i In doc.Items\n\t\tSet item = i\n\t\tIf item.name <> \"Body\" Then\n\t\t\trt.Appendtext(item.Name)\n\t\t\trt.Appendtext(\": \")\n\t\t\trt.Appendtext(item.Text)\n\t\t\trt.Addnewline(1)\n\t\tEnd If\n\tEnd ForAll\t\n\n\tCall doc.save(True,True)\nEnd Sub"}]},"views":{"value":[{"@alias":[],"@unid":"86C72C1BF64B6DF04825847100373215","@selectionFormula":"SELECT (Form = \"Customer\")","@name":"Customers","@noteid":"1be","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}},{"@alias":[],"@unid":"0E35D520A1EBBB5B48258435003E8284","@selectionFormula":"SELECT @All","@name":"($All)","@noteid":"11a","$0":{"title":"#","formula":"@DocNumber"},"Form":{"title":"Form","formula":""},"$2":{"title":"Created","formula":"@Created"}}]},"subForms":{"value":[{"@alias":"subFormAlias","@conflictaction":"createconflicts","@hide":"","@name":"subFormSharedField","@noteid":"282","@unid":"CC96242D1260ED3B4825881E002A410B","Group":{"kind":"editable","type":"text","allowmultivalues":false},"Group_Leader":{"kind":"editable","type":"text","allowmultivalues":false}},{"@alias":"","@conflictaction":"createconflicts","@hide":"","@name":"subFormCommon","@noteid":"28e","@unid":"90FCDCE1F75415004825881E002A9A48","Company":{"kind":"editable","type":"text","allowmultivalues":false},"Company_Address":{"kind":"editable","type":"text","allowmultivalues":false}}]}}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFound":{"value":{"status":404,"message":"demo doesn't have the design element actions named SampleForm ","errorId":0}}}}},"description":"No such design"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"fetchDesignType","summary":"Retrieve list of design elements for a database for a specific type","description":"List design information in JSON format for a subset of design elements in JSON format.","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"description":"a simplified view or form description as JSON element","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepDatabase"}}},"required":true},"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCreateDesignResponse"}},"examples":{"Created views":{"value":[{"success":true,"type":"view","name":"Customers Categorized","log":"\n\n"},{"success":true,"type":"view","name":"Customers","log":"\n\n"}]},"Created forms":{"value":[{"success":true,"type":"form","name":"Contacts","log":"\n\n"},{"success":true,"type":"form","name":"Customers","log":"\n\n"}]}}}},"description":"Successful update of design element"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"updateDesignFromSchema","summary":"Uses a schema to create forms matching the default","description":"Shortcut for schema first development, forms only","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"name":"designType","description":"Type of design to query","schema":{"enum":["agents","forms","libraries","views","itemdefinitions","folders","pages","subforms","outlines","navigators","actions","columns","fields"],"type":"string"},"in":"path","required":true},{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition","schema":{"type":"string"},"in":"query","required":false}]},"/design/{designType}/{designName}":{"summary":"Get design information for a specific design element.","description":"Retrieve design information for a specific design element in json format.\n\nFor designType 'forms', the 'designName' you should give a value of the specfic name of the form you have configure. You can configure other designType likewise.","get":{"tags":["design"],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DesignFormSimple"},{"$ref":"#/components/schemas/DesignSubFormSimple"},{"$ref":"#/components/schemas/DesignViewSimple"},{"$ref":"#/components/schemas/DesignAgentSimple"}]},"examples":{"ViewSample":{"value":{"@alias":[],"@unid":"86C72C1BF64B6DF04825847100373215","@selectionFormula":"SELECT (Form = \"Customer\")","@name":"Customers","@noteid":"1be","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}}},"FormSample":{"value":{"@hide":"","@conflictation":"createconflicts","@alias":[],"@name":"SampleForm","Shape":{"allowmultivalues":false,"kind":"editable","type":"text"},"Color":{"allowmultivalues":false,"kind":"editable","type":"text"},"Taste":{"allowmultivalues":false,"kind":"editable","type":"text"},"Age":{"allowmultivalues":true,"kind":"editable","type":"number"},"Name":{"allowmultivalues":true,"kind":"editable","type":"text"}}},"AgentSample":{"value":"\r\n \r\n fromSalesforce\r\n \r\n %REM\r\n\tAgent SalesforceProcessing\r\n\tCreated Jul 12, 2019 by Stephan Wissel/Singapore/PNPHCL\r\n\tDescription: Comments for Agent\r\n%END REM\r\nOption Public\r\nOption Declare\r\n\r\n\r\nSub Initialize\r\n\tDim s As New NotesSession\r\n\tDim db As NotesDatabase\r\n\tDim dcol As NotesDocumentCollection\r\n\tDim doc As NotesDocument\r\n\tDim nextDoc As NotesDocument\r\n\tSet db = s.Currentdatabase\r\n\tSet dcol = db.Unprocesseddocuments\r\n\tSet doc = dcol.Getfirstdocument()\r\n\tWhile Not doc Is Nothing\r\n\t\tSet nextDoc = dcol.Getnextdocument(doc)\r\n\t\tCall handleOneDoc(doc)\r\n\t\tCall s.Updateprocesseddoc(doc)\r\n\t\tSet doc = nextDoc\r\n\tWend\r\nEnd Sub\r\n\r\n\r\n\r\n%REM\r\n\tSub handleOneDoc\r\n\tDescription: Creates a RichTextItem for all Fields\r\n%END REM\r\nSub handleOneDoc(doc As NotesDocument)\r\n\tDim rt As NotesRichTextItem\r\n\tDim item As NotesItem\r\n\tSet rt = doc.Createrichtextitem(\"Body\")\r\n\tForAll i In doc.Items\r\n\t\tSet item = i\r\n\t\tIf item.name <> \"Body\" Then\r\n\t\t\trt.Appendtext(item.Name)\r\n\t\t\trt.Appendtext(\": \")\r\n\t\t\trt.Appendtext(item.Text)\r\n\t\t\trt.Addnewline(1)\r\n\t\tEnd If\r\n\tEnd ForAll\t\r\n\r\n\tCall doc.save(True,True)\r\nEnd Sub"},"SubFormSample":{"value":{"@alias":"subFormAlias","@conflictaction":"createconflicts","@hide":"","@name":"subFormSharedField","@noteid":"282","@unid":"CC96242D1260ED3B4825881E002A410B","Group":{"kind":"editable","type":"text","allowmultivalues":false},"Group_Leader":{"kind":"editable","type":"text","allowmultivalues":false}}}}}},"description":"Successful retrieval"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFound":{"value":{"status":404,"message":"demo has no design element of type actions","errorId":0}}}}},"description":"No such design"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"operationId":"getDesign","summary":"Retrieve individual design element for a database","description":"Retrieve design information in JSON format for a specific design element in JSON format.","x-keep-version":1,"x-keep-scope":"$SETUP"},"put":{"requestBody":{"description":"a simplified view or form description as JSON element","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DesignFormSimpleRequest"},{"$ref":"#/components/schemas/DesignViewSimpleRequest"}]},"examples":{"formRequest":{"value":{"name":"NewEntry","alias":"","fields":[{"name":"name","type":"text","allowmultivalues":false},{"name":"email","type":"text","allowmultivalues":false},{"name":"newField","type":"text","allowmultivalues":true}]}},"viewRequest":{"value":{"name":"newentries","selectionFormula":"Form = \"NewEntry\"","columns":[{"name":"name","title":"name","separatemultiplevalues":false,"sort":"ascending","formula":"name"},{"name":"email","title":"email","separatemultiplevalues":false,"sort":"ascending","formula":"email"}]}}}}},"required":true},"tags":["design"],"parameters":[{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name, required if nsfPath is not specified","schema":{"type":"string"},"in":"query","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCreateDesignResponse"},"examples":{"Created view":{"value":{"success":true,"type":"view","name":"Customers","log":"\n\n"}},"Created form":{"value":{"success":true,"type":"form","name":"Contacts","log":"\n\n"}}}}},"description":"Successful update of design element"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"operationId":"updateCreateDesign","summary":"Updates a view, form, agent or library","description":"Updates or creates Domino design elements based on simplified JSON","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"sampleFormName":{"value":"SampleForm"}},"name":"designName","description":"Name of design element to retrieve","schema":{"type":"string"},"in":"path","required":true},{"examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"name":"dataSource","description":"Scope name, required if nsfPath is not specified","schema":{"type":"string"},"in":"query","required":false},{"name":"raw","description":"Boolean, when true design information is returned as JNX CDRecords in JSON format,\nwhen false the simplified Domino REST API format is returned","schema":{"type":"boolean"},"in":"query"},{"name":"designType","description":"Type of design element to query","schema":{"enum":["agents","forms","libraries","views","folders","pages","subforms","outlines","navigators","actions","columns","fields","itemdefinitions"],"type":"string"},"in":"path","required":true},{"name":"nsfPath","description":"Alternate access to the design of an NSF to facilitate creation of schema definition, required if dataSource is not specified","schema":{"type":"string"},"in":"query","required":false}]},"/admin/purge":{"summary":"Cleanup Keep's missing configurations","description":"When loading KEEP it tries to load all scope/schema combinations showing errors in the log when nsf or schema is missing. This endpoint will clean this up","get":{"tags":["admin"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeepMissingConfigurations"}}}},"description":"List of Scopes that are invalid (Missing schema or Missing NSFs on the data directory)"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"fetchMissingKeepConfigurations","summary":"Get scope-schema missing configurations","description":"Get scope-schema missing configurations","x-keep-version":1,"x-keep-scope":"$SETUP"},"post":{"requestBody":{"description":"Details to be checked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePurgeBody"},"examples":{"ValidPurges":{"value":{"schemaScopeCombinations":[{"nsfName":"Demo.nsf","scope":"brokendemo","schema":"sampleschema","server":"","unid":"0E35D520A1EBBB5B48258435003E8284"},{"nsfName":"Demo.nsf","scope":"brokendemo2","schema":"sampleschema","server":"","unid":"0E35D520A1EBBB5B48258435003E8285"}]}}}}},"required":true},"tags":["admin"],"parameters":[{"name":"deleteInvestigate","description":"If the action is investigate on GET /admin/purge, delete the scope as well.","schema":{"type":"boolean"},"in":"query","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestMapping"}}}},"description":"Config successfully"},"400":{"$ref":"#/components/responses/400BadRequest"}},"security":[{"jwt":[]}],"operationId":"deleteMissingKeepConfigurations","summary":"Delete scope-schema combinations","description":"Delete scope-schema combinations","x-keep-version":1,"x-keep-scope":"$SETUP"},"parameters":[{"examples":{"includeEmptyTrue":{"value":"true"}},"name":"includeEmpty","description":"To include empty or null value in the Scope Document's server field.","schema":{"type":"boolean"},"in":"query","required":false}]}},"components":{"schemas":{"DesignElementSummary":{"title":"Root Type for DesignElementSummary","description":"Summary information for a design element, including basic information for listings","type":"object","properties":{"@name":{"type":"string"},"@alias":{"type":"array","items":{"type":"string"}},"@unid":{"type":"string"},"@flags":{"type":"string"}},"example":{"@name":"Person Form","@alias":["Person"],"@unid":"12345678901234567890123456789012","@flags":"w1"}},"DesignElementSummaryResponse":{"title":"Root Type for DesignElementSummaryResponse","description":"Response object containing an array of design element summary information","type":"object","properties":{"forms":{"type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"agents":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"libraries":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"views":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"folders":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"pages":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"subforms":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"outlines":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"navigators":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"actions":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"columns":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}},"fields":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignElementSummary"}}},"example":{"forms":[{"@name":"Person Form","@alias":["Person"],"@flags":"w1","@unid":"5B157EFC7DD24693852587C70083C6DF"}]}},"AdminBackup":{"title":"Root Type for AdminBackup","description":"Definition of a Domino REST API configuration.","type":"object","properties":{"version":{"description":"Basic information about Domino REST API. ","type":"object"},"databases":{"description":"All database configuration, including keepconfig(KeepConfig.nsf) which has configuration settings for the Domino REST API. ","type":"object"},"apps":{"description":"Application configuration. ","type":"object"}},"example":{"version":{"keep-name":"HCL Domino REST API core API","keep-desc":"Next generation APIs for HCL Domino","image-build":"2022-10-14T03:03:04Z","keep-vendor":"HCL Labs","keep-version":"v1.0 (Build 1.9.0-SNAPSHOT-LocalBuild)"},"databases":{"demort":{"apiName":"demort","nsfPath":"Demo.nsf","iconName":"beach","icon":"Base64 stuff, preferably SVG","description":"test","formulaEngine":"domino","schemaName":"demort","requireRevisionToUpdate":false,"allowDecryption":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"allowCode":true,"openAccess":true,"unid":"6C726915B22B8439482588DA00042F96","forms":[{"formName":"fromSalesforce","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Body","type":"TYPE_STRING","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"readOnly":false,"writeOnly":false,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"views":[{"name":"Customers","alias":[],"unid":"86C72C1BF64B6DF04825847100373215"}],"agents":[],"formAliases":{},"isActive":true},"names":{"apiName":"names","nsfPath":"names.nsf","iconName":"mountain","schemaName":"names","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":false,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":false,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":false},"keepconfig":{"apiName":"keepconfig","nsfPath":"KeepConfig.nsf","iconName":"mountain","icon":"Base64 stuff, preferably SVG","description":"Primary directory of this Domain","schemaName":"keepconfig","requireRevisionToUpdate":false,"allowDecryption":false,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@False"},"allowCode":true,"openAccess":true,"forms":[],"views":[],"agents":[],"formAliases":{},"isActive":true}},"apps":{"unknown":{"@unid":"0952193E783BF633C12588DB003AA430","author":"CN=chan clement/O=ProjectKeep","client_id":"7a2e3e-bfbc-eb6dfd","client_name":"Manager App","hasSecret":false,"client_uri":"http://test.local","contacts":["CN=chan clement/O=ProjectKeep"],"description":"Created by MANAGER","logo_uri":"cruise","redirect_uris":["http://test.local"],"scope":"managerscope","status":"isActive","token_endpoint_auth_method":"client_secret_basic"}}}},"AdminCache":{"title":"Root Type for AdminCache","description":"Definition of a Domino REST API cache of design element summaries.","type":"object","properties":{"cached":{"description":"If the specified database has been cached, then return true. Otherwise false. ","type":"boolean"},"apiName":{"description":"How this database is known to the API.","type":"string"},"nsfPath":{"description":"Location on Domino server.","type":"string"},"formcount":{"format":"int32","description":"Form count exsit in the Domino REST API cache folder. ","type":"integer"},"viewcount":{"format":"int32","description":"View count exsit in the Domino REST API cache folder. ","type":"integer"},"agentcount":{"format":"int32","description":"Agent count exsit in the Domino REST API cache folder. ","type":"integer"},"librarycount":{"format":"int32","description":"Library count exsit in the Domino REST API cache folder. ","type":"integer"},"replicaid":{"description":"A 16-character combination of letters and numbers that represents the replica ID of a Notes database.","type":"string"},"title":{"description":"The title of the database.","type":"string"}},"example":{"cached":true,"apiName":"testdb","nsfPath":"Demo.nsf","formcount":8,"viewcount":5,"agentcount":2,"librarycount":0}},"AgentInfo":{"title":"Root Type for AgentInfo","description":"Definition of agent information","type":"object","properties":{"name":{"description":"Name of the agent, matches design","type":"string"},"alias":{"description":"Collection of alternate names, might match aliases of the Domino design","type":"array","items":{"type":"string"}},"unid":{"description":"Primary key to find the agent","type":"string"}},"example":{"name":"(CustomerUpdates)","alias":["KundenAbruf","ग्राहकों"],"unid":"ABCD12345"}},"DesignAgentSimple":{"title":"Root Type for DesignAgentSimple","description":"Definition design information for specific design element Agent.","type":"object","properties":{"@trigger":{"description":"Indicates when this agent runs.","type":"string","readOnly":true},"@documentset":{"description":"Represents a specified set of target documents that are manipulated by an agent.\n\nThe following types run an agent on:\n\nall - All the documents in the database.\n\nallinview - All documents in a view.\n\nmodified - All new and modified documents.\n\nrunonce - The current document once.\n\nselected - Only the selected documents.\n\nunreadinview - All unread documents in a view.\n\nnone","type":"string"},"@unid":{"description":"The Note UNID of the agent.","type":"string"},"@name":{"description":"The name of the agent.","type":"string"},"@validForKeep":{"description":"If this agent has been configured to use in Domino REST API. ","type":"boolean","readOnly":true},"@noteid":{"description":"The note ID of the agent, which is uniquely identifies a document within a particular database.","type":"string"},"@type":{"description":"Indicates the type of the agent (simple action, formula, LotusScript, imported Java, or Java).","type":"string"}},"example":{"@trigger":"MANUAL","@documentset":"SELECTED","@unid":"3F8E64B529DA6CF848258435004A37CC","@name":"Fix Body","@validForKeep":"","@noteid":"","@type":"LOTUSSCRIPT"}},"DesignColumnSimple":{"description":"This is one Datatype used to compose other schemas, DesignViewSimple and DesignViewSimpleRequest","required":["name","formula","separateMultipleValues"],"type":"object","properties":{"name":{"description":"","type":"string"},"title":{"description":"","type":"string"},"formula":{"description":"","type":"string"},"sort":{"description":"","enum":["ascending","descending","none"],"type":"string"},"separateMultipleValues":{"description":"","type":"boolean"}}},"DesignFieldSimple":{"description":"This is one Datatype used to compose other schemas, DesignFormSimple, DesignFormSimpleRequest and DesignSubFormSimple","required":["name","type"],"type":"object","properties":{"name":{"description":"","type":"string"},"type":{"description":"","enum":["text","number","richtext","datetime"],"type":"string"},"allowMultiValues":{"description":"","type":"boolean"}}},"DesignFormSimple":{"description":"Definition design information for specific design element Form.","required":["name","fields"],"type":"object","properties":{"@conflictaction":{"description":"Indicates how to handle form replication conflicts. ","type":"string","readOnly":true,"example":"createconflicts"},"@hide":{"type":"string","readOnly":true},"@name":{"description":"The name of the form.","type":"string","readOnly":true,"example":"TestForm"},"@noteid":{"description":"The note ID of a document, which is uniquely identifies a document within a particular database.","type":"string","readOnly":true,"example":"276"},"@unid":{"description":"Universal Id of the document, uniquely identifies a document across all replicas of a database","type":"string","readOnly":true,"example":"360A6B7035CD03C248258816000DDB47"},"@alias":{"description":"Alternate names or alias of the form.","type":"string","readOnly":true,"example":"TestForm"},"fields":{"description":"The fields on a forms. ","type":"array","items":{"$ref":"#/components/schemas/DesignFieldSimple"}}},"example":{"@alias":"TestForm","@conflictaction":"createconflicts","@hide":"web mobile","@name":"TestForm","@noteid":"276","@unid":"360A6B7035CD03C248258816000DDB47","first_name":{"kind":"editable","type":"text"},"last_name":{"kind":"editable","type":"text"},"email":{"kind":"editable","type":"text"},"gender":{"kind":"editable","type":"text"},"ip_address":{"kind":"editable","type":"text"},"Color":{"kind":"editable","type":"text"},"Pet":{"kind":"editable","type":"text"},"@created":{"kind":"editable","type":"datetime"},"$FILES":{"kind":"editable","type":"attachment"}}},"DesignFormSimpleRequest":{"title":"Root Type for DesignFormSimpleRequest","description":"Definition of request to create specific design element Form.","type":"object","properties":{"name":{"description":"The name of the form.","type":"string"},"alias":{"description":"Alternate names or alias of the form.","type":"string"},"fields":{"description":"The fields on a forms. ","type":"array","items":{"$ref":"#/components/schemas/DesignFieldSimple"}}},"example":{"name":"Entry","alias":"","fields":[{"name":"name","type":"text","allowmultivalues":false},{"name":"email","type":"text","allowmultivalues":false},{"name":"newField","type":"text","allowmultivalues":true}]}},"DesignNSFSimple":{"description":"Basic database object. NOTE: This is fit for limited current purpose, not complete for production","required":["title","nsfPath"],"type":"object","properties":{"title":{"description":"Datbase title","type":"string","example":"Our esteemed customers"},"templateName":{"description":"programmatic filename of the template, like 'demo.ntf'","type":"string","example":"DAOSsnap.ntf"},"nsfPath":{"description":"Path in internet style relative to the Domino data directory","type":"string","example":"crm/customers.nsf"}},"additionalProperties":false},"DesignSubFormSimple":{"title":"Root Type for DesignSubFormSimple","description":"Definition design information for specific design element Form.","type":"object","properties":{"@conflictaction":{"description":"Indicates how to handle form replication conflicts. ","type":"string","readOnly":true,"example":"createconflicts"},"@hide":{"type":"string","readOnly":true},"@name":{"description":"The name of the form.","type":"string","readOnly":true,"example":"subFormSharedField"},"@noteid":{"description":"The note ID of a document, which is uniquely identifies a document within a particular database.","type":"string","readOnly":true,"example":"276"},"@unid":{"description":"Universal Id of the document, uniquely identifies a document across all replicas of a database","type":"string","readOnly":true,"example":"360A6B7035CD03C248258816000DDB47"},"@alias":{"description":"Alternate names or alias of the form.","type":"string","readOnly":true,"example":"subFormAlias"},"fields":{"description":"The fields on a subform. ","type":"array","items":{"$ref":"#/components/schemas/DesignFieldSimple"}}},"example":{"@alias":"subFormAlias","@conflictaction":"createconflicts","@hide":"","@name":"subFormSharedField","@noteid":"282","@unid":"CC96242D1260ED3B4825881E002A410B","Group":{"kind":"editable","type":"text","allowmultivalues":false},"Group_Leader":{"kind":"editable","type":"text","allowmultivalues":false}}},"DesignViewSimple":{"description":"Definition design information for specific design element View.","required":["name","columns","selectionFormula"],"type":"object","properties":{"@name":{"description":"The name of the view.","type":"string","readOnly":true,"example":"Customers"},"@noteid":{"description":"The note ID of a view, which is uniquely identifies a view within a particular database.","type":"string","readOnly":true,"example":"222"},"@unid":{"description":"Universal Id of the view, uniquely identifies a view across all replicas of a database","type":"string","readOnly":true,"example":"86C72C1BF64B6DF04825847100373215"},"@alias":{"description":"Alternate names or alias of the view.","type":"string","readOnly":true},"selectionFormula":{"description":"","type":"string"},"columns":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignColumnSimple"}}},"example":{"@alias":"","@name":"Customers","@noteid":"1be","@unid":"86C72C1BF64B6DF04825847100373215","$0":{"title":"#","formula":"@DocNumber"},"$1":{"title":"Created","formula":"@Created"},"last_name":{"title":"LastName","formula":""},"first_name":{"title":"FirstName","formula":""},"email":{"title":"eMail","formula":""},"Color":{"title":"Color","formula":""},"Pet":{"title":"Pet","formula":""}}},"DesignViewSimpleRequest":{"title":"Root Type for DesignViewSimpleRequest","description":"Definition of request to create specific design element View.","type":"object","properties":{"name":{"description":"The name of the view.","type":"string"},"selectionFormula":{"description":"The formula to select documents for a view. ","type":"string"},"columns":{"description":"","type":"array","items":{"$ref":"#/components/schemas/DesignColumnSimple"}}},"example":{"name":"entries","selectionFormula":"Form = \"Entry\"","columns":[{"name":"name","title":"name","separatemultiplevalues":false,"sort":"ascending","formula":"name"},{"name":"email","title":"email","separatemultiplevalues":false,"sort":"ascending","formula":"email"}]}},"ErrorMessage":{"title":"Root Type for ErrorMessage","description":"Detailed error message, might contain stacktrace","type":"object","properties":{"details":{"type":"string"},"message":{"type":"string"},"status":{"format":"int32","type":"integer"}},"example":{"details":"Long list of details","message":"We screwed up","status":500}},"KeepAccess":{"title":"Root Type for KeepAccess","description":"Provides information of access level required for Domino REST API operations:\n- Domino REST API mapping in Domino directory\n- Domino REST API configuration in individual databases\n\nMasks ACL and Role checks for users of the API","required":["CreateDbMapping","DeleteDbMapping"],"type":"object","properties":{"CreateDbMapping":{"description":"Can the current user create Domino REST API configuration mappings","type":"boolean"},"DeleteDbMapping":{"description":"Can the current user delete Domino REST API configuration mappings","type":"boolean"},"databases":{"description":"Details of access to a given database","type":"array","items":{"$ref":"#/components/schemas/KeepAccessDetail"}}},"example":{"CreateDbMapping":true,"DeleteDbMapping":true,"databases":[{"path":"demo.nsf","readKeepConfig":true,"createDeleteKeepConfig":true,"configurations":["demotest"],"activeConfigurations":{"demotest":"demotest"}},{"path":"names.nsf","readKeepConfig":true,"createDeleteKeepConfig":true,"configurations":["names"],"activeConfigurations":{"names":"names"}}]}},"KeepAccessDetail":{"title":"Root Type for KeepAccessDetail","description":"Information about access to an individual database and, if access is sufficient, information about available configurations","type":"object","properties":{"path":{"description":"Path relativ to the data directory of an NSF","type":"string","example":"apps/demo.nsf"},"readKeepConfig":{"description":"Can the given user read existing Domino REST API configurations","type":"boolean","example":"true"},"createDeleteKeepConfig":{"description":"Can the current user create or delete Domino REST API configurations","type":"boolean","example":"true"},"configurations":{"description":"List of Domino REST API configurations, ready to be mapped, in the design of a database","type":"array","items":{"$ref":"#/components/schemas/KeepAccessQuery"},"example":"[\n {\n \"name\": \"alternateapprovals\",\n \"description\": \"Schema alternateapprovals\",\n \"iconName\": \"mountain\"\n },\n {\n \"name\": \"capprov\",\n \"description\": \"central approval\",\n \"iconName\": \"archeology\"\n },\n {\n \"name\": \"default2\",\n \"description\": \"Get approvals for training, travel and gear\",\n \"iconName\": \"sell\"\n }\n]"},"activeConfigurations":{"description":"Map of confgurations in use. Key is the public name, value the NSF internal name","type":"array","items":{"type":"object"},"example":"{\n \"demo\": \"demo\"\n}"}},"example":{"path":"demo.nsf","readKeepConfig":true,"createDeleteKeepConfig":true,"configurations":[{"name":"alternateapprovals","description":"Schema alternateapprovals","iconName":"mountain"},{"name":"capprov","description":"central approval","iconName":"archeology"},{"name":"default2","description":"Get approvals for training, travel and gear","iconName":"sell"}],"activeConfigurations":{"demo":"demo"}}},"KeepAccessQuery":{"title":"Root Type for KeepAccessQuery","description":"Query to be send to check if user can read/update/delete Domino REST API configurations","required":["checkAllNsf","onlyConfigured"],"type":"object","properties":{"databases":{"description":"List of file path to enquiry","type":"array","items":{"type":"string"}},"checkAllNsf":{"description":"Should the query check all databases on the current server - might take a while. Excludes mail files","type":"boolean","example":"false"},"onlyConfigured":{"description":"Should only databases with existing Domino REST API configurations be returned","type":"boolean"}},"example":{"checkAllNsf":false,"onlyConfigured":false,"databases":["demo.nsf","apps/crm.nsf"]}},"KeepAccessShort":{"title":"Root Type for KeepAccessShort","description":"Provides simple information of access level required for Domino REST API access get operations:\n- Domino REST API mapping in Domino directory\n- Domino REST API configuration in individual databases\n\nMasks ACL and Role checks for users of the API","type":"object","properties":{"CreateDbMapping":{"description":"Can the current user create Domino REST API configuration mappings","type":"boolean"},"DeleteDbMapping":{"description":"Can the current user delete Domino REST API configuration mappings","type":"boolean"}},"example":{"CreateDbMapping":true,"DeleteDbMapping":true}},"KeepDatabase":{"title":"Root Type for KeepDatabase","description":"REST API Configuration of a domino database including views, forms, agents, modes. Used only for admin endpoints.","required":["nsfPath","formulaEngine","isActive"],"type":"object","properties":{"apiName":{"description":"How this database is known to the API","type":"string"},"description":{"description":"Description with human readable details of the database's purpose","type":"string"},"formulaEngine":{"description":"Script engine to be used to resolve permission formulas in FormModes or DQL access.\nNative Domino, OpenFormula or JavaScript\n\nCurrently only Native Domino is implemented","enum":["domino","openformula","javascript"],"type":"string"},"icon":{"description":"Base64 of an icon. SVG preferred","type":"string"},"iconName":{"description":"alt text for icon","type":"string"},"isActive":{"description":"Allows to enable/disable API access without removing cofiguration. This is used for scope. active is used for schema. ","type":"boolean"},"agents":{"description":"List of agents that are permitted to be called from the API","type":"array","items":{"$ref":"#/components/schemas/AgentInfo"}},"allowCode":{"description":"Can JS code be submitted for execution","type":"boolean"},"configuredForms":{"description":"All forms that are configured for access via the Domino REST API. Details in keepdatabaseconfig_formmode","type":"array","items":{"type":"string","readOnly":true}},"dqlAccess":{"description":"Does the API allow DQL queries to be submitted? DQL can query any document. Handle with care","type":"boolean"},"forms":{"description":"Array with form configurations including form modes","type":"array","items":{"$ref":"#/components/schemas/KeepForm"}},"openAccess":{"description":"Can this database be accessed from a browser e.g. in a React app) or app without providing AppId and AppSecret. Still proper authentication using a JWT bearer is required","type":"boolean"},"dqlFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to execute when DQL Access is permitted to determine if it is permitted for the current user.\nDomino or OpenFormula"},"formAliases":{"description":"Collection of key / value pairs to map primary form names to potential alias values. A Notes document created with a form containing the alias will have the last alias value in its Form field","type":"object"},"requireRevisionToUpdate":{"description":"If db config \"requireRevisionToUpdate\" is enabled, then revision is required when update document and only update document when revision version is right.\r\n ","type":"boolean"},"views":{"description":"Array of Views that are available in the Domino REST API","type":"array","items":{"$ref":"#/components/schemas/ViewInfo"}},"nsfPath":{"description":"Location on Domino server","type":"string"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources","type":"string"},"allowDecryption":{"description":"Allow decrypt the database","type":"boolean"},"cacheTimestamp":{"description":"timestamp for when design data were last added","type":"integer"},"@unid":{"description":"Universal Id of the document to be acted upon","type":"string","readOnly":true},"dxlpath":{"description":"DXL path for this database","type":"string","readOnly":true},"availableViews":{"description":"Array of Views that are available in the Domino REST API","type":"array","items":{"$ref":"#/components/schemas/ViewInfo"}},"prohibitRefresh":{"description":"indicates if the schema is protected against refresh by the design tast","type":"boolean"},"@warnings":{"description":"List of design elements that are not in the database.","type":"array","items":{"type":"string"}}},"example":{"schemaName":"demoapi","description":"Demo database","nsfPath":"Demo.nsf","icon":"Base64 stuff, preferably SVG","iconName":"mountain","isActive":true,"requireRevisionToUpdate":false,"allowDecryption":true,"formulaEngine":"domino","openAccess":true,"allowCode":true,"dqlAccess":true,"dqlFormula":{"formulaType":"domino","formula":"@True"},"views":[{"name":"Customers","alias":["Customers"],"unid":"86C72C1BF64B6DF04825847100373215"},{"name":"MarketingInfo","alias":["MarketingInfo"],"unid":"10EA9EC66EA748BC4825851100420810"},{"name":"ChineseCustomers","alias":["ChineseCustomers"],"unid":"3FE5CD63E179F21600258680006DB25B"},{"name":"($All)","alias":["($All)"],"unid":"0E35D520A1EBBB5B48258435003E8284"},{"name":"Samples","alias":["Samples"],"unid":"5318911D496571410025860D00544B17"}],"agents":[],"forms":[{"formName":"Customer","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":["Form","first_name","email"],"fields":[{"name":"Body","fieldAccess":"RW","type":"object","format":"richtext","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":[],"summaryField":false},{"name":"color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"email","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"employee_count","fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"first_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"hobbies","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"last_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Owner","fieldAccess":"RW","type":"string","format":"authors","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY","READWRITERS"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Body","fieldAccess":"RW","type":"object","format":"richtext","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":[],"summaryField":false},{"name":"color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"email","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"employee_count","fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"first_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RO","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"hobbies","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"last_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Owner","fieldAccess":"RW","type":"string","format":"authors","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY","READWRITERS"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Body","fieldAccess":"RW","type":"object","format":"richtext","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":[],"summaryField":false},{"name":"color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"email","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"employee_count","fieldAccess":"RW","type":"integer","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"first_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"hobbies","fieldAccess":"RW","type":"array","format":"string","items":{"fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"last_name","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Owner","fieldAccess":"RW","type":"string","format":"authors","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY","READWRITERS"],"summaryField":true},{"name":"Pet","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]},{"formName":"SampleForm","alias":[],"formModes":[{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"onLoad":{"formulaType":"domino","formula":""},"onSave":{"formulaType":"domino","formula":""},"computeWithForm":false,"required":[],"fields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"readAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}],"writeAccessFields":[{"name":"Color","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Form","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Shape","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true},{"name":"Taste","fieldAccess":"RW","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"minLenght":-1,"maxLength":-1,"itemFlags":["SUMMARY"],"summaryField":true}]}]}],"formAliases":{"Entry":"Entry","SampleEntry":"SampleEntry","Customer":"Customer","IdPConfig":"IdP Configuration","OdataSampleForm":"OdataSampleForm","TestForm":"TestForm"},"@unid":"3D59BBE2676B2A45002588FD001E4B2A"}},"KeepField":{"title":"Root Type for KeepField","description":"Field description for fields / items in a KeepFormMode.\nDescribes name, type, and multi-value capability.\nModeled after json-schema where multi-value = array\nextension to json-schema limited to x-access-name\nto specify Domino Names, Reader, Author nature\nAll other field copied from JSON Schema","required":["type","name"],"type":"object","properties":{"name":{"description":"Field name. While anything theoretical is possible we stick to letters and numbers with the first letter capitalized. Not a hard rule to accomodate existing data","type":"string","example":"Form"},"type":{"description":"Data type, from JSON spec. Can be:\n- object\n- array\n- string\n- number\n- integer\n- boolean","enum":["object","array","string","number","integer","boolean"],"type":"string","example":"string"},"multivalue":{"description":"Can the field process multiple values, HCL Domino style.\nWhen missing => false","type":"boolean","readOnly":true,"example":"true"},"fieldGroup":{"description":"Domino multi-value fields can be grouped together to form a kind oc child record in a document. The fieldGroup defines such a grouping. It only is relevant for multi-value fields and isn't populated by default","type":"string","example":"recipients"},"description":{"description":"Long text explanation what the field is about","type":"string","example":"Enter the following information yada yada yada"},"format":{"description":"Format definition for Strings, extended from json-schema with readers, authors, names, json","enum":["authors","binary","byte","date","date-time","double","float","int32","int64","names","password","readers","richtext","boolean","string","json","attachments"],"type":"string","example":"names"},"items":{"description":"Item description can contain type and format","type":"object"},"minitems":{"description":"for array type: minimum number of items","type":"integer","example":"2"},"uniqueitems":{"description":"Shall array members be unique","type":"boolean","example":"true"},"minimum":{"description":"lowest value, value included","type":"number","example":"2"},"maximum":{"description":"maximum value, not included","type":"number","example":"42"},"exclusiveMinimum":{"description":"Minimum value, not included","type":"number","example":"4"},"maxLength":{"description":"not longer than that","type":"integer","example":"93"},"minLength":{"description":"Low long is a String","type":"integer","example":"4"},"fieldAccess":{"description":"Determines the access to a field as Read/Write, ReadOnly or WriteOnly","enum":["RW","RO","WO"],"type":"string"}},"example":{"name":"Age","type":"array","fieldGroup":"person","items":{"type":"integer","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1}},"KeepFieldGroup":{"title":"Root Type for KeepFieldGroup","description":"A KeepFieldGroup describes the properites of a group of multi-value Notes items that form \"child records\" inside a single Notes document. Besides multi-value items, items with a common name and a counting suffix can form a field group","required":["type","name","suffix"],"type":"object","properties":{"name":{"description":"Name tha links this definition to fieldGroup entries in KeepFields","type":"string","example":"itemLine"},"type":{"description":"How is the group formed: by multi-value or common field name with counting suffix ","enum":["byName","multiValue"],"type":"string","example":"multiValue"},"suffix":{"description":"Separation character(s) between item name and counter","type":"string","example":"_"},"firstWithoutSuffix":{"description":"For name linked items, does the first have the suffix (Name_1) or not (Name)","type":"boolean","example":"true"},"max":{"format":"int32","description":"MAximum number of rows/item names to use","type":"integer","example":"42"}},"example":{"name":"OrderLine","type":"byName","suffix":"_","firstWithoutSuffix":true,"max":50}},"KeepForm":{"description":"Definition of a Domino REST API form including form modes","required":["formName","formModes"],"type":"object","properties":{"formName":{"description":"Name of the form as stored in the document, might be an alias","type":"string"},"fieldGroups":{"description":"Definition of fieldgroups that form detail records inside a document","type":"array","items":{"$ref":"#/components/schemas/KeepFieldGroup"}},"formModes":{"description":"Array of FormModes configured for this database. Might be empty","minItems":1,"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/KeepFormMode"}},"alias":{"description":"Alternate names or alias of the form.","type":"array","items":{"type":"string"}}}},"KeepFormMode":{"title":"Root Type for KeepFormMode","description":"Form modes for Domino REST API Database config","required":["deleteAccessFormula","modeName","fields","readAccessFormula","writeAccessFormula"],"type":"object","properties":{"computeWithForm":{"description":"Compute with form before saving","type":"boolean"},"deleteAccessFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formuls to determine delete access"},"modeName":{"description":"lowercase, name of the mode. Special names are default and odata ","type":"string"},"onLoad":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to run after loading a document, before returning to the caller"},"onSave":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to run after receiving a document, before save"},"readAccessFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to determine read access for this mode"},"writeAccessFormula":{"$ref":"#/components/schemas/KeepFormula","description":"Formula to determine write permissions"},"validationRules":{"description":"formula rules to determine access","type":"array","items":{"$ref":"#/components/schemas/KeepFormula"}},"fields":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/components/schemas/KeepField"}}],"description":"all fields in this mode","type":"array","items":{"$ref":"#/components/schemas/KeepField"}},"required":{"description":"List of fields that are required to be provided","type":"array","items":{"type":"string"}},"readAccessFields":{"description":"read access fields in this mode","type":"array","items":{"$ref":"#/components/schemas/KeepField"}},"writeAccessFields":{"description":"write access fields in this mode","type":"array","items":{"$ref":"#/components/schemas/KeepField"}}},"example":{"modeName":"default","validationRules":[],"readAccessFormula":{"formulaType":"domino","formula":"@True"},"writeAccessFormula":{"formulaType":"domino","formula":"@True"},"deleteAccessFormula":{"formulaType":"domino","formula":"@False"},"computeWithForm":false,"required":["Form","first_name","email"],"fields":[{"name":"color","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"email","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"first_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Form","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RO","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"hobbies","type":"array","format":"string","items":{"type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"last_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Pet","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true}],"readAccessFields":[{"name":"color","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"email","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"first_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Form","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RO","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"hobbies","type":"array","format":"string","items":{"type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"last_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Pet","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true}],"writeAccessFields":[{"name":"color","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"email","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"first_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"hobbies","type":"array","format":"string","items":{"type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},"minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"last_name","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true},{"name":"Pet","type":"string","format":"string","minitems":-1,"uniqueitems":false,"minimum":0,"maximum":0,"exclusiveMinimum":-1,"fieldAccess":"RW","minLenght":-1,"maxLength":-1,"summaryField":true}]}},"KeepFormula":{"title":"Root Type for KeepFormula","description":"Formula in a scripting environment, that can be used for true/false evaluation or as a pre-load/save execution.","required":["formulaType"],"type":"object","properties":{"formulaType":{"description":"computation model, currently Domino only","enum":["domino"],"type":"string"},"formula":{"description":"Formula code to run","type":"string"},"message":{"description":"Optional message to use for fasilure of formula","type":"string"}},"example":{"formulaType":"Domino","formula":"@IsMember(\"[RaiseRequest]\"; @UserNamesList)"}},"QuickConfigParam":{"description":"Definition of request to quick config a domino database","required":["nsfPath"],"type":"object","properties":{"scopeName":{"description":"Name that is used in ?datSsource= parameter to access configured resource","type":"string"},"nsfPath":{"description":"path relative to Domino data directory to nsf database","type":"string"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources. Default value is \"default\"","type":"string"},"create":{"description":"If nsf file not exist, create one empty database or not.","type":"boolean"},"description":{"description":"Description to the configured scope","type":"string"},"icon":{"description":"Base64 of an icon. SVG preferred","type":"string"},"iconName":{"description":"alt text for icon","type":"string"},"maximumAccessLevel":{"description":"Determines the maximum ACL Level for the scope definition.\nDefault if not provided is Editor","enum":["NoAccess","Depositor","Reader","Author","Editor","Designer","Manager"],"type":"string"}}},"RestConfigShort":{"title":"Root Type for RestConfigShort","description":"Short summary of a rest configuration","type":"object","properties":{"apiName":{"description":"How this database is known to the API","type":"string"},"comment":{"description":"The comment assigned to the design element","type":"string"},"template":{"description":"The name of the note-specific template this design element is set to derive from","type":"string"},"prohibitRefresh":{"description":"When notes database has been configured \"Inherit from the design template\", if \"Prohibit design refresh or replace to modify\" is checked, the design element will not be affected when you replace or refresh the design.","type":"boolean"}},"additionalProperties":false,"example":{"apiName":"restcon","comment":"REST API configuration restcon2","template":"","prohibitRefresh":false}},"OAuthApplicationRequest":{"title":"Root Type for OAuthApplicationRequest","description":"Meta data to register an application for OAuth IdP","required":["client_name","scope","client_uri","redirect_uris"],"type":"object","properties":{"client_name":{"description":"Human readable Application name","type":"string"},"description":{"description":"Description what the application does","type":"string"},"redirect_uris":{"description":"List of callback URLs after consent is given. Must use https with the exception of http://localhost/some_url","type":"array","items":{"type":"string"}},"scope":{"description":"Scopes the application can (and will) request. When the application requests other scopes, token is denied","type":"string"},"client_uri":{"description":"Start page of application. Can be used to create list of apps","type":"string"},"logo_uri":{"description":"Optional: application logo URL","type":"string"},"status":{"description":"Is this application active","enum":["isActive","disabled"]},"contacts":{"description":"URL, eMail, handles to contact people responsible for the app","type":"array","items":{"type":"string"}},"token_endpoint_auth_method":{"description":"Token endpoint authentication","type":"string"},"client_id":{"description":"Application ID. Empty on creation, required for update","type":"string"}},"additionalProperties":false,"example":{"client_name":"My App","description":"Super cool demo App","redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","contacts":["admin@projectcastle.io"],"token_endpoint_auth_method":"client_secret_basic","status":"isActive"}},"OAuthApplicationRequestUpdate":{"title":"Root Type for OAuthApplicationRequestUpdate","description":"Meta data to register an application for updating OAuth IdP","type":"object","properties":{"client_name":{"description":"Human readable Application name","type":"string"},"description":{"description":"Description what the application does","type":"string"},"redirect_uris":{"description":"List of callback URLs after consent is given. Must use https with the exception of http://localhost/some_url","type":"array","items":{"type":"string"}},"scope":{"description":"Scopes the application can (and will) request. When the application requests other scopes, token is denied","type":"string"},"client_uri":{"description":"Start page of application. Can be used to create list of apps","type":"string"},"logo_uri":{"description":"Optional: application logo URL","type":"string"},"status":{"description":"Is this application active","enum":["isActive","disabled"]},"contacts":{"description":"URL, eMail, handles to contact people responsible for the app","type":"array","items":{"type":"string"}},"token_endpoint_auth_method":{"description":"Token endpoint authentication","type":"string"},"isActive":{"description":"DEPRECATED, Don't use","type":"string"},"client_id":{"description":"Internal application id. Ignored here, taken from URL query parameter","type":"string"}},"additionalProperties":false,"example":{"client_name":"My App","description":"Super cool demo App","redirect_uris":["http://localhost/callback","https://domino.projectcastle.io/identity","https://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","client_uri":"https://www.projectcastle.io/coolapp","logo_uri":"https://www.projectcastle.io/castle.jpg","contacts":["admin@projectcastle.io"],"token_endpoint_auth_method":"client_secret_basic","status":"isActive"}},"OAuthApplicationResponse":{"title":"Root Type for OAuthApplicationResponse","description":"Response for registering an application for OAuth IdP","required":["client_id","client_name","client_uri","redirect_uris","scope","status","token_endpoint_auth_method"],"type":"object","properties":{"client_name":{"description":"Human readable Application name","type":"string"},"description":{"description":"Desscription what the application does","type":"string"},"client_id":{"description":"System generated client Id. Used for auth request and as user name for Token requests","type":"string"},"redirect_uris":{"description":"List of callback URLs after consent is given. Must use https with the exception of http://localhost/some_url","type":"array","items":{"type":"string"}},"scope":{"description":"Scopes the application can (and will) request. When the application requests other scopes, token is denied","type":"string"},"client_uri":{"description":"Start page of application. Can be used to create list of apps","type":"string"},"logo_uri":{"description":"Optional: application logo URL","type":"string"},"token_endpoint_auth_method":{"description":"Token endpoint authentication","enum":["client_secret_basic"],"type":"string"},"status":{"description":"Is this application active","enum":["isActive","disabled"],"type":"string"},"contacts":{"description":"URL, eMail, handles to contact people responsible for the app","type":"array","items":{"type":"string"}},"@unid":{"description":"Universal Id of the document.","type":"string","readOnly":true},"@author":{"description":"The person who created the external application","type":"string","readOnly":true},"hasSecret":{"description":"Flag to indicate if an application has a secret configured","type":"boolean"}},"additionalProperties":false,"example":{"@unid":"F1490F201EB9D8C5482588B50013F519","author":"CN=John Doe/O=ProjectKeep","client_id":"429022-562b-641620","client_name":"My App","hasSecret":false,"client_uri":"https://www.projectcastle.io/coolapp","contacts":["admin@projectcastle.io","CN=John Doe/O=ProjectKeep"],"description":"Super cool demo App-testupdate","logo_uri":"http://www.projectcastle.io/castle.jpg","redirect_uris":["http://domino.projectcastle.io/identity","http://localhost/callback","http://www.projectcastle.io/oauth"],"scope":"demo $DECRYPT","status":"disabled","token_endpoint_auth_method":"client_secret_basic"}},"OAuthApplicationSecretRequest":{"title":"Root Type for OAuthApplicationSecretRequest","description":"Meta data to generated secret for an application.","required":["status"],"type":"object","properties":{"status":{"description":"Whether the application is active or disabled.","enum":["isActive","disabled"],"type":"string","example":"isActive"},"client_id":{"description":"Parameter to prevent error for apps that call this API. Value of this gets ignored internally. Use the path parameter for passing client_id.","type":"string"}},"additionalProperties":false,"example":{"status":"isActive"}},"OAuthApplicationSecretResponse":{"title":"Root Type for OAuthApplicationSecretResponse","description":"Response for a client_secret request. Client seccret is returned once","required":["client_id","client_secret"],"type":"object","properties":{"client_id":{"description":"application ID, required as header for access","type":"string"},"client_secret":{"description":"The application secret generated by Domino REST API for the external application","type":"string"}},"additionalProperties":false,"example":{"client_id":"9c5fed-38c4-441808","client_secret":"7e368d-6b3b-54eda8"}},"ViewInfo":{"title":"Root Type for ViewInfo","description":"","type":"object","properties":{"name":{"description":"Name of the view, matches design","type":"string"},"alias":{"description":"Collection of alternate names, might match aliases of the Domino design","type":"array","items":{"type":"string"}},"unid":{"description":"Primary key to find the view","type":"string"},"selectionFormula":{"description":"The formula to select documents for a view.","type":"string"},"columns":{"description":"List of columns in the view","type":"array","items":{"type":"object","properties":{"title":{"description":"Title of the column.","type":"string"},"formula":{"description":"Formula of the column.","type":"string"},"name":{"description":"Name of the column.","type":"string"},"externalName":{"description":"Another name for the column, if this is present, this will be what the column will be known as.","type":"string"}}}}},"example":{"name":"(Customers)","alias":["Kunden","ग्राहकों"],"unid":"ABCD12345","selectionFormula":"SELECT (Form = \"Customer\")","columns":[{"title":"CustomerID","formula":"@DocNumber","name":"$1"},{"title":"FirstName","formula":"","name":"first_name"},{"title":"LastName","formula":"","name":"last_name"}]}},"Unid":{"description":"32 char universalId A-Z0-9, primary key unique across replicas","maxLength":32,"minLength":32,"pattern":"[0-9A-F]*","type":"string","readOnly":true,"example":"6834F14BE9CA69F68525871E00583D1B"},"StatusMessage":{"title":"Root Type for StatusMessage","description":"Keep-formatted status message","required":["message","status","statusCode"],"type":"object","properties":{"status":{"description":"Success / failure status","type":"string"},"statusCode":{"format":"int32","description":"HTTP status code","type":"integer"},"message":{"description":"Short descriptive message","type":"string"},"unid":{"$ref":"#/components/schemas/Unid","description":"Document primary key"},"details":{"description":"Json Object containing further details, if appropriate","type":"string"}},"example":{"status":"OK","statusCode":200,"message":"deletion complete","unid":"61CCE871E79E8DDB8025852F004DFF2D"}},"RestMapping":{"title":"Root Type for RestMapping","description":"Maps a rest config from its internal name to the name it is visible. Info can be seen in the Internet sites of the domino directory. Also known as scope","required":["apiName","nsfPath","schemaName","isActive"],"type":"object","properties":{"@meta":{"description":"Document meta data.","type":"object"},"apiName":{"description":"Name that is used in ?datSsource= parameter to access mapped resource","pattern":"[a-z0-9]","type":"string"},"isActive":{"description":"Allows to enable/disable API access without removing cofiguration","type":"boolean"},"@Revisions":{"description":"This field records the current revision version of document. It's a 32-character hex-encoded string of date. ","type":"array","items":{"type":"string"},"example":"[\r\n \"2022-08-03T18:10:22.72+08:00\",\r\n \"2022-08-08T10:14:30.19+08:00\"\r\n]"},"@UpdatedBy":{"description":"The user who update the doc.","type":"array","items":{"type":"string"},"example":"[\r\n \"CN=John Doe/O=ProjectKeep\"\r\n]"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources","pattern":"[a-z0-9]","type":"string"},"nsfPath":{"description":"path relative to Domino data directory to nsf database","type":"string"},"description":{"description":"Human readable explanation","type":"string"},"Form":{"description":"Form name","type":"string","example":"KeepDatabase"},"Type":{"description":"","type":"string","example":"KeepDatabase"},"createSchema":{"description":"Default to be false if you don't set this property. It won't create the schema. When set to be true, it will create schema using given schemaName. ","type":"integer"},"server":{"description":"Domino server name that this scope is enabled on. Empty or '*' mean that this scope is enabled on all Domino servers. ","type":"string"},"maximumAccessLevel":{"description":"Limits, but not extends the access level granted to an API user.\nMirrors the MaximumInternetAccess in DB ACLs.\nDefault if not provided is Editor","enum":["NoAccess","Depositor","Author","Editor","Designer","Manager","Reader"],"type":"string"}},"additionalProperties":false,"example":{"@meta":{"noteid":2342,"unid":"1E280A1798C5C313482588D9002671A2","created":"2022-10-12T14:59:54.58+08:00","lastmodified":"2022-10-12T15:13:36.56+08:00","lastaccessed":"2022-10-12T15:10:26.59+08:00","lastmodifiedinfile":"2022-10-12T15:13:36.57+08:00","addedtofile":"2022-10-12T14:59:54.7+08:00","noteclass":["DATA","DOCUMENT"],"unread":true,"revision":"000000060027B2B8482588D9"},"$UpdatedBy":["CN=John Doe/O=ProjectKeep"],"$Revisions":["2022-10-12T14:59:54.7+08:00","2022-10-12T15:09:02.71+08:00","2022-10-12T15:09:25.33+08:00","2022-10-12T15:09:45.99+08:00"],"apiName":"demoapi","createSchema":0,"description":"The famous demo database","isActive":true,"nsfPath":"Demo.nsf","schemaName":"demoapi","Form":"KeepDatabase","Type":"KeepDatabase","server":"*"}},"RestMappingRequest":{"title":"Root Type for RestMappingRequest","description":"Definition for meta data information to create scope.\nProperty 'createSchema' should be 'true' if you want to create schema with schemaName.","required":["apiName","schemaName","nsfPath"],"type":"object","properties":{"description":{"description":"Human readable explanation","type":"string"},"apiName":{"description":"Name that is used in ?datSsource= parameter to access mapped resource","type":"string"},"schemaName":{"description":"name (without .json extension) of schema file in nsf REST file resources","type":"string"},"nsfPath":{"description":"path relative to Domino data directory to nsf database","type":"string"},"isActive":{"description":"Allows to enable/disable API access without removing cofiguration","type":"boolean"},"createSchema":{"description":"Default to be false if you don't set this property. It won't create the schema. When set to be true, it will create schema using given schemaName. ","type":"boolean","example":"false"},"icon":{"description":"Base64 of an icon. SVG preferred","type":"string"},"iconName":{"description":"alt text for icon","type":"string"},"server":{"description":"Domino server name that this scope is enabled on. Empty or '*' mean that this scope is enabled on all Domino servers. ","type":"string"},"maximumAccessLevel":{"description":"Limits, but not extends the access level granted to an API user.\nMirrors the MaximumInternetAccess in DB ACLs.\nDefault if not provided is Editor","enum":["NoAccess","Depositor","Author","Editor","Designer","Manager","Reader"],"type":"string"}},"additionalProperties":false,"example":{"description":"The famous demo database","apiName":"demoapi","schemaName":"demoapi","nsfPath":"Demo.nsf","isActive":true,"icon":"Base64 stuff, preferably SVG","iconName":"beach","createSchema":false,"server":"*"}},"KeepAccessSchema":{"title":"Root Type for KeepAccessSchema","description":"Short description of a schema stored in the resources of a NSF database","required":["name"],"type":"object","properties":{"name":{"description":"Unique name inside the database","type":"string","example":"\"default\""},"description":{"description":"Human readable description of a schema","type":"string","example":"Default access to database assets"},"iconName":{"description":"Name of the assigned svg icon from the list of available icons","type":"string","example":"\"sell\""}},"example":{"name":"default","description":"Standard access to a database","iconName":"archeology"}},"KeepMissingConfigurations":{"description":"Definition for Keep's Missing configuration details when /purge is called","type":"object","properties":{"nsfName":{"description":"Indicates the nsf path of a configuration in the KeepConfig.nsf that has error on load","type":"string","example":"Demo.nsf"},"scope":{"description":"The apiName in the KeepConfig.nsf.","type":"string","example":"shinyscope"},"schema":{"description":"The schemaName in the KeepConfig.nsf.","type":"string","example":"shinyschema"},"server":{"description":"The server in the KeepConfig.nsf.","type":"string","example":"frascati"},"unid":{"description":"Universal Id of the document, uniquely identifies a document across all replicas of a database","type":"string","readOnly":true,"example":"360A6B7035CD03C248258816000DDB47"},"action":{"description":"Determine what the Action will be to be used for the POST /purge endpoint","type":"string","readOnly":true,"example":"removeScope"}},"example":{"nsfName":"Demo.nsf","scope":"shinyscope","schema":"schemagone","action":"removeScope","server":"","unid":"360A6B7035CD03C248258816000DDB47"}},"UpdateCreateDesignResponse":{"description":"KEEP formatted response for UpdateCreateDesign","required":["success","type","name","log"],"type":"object","properties":{"success":{"description":"States whether the design is created or not.","type":"boolean"},"type":{"description":"Type of design created.","enum":["view","form"],"type":"string"},"name":{"description":"Name of design created.","type":"string"},"log":{"description":"Log of design importer","type":"string"}},"example":{"success":true,"type":"form","name":"Customers","log":"\n\n"}},"DeletePurge":{"title":"Root Type for DeletePurge","description":"Collection of objects for delete of documents in /admin/purge under schemaScopeCombinations property ","required":["schemaScopeCombinations"],"type":"object","properties":{"schemaScopeCombinations":{"description":"JSON source for new schema-scope combinations to be purged","type":"array","items":{"$ref":"#/components/schemas/DeletePurgeBody"}}},"additionalProperties":false,"example":{"schemaScopeCombinations":[{"nsfName":"demo.nsf","scope":"brokendemo","schema":"sampleschema","serverName":"","unid":"0E35D520A1EBBB5B48258435003E8284"},{"nsfName":"demo2.nsf","scope":"brokendemo2","schema":"sampleschema2","serverName":"","unid":"0E35D520A1EBBB5B4825843503431V32"}]}},"DeletePurgeBody":{"title":"Root Type for DeletePurge","description":"Collection of objects for delete of documents in /admin/purge","type":"object","properties":{"nsfName":{"description":"Indicates the nsf path of a configuration in the KeepConfig.nsf that has error on load","type":"string"},"scope":{"description":"Scope name of the mapping","type":"string"},"schema":{"description":"name (without .json extension) of schema file in nsf REST file resources","type":"string"},"serverName":{"description":"The server where the schema-scope is pointing to","type":"string"},"unid":{"description":"32 char universalId A-Z0-9, primary key unique across replicas","type":"string"}},"example":{"nsfName":"demo.nsf","scope":"brokendemo","schema":"sampleschema","serverName":"","unid":"0E35D520A1EBBB5B48258435003E8284"}}},"responses":{"400BadRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Invalid request. Shows up when submission is flaky:\n- Wrong authentication\n- Wrong content-type\n- Missing or wrong parameter types"},"401Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"Unauthorized":{"value":{"status":401,"message":"Invalid credentials or account locked"}}}}},"description":"401 Unauthorized"},"403Forbidden":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"Forbidden":{"value":{"message":"Nice try chap, ask before next time","status":403}}}}},"description":"Forbidden"},"404NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NotFound":{"value":{"message":"This is not the data you seek!","status":404}}}}},"description":"Content not found"},"405MethodNotAllowed":{"description":"Method not allowed"},"406NotAcceptable":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"GenericRejection":{"value":{"details":"The haferlup needs left turning shrufti","message":"This is not a supported operation. Try again","status":406}}}}},"description":"Invalid operation - something got requested that isn't supported"},"500InternalServerError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"GenericError":{"value":{"details":"Dreaded pirate NullPointer","message":"Sorry pal, we screwed up","status":500}}}}},"description":"The server screwed up"},"501NotImplemented":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"examples":{"NextVersion":{"value":{"details":"We do sprints, not marathons","message":"Not now, maybe tomorrow","status":501}}}}},"description":"Working on it, just not yet"}},"securitySchemes":{"jwt":{"scheme":"bearer","type":"http","description":"OIDC access token or compliant JWT"}}},"tags":[{"name":"admin","description":"The endpoints allow to manage scopes (the Domino databases exposed), OAuth application registration and the general setup of Domino REST API. Accessing these endpoints requires a [KEEPAdmin] role for the user"},{"name":"schema","description":"Data definitions how the API returns and accepts data, creating independence from Domino design elements. Creating or altering a schema requires designer access to the respective database"},{"name":"design","description":"Domino design elements including internal Source Code"}],"x-keep-version":1}
diff --git a/docs/howto/IdP/configuringCertificates.md b/docs/howto/IdP/configuringCertificates.md
index 0243eb75..050d0b49 100644
--- a/docs/howto/IdP/configuringCertificates.md
+++ b/docs/howto/IdP/configuringCertificates.md
@@ -67,7 +67,7 @@ To get valid certificates, use any of the following approaches:
```json
{
"jwt": {
- "oicd": {
+ "my-idp": {
"active": true,
"algorithm": "RS256",
"keyFile": "10-jwt.pubkey"
diff --git a/docs/howto/IdP/configuringIdentityProvider.md b/docs/howto/IdP/configuringIdentityProvider.md
index e7fdb637..1b83ec0a 100644
--- a/docs/howto/IdP/configuringIdentityProvider.md
+++ b/docs/howto/IdP/configuringIdentityProvider.md
@@ -99,7 +99,7 @@ The JSON file looks like this:
{
"disableJwtExpiryCheck": false,
"jwt": {
- "oicd": {
+ "my-idp": {
"active": true,
"algorithm": "RS256",
"keyFile": "10-jwt.pubkey"
@@ -112,12 +112,12 @@ wherein:
- `disableJwtExpiryCheck`: By setting the value to `true`, the enforcement of JWT expiration can be disabled. **DO NOT** do this on a production system (default is `false`).
- `jwt`: Entry is related to JWT authorization.
-- `oicd`: The name you give your IdP. It could be `Rumpelstielzchen` but needs to be unique on your server.
+- `my-idp`: The name you give your IdP. It could be `Rumpelstielzchen` but needs to be unique on your server.
- `active`: True/false.
- `algorithm`: Currently supported: `RS256`.
- `keyFile`: Path to public key file (PEM format), either relative to `keepconfig.d`or an absolute path.
-Domino REST API supports more than one IdP, distinguished by the name `oicd` in the example. Access checking takes longer the more identity providers you configure since Domino REST API checks every provider's key until it finds a match.
+Domino REST API supports more than one IdP, distinguished by the name `my-idp` in the example. Access checking takes longer the more identity providers you configure since Domino REST API checks every provider's key until it finds a match.
## Obtaining the public key directly from the IdP
diff --git a/docs/references/accesscontrol.md b/docs/references/accesscontrol.md
index 04521e41..c521282c 100644
--- a/docs/references/accesscontrol.md
+++ b/docs/references/accesscontrol.md
@@ -19,7 +19,7 @@ The [Domino Developer](../references/usingdominorestapi/roles.md#domino-develope
## Application access
-The Domino REST API provides its own IdP (Identity Provider) implementation following OICD standards. Applications are configured using a `client_id` and a `client_secret` to request access on behalf of an user.
+The Domino REST API provides its own IdP (Identity Provider) implementation following OIDC standards. Applications are configured using a `client_id` and a `client_secret` to request access on behalf of an user.
When an enterprise IdP shall be used, the resulting `AccessToken` needs to comply with the [Domino REST API JWT specification](../references/security/jwt.md).
diff --git a/docs/references/usingdominorestapi/keepapplications.md b/docs/references/usingdominorestapi/keepapplications.md
index e11572db..33fce564 100644
--- a/docs/references/usingdominorestapi/keepapplications.md
+++ b/docs/references/usingdominorestapi/keepapplications.md
@@ -72,7 +72,7 @@ When creating a new Application, enter the application name, application descrip
When the application presents App ID and App Secret in the header of a request, it can access the databases, even when they're not defined as "Open Access". This information is required for an application to use an OAuth flow to gain access to data. Thus, an application server can have more access than a browser application.
-Domino REST API offers an OAuth/OICD controlled access.
+Domino REST API offers an OAuth/OIDC controlled access.
### Desktop applications
diff --git a/docs/references/usingdominorestapi/scopes.md b/docs/references/usingdominorestapi/scopes.md
index cd93c574..28b408fc 100644
--- a/docs/references/usingdominorestapi/scopes.md
+++ b/docs/references/usingdominorestapi/scopes.md
@@ -19,6 +19,6 @@ Scopes are a space-separated lists of values. By default, a user who authenticat
A scope doesn't **open** access to a resource; that's the job of the database ACL. A scope **limits** access.
-Besides the default scopes of `MAIL`, `$DATA`, `$DECRYPT`, and `$SETUP`, any of the database aliases can be used as a scope term. This allows an IdP to ask a user for tailored permissions in an OICD flow to limit exact access required instead of having the full user spectrum.
+Besides the default scopes of `MAIL`, `$DATA`, `$DECRYPT`, and `$SETUP`, any of the database aliases can be used as a scope term. This allows an IdP to ask a user for tailored permissions in an OIDC flow to limit exact access required instead of having the full user spectrum.
For more information, see [Scope](../../topicguides/understanding.md#databases-schemas-and-scopes).
diff --git a/docs/topicguides/architecture.md b/docs/topicguides/architecture.md
index 7e55b051..8d90063f 100644
--- a/docs/topicguides/architecture.md
+++ b/docs/topicguides/architecture.md
@@ -113,11 +113,11 @@ Access to the Domino REST APIs requires a valid JavaScript Web Token (JWT), sign
### Justification
-Domino REST API is API only, so any dance that requires user interaction must happen before Domino REST APIs are accessed. The ability to use Domino credentials, including local users (note: _local users work in Notes client only_) to obtain a JWT token lowers the barrier to entry. JWT is an established [industry standard (RFC7519)](https://tools.ietf.org/html/rfc7519) and also is the end result of an [OpenID Connect (OICD)](https://openid.net/connect/) dance. So its use and risks are well understood and documented.
+Domino REST API is API only, so any dance that requires user interaction must happen before Domino REST APIs are accessed. The ability to use Domino credentials, including local users (note: _local users work in Notes client only_) to obtain a JWT token lowers the barrier to entry. JWT is an established [industry standard (RFC7519)](https://tools.ietf.org/html/rfc7519) and also is the end result of an [OpenID Connect (OIDC)](https://openid.net/connect/) dance. So its use and risks are well understood and documented.
### Alternatives
-We also looked at OICD, SAML, and Kerberos. They all require user interaction to authorize access. Since Domino REST API is API only and has no user interface, the application must authorize access.
+We also looked at OIDC, SAML, and Kerberos. They all require user interaction to authorize access. Since Domino REST API is API only and has no user interface, the application must authorize access.
### Implication