@hcl-software/node-red-domino
Version:
Connect NodeRED to HCL Domino
1 lines • 247 kB
JSON
{"openapi":"3.0.2","info":{"contact":{"email":"HeyHCL@pnp-hcl.com","name":"HCL America Inc","url":"https://opensource.hcltechsw.com/Domino-rest-api/"},"description":"REST APIs for Domino and more done right. With declarative security and access to Code, Design and Data","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"title":"HCL Domino REST API basis","version":"1.2.1"},"servers":[{"description":"Actual Server","url":"https://frascati.projectkeep.io/api/v1"},{"description":"Keep enabled server","url":"/api/v1"}],"paths":{"/apps":{"description":"Only Application Name/client_name, description, icon/logo_uri, Application URL/client_uri to be shown to be able to render the Domino REST API landing page","get":{"description":"Return Application Name/client_name, Description, Icon/logo_URI, Application URL/client_uri of active OAuth applications","operationId":"fetchApps","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AppInfo"},"type":"array"}}},"description":"List of active apps"}},"security":[{}],"summary":"Get the list of configured OAuth applications","tags":["admin"],"x-keep-version":1},"summary":"Short list of OAuth applications"},"/attachmentnames/{unid}":{"description":"Get an array of file names from a document.","get":{"description":"Retrieves a list of all attachments on a document","operationId":"getDocumentAttachmentNames","responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Get all attachment names on a document.","tags":["data"],"x-keep-version":1},"parameters":[{"description":"If set to true will also parse the RichText fields for embedded files and return their path. This path can be used as the attachment name with the GET /attachments/{unid}/{attachmentName} to download the file.","in":"query","name":"includeEmbedded","required":false,"schema":{"type":"boolean"}},{"description":"Keep alias for the database to be queried","in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Universal Id of the document to be acted upon","in":"path","name":"unid","required":true,"schema":{"type":"string"}}],"summary":"Get an array of file names from a document."},"/attachments/{unid}":{"description":"Add an attachment to a document","parameters":[{"description":"Name of the field in which the attachment resides. Pass this to remove the hotspot for the attachment from that rich text field, otherwise the hotspot will remain. If the attachment is attached directly to the document, not a field, there is not need to do this.","in":"query","name":"fieldName","required":false,"schema":{"type":"string"}},{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Universal Id of the document to be acted upon","examples":{"sample":{"value":"94CA3B3B5E035D6048258471003639C6"}},"in":"path","name":"unid","required":true,"schema":{"type":"string"}}],"post":{"description":"The filename passed will be used, if unique. Otherwise a unique name will be evaluated from the passed filename.","operationId":"createDocumentAttachment","parameters":[{"description":"Name of the rich text field to attach this attachment to. If this is left off the attachment is attached to the document.","in":"query","name":"fieldName","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"filename":{"items":{"format":"binary","type":"string"},"type":"array"}},"type":"object"}}},"description":"It's a file requested. The fieldName is not required. ","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"MultipleAttachments":{"value":{"filenames":["myFile.xlsx","myFile2.xlsx"],"status":"upload complete"}},"SingleAttachment":{"value":{"filename":"myFile.xlsx","status":"upload complete"}}},"schema":{"$ref":"#/components/schemas/AttachmentsUNIDResponseMessage"}}},"description":"Success"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Creates a new attachment in an existing document","tags":["data"],"x-keep-version":1},"summary":"Add an attachment to a document"},"/attachments/{unid}/{attachmentName}":{"delete":{"description":"Remove the attachment for the document","operationId":"deleteDocumentAttachment","parameters":[{"description":"Name of the field in which the attachment resides. Pass this to remove the hotspot for the attachment from that rich text field, otherwise the hotspot will remain. If the attachment is attached directly to the document, not a field, there is not need to do this.","in":"query","name":"fieldName","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"details":{"appId":"1fe2cd-ac38-26c7d6"},"message":"deletion complete","status":"OK","statusCode":200,"unid":"61CCE871E79E8DDB8025852F004DFF2D"}}},"schema":{"$ref":"#/components/schemas/StatusMessage"}}},"description":"Success"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Removes an attachment","tags":["data"],"x-keep-version":1},"description":"Retrieve a document's attachment","get":{"description":"Get the attachment of a document","operationId":"getDocumentAttachment","responses":{"200":{"description":"Successful retrieval\nResponse does not contain a media type since a media type of an attachment can be any type.\nFor a list of well defined media types check the available documentation:\nhttps://www.iana.org/assignments/media-types/media-types.xhtml\n"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Retrieve a document's attachment","tags":["data"],"x-keep-version":1},"parameters":[{"description":"Name of the attachment","examples":{"attachmentName":{"value":"myFile.xlsx"}},"in":"path","name":"attachmentName","required":true,"schema":{"type":"string"}},{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Universal Id of the document to be acted upon","examples":{"sample":{"value":"94CA3B3B5E035D6048258471003639C6"}},"in":"path","name":"unid","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a document's attachment"},"/auth":{"description":"Auxilary login for users who exist in Domino with HTTP passwords","post":{"description":"Login and retrieve JWT token","operationId":"authLogin","requestBody":{"content":{"application/json":{"examples":{"AuthLogin":{"value":{"password":"AdminPassword","username":"AdminName"}}},"schema":{"$ref":"#/components/schemas/BasicAuthRequest"}}},"description":"Username and password in Json format","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResult"}}},"description":"Successful authentication"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"message":"Invalid credentials or account locked","status":401}}},"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Unauthorized"}},"security":[{}],"summary":"Get JWT Session","tags":["authentication"],"x-keep-scope":"ANY","x-keep-version":1},"summary":"Get an JWT session for a given user"},"/auth/basic":{"description":"Exchange a basic auth for a JWT Token in the JSON response.\nUse for troubled APIs","get":{"description":"Submit username and password in an authentication header and get valid JWT in return","operationId":"authLoginBasic","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResult"}}},"description":"Successful auth"},"401":{"description":"Wrong credentials"}},"security":[{"basic":[]}],"summary":"Get identity information","tags":["authentication"],"x-keep-scope":"ANY","x-keep-version":5},"summary":"Login using basic, get back JWT"},"/auth/extend":{"description":"Replace JWT to extend session","post":{"description":"Get a new JWT for processing","operationId":"authRenewJwt","requestBody":{"content":{"application/json":{"examples":{"AuthExtend":{"value":{"bearer":"{{AUTH_KEY}}"}}},"schema":{"$ref":"#/components/schemas/AuthResult"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResult"}}},"description":"Successful renew"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"}},"security":[{"jwt":[]}],"summary":"Get a new JWT for processing","tags":["authentication"],"x-keep-scope":"ANY","x-keep-version":5},"summary":"Replace JWT to extend session"},"/auth/logout":{"description":"Log out a current JWT based user","get":{"description":"Invalidates token in header. Only use this operation when GET for logout is really needed, otherwise it is recommended to use POST operation for logout.","operationId":"authLogoutGet","responses":{"200":{"content":{"application/json":{"examples":{"logout":{"value":{"message":"CN=John Doe/O=ProjectKeep logged out (0 days, 1 hours, 59 minutes, 40 seconds.)","status":200,"statusText":"OK"}}},"schema":{"$ref":"#/components/schemas/StatusMessage"}}},"description":"Logout body, fixed format"}},"security":[{"jwt":[]}],"summary":"Logout and invalidate token.","tags":["authentication"],"x-keep-scope":"ANY","x-keep-version":1},"post":{"description":"Logout and invalidate token","operationId":"authLogout","requestBody":{"content":{"application/json":{"examples":{"AuthLogout":{"value":{"logout":"Yes"}}},"schema":{"$ref":"#/components/schemas/LogoutBody"}}},"description":"Logout body, fixed format","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"logout":{"value":{"message":"CN=John Doe/O=ProjectKeep logged out (0 days, 1 hours, 59 minutes, 40 seconds.)","status":200,"statusText":"OK"}}},"schema":{"$ref":"#/components/schemas/StatusMessage"}}},"description":"Successful logout"}},"security":[{"jwt":[]}],"summary":"Logout and invalidate token","tags":["authentication"],"x-keep-scope":"ANY","x-keep-version":1},"summary":"Log out a current JWT based user"},"/authforoauthflow":{"description":"Auxilary login for use with OAuth flow to process the consent screen","post":{"description":"Username, Password & scope = \"oauth\" are required to use this endpoint","operationId":"loginForOAuthFlow","requestBody":{"content":{"application/json":{"examples":{"AuthLogin":{"value":{"password":"{{AdminPassword}}","scope":"oauth","username":"{{AdminName}}"}}},"schema":{"$ref":"#/components/schemas/BasicAuthForOauthFlow"}}},"description":"Username and password in Json format","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResult"}}},"description":"Successful authentication"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"message":"Invalid credentials or account locked","status":401}}},"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Unauthorized"}},"security":[{}],"summary":"Get JWT Session for OAuth consent screen","tags":["authentication"],"x-keep-scope":"ANY","x-keep-version":1},"summary":"Get an JWT session for a given user"},"/bulk/create":{"description":"Create multiple documents with a single call","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"The format RichText fields will be returned. The default if unspecified is mime.","in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}}],"post":{"description":"Create multiple documents in a request","operationId":"bulkCreateDocuments","requestBody":{"content":{"application/json":{"examples":{"SampleBulkCreateDocuments":{"value":{"documents":[{"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","first_name":"Kristoffer","gender":"Male","last_name":"Aaronsohn"},{"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","first_name":"Kristoffer","gender":"Male","last_name":"Aaronsohn"},{"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","first_name":"Kristoffer","gender":"Male","last_name":"Aaronsohn"},{"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","first_name":"Kristoffer","gender":"Male","last_name":"Aaronsohn"},{"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","first_name":"Kristoffer","gender":"Male","last_name":"Aaronsohn"}]}}},"schema":{"$ref":"#/components/schemas/BulkCreateDocuments"}}},"description":"Object with array property documents","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleResponse":{"value":[{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6242f82b\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-29T20:14:35+08:00","@noteid":6658,"@size":99,"@unid":"81E039D456E028D3482588140043410B","@unread":true,"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6242f82b\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-29T20:14:35+08:00","@noteid":6662,"@size":99,"@unid":"597042E199754897482588140043410D","@unread":true,"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6242f82b\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-29T20:14:35+08:00","@noteid":6666,"@size":99,"@unid":"D2E9CF578D0B3844482588140043410F","@unread":true,"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6242f82b\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-29T20:14:35+08:00","@noteid":6670,"@size":99,"@unid":"05B08E4A7874C01E4825881400434111","@unread":true,"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6242f82b\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-29T20:14:35+08:00","@noteid":6674,"@size":99,"@unid":"D650B4BF0DE3BB714825881400434113","@unread":true,"Color":"Purple","Form":"TestForm","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp"}]}},"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Creation result. Returns success / failure for each document"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Create multiple documents in a single call","tags":["data"],"x-keep-version":1},"summary":"Create multiple documents with a single call"},"/bulk/delete":{"description":"Delete multiple documents with a single call","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}}],"post":{"description":"Delete multiple documents in a request","operationId":"bulkDeleteDocuments","requestBody":{"content":{"application/json":{"examples":{"SampleBulkDelete":{"value":{"mode":"default","unids":["81E039D456E028D3482588140043410B","F6392938B2A8D0144825881400349085"]}},"SampleBulkDeleteWithoutMode":{"value":{"unids":["81E039D456E028D3482588140043410B","F6392938B2A8D0144825881400349085"]}}},"schema":{"$ref":"#/components/schemas/BulkUnids"}}},"description":"Object with mode and array document UNIDs. ","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleBulkDeleteResponse":{"value":[{"message":"Document 81E039D456E028D3482588140043410B deleted","status":200,"statusText":"OK","unid":"81E039D456E028D3482588140043410B"},{"message":"Document F6392938B2A8D0144825881400349085 deleted","status":200,"statusText":"OK","unid":"F6392938B2A8D0144825881400349085"}]}},"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Creation result. Returns success / failure for each document"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Delete multiple documents in a single call","tags":["data"],"x-keep-version":1},"summary":"Delete multiple documents with a single call"},"/bulk/etag":{"description":"Determine whether multiple documents exist with a single call by unids, returning ETags","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}}],"post":{"description":"Determine whether multiple documents exist with a single call by unids, returning ETags","operationId":"bulkDocumentEtagByUnid","requestBody":{"content":{"application/json":{"examples":{"SampleBulkGetDocByUNIDNoMode":{"value":{"unids":["05B08E4A7874C01E4825881400434111","D2E9CF578D0B3844482588140043410F","D650B4BF0DE3BB714825881400434113"]}},"SampleBulkGetDocumentByUNID":{"value":{"mode":"default","unids":["05B08E4A7874C01E4825881400434111","D2E9CF578D0B3844482588140043410F","D650B4BF0DE3BB714825881400434113"]}}},"schema":{"$ref":"#/components/schemas/BulkUnids"}}},"description":"Object with mode and array document UNIDs.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleResponse":{"value":{"D2E9CF578D0B3844482588140043410F":"W/\" 6243a80a\""}}},"schema":{"$ref":"#/components/schemas/DocumentExistencePayload"}}},"description":"Existence check result. Returns status and ETag for each document, keyed by UNID"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Determine whether multiple documents exist with a single call by unids, returning ETags","tags":["data"],"x-keep-version":1},"summary":"Determine whether multiple documents exist with a single call by unids, returning ETags"},"/bulk/folder":{"description":"Adds or removes documents from a folder","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}}],"post":{"description":"Adds or removes documents from a folder","operationId":"bulkDocumentFolderByUnid","requestBody":{"content":{"application/json":{"examples":{"SampleBulkGetDocByUNIDNoMode":{"value":{"unids":["05B08E4A7874C01E4825881400434111","D2E9CF578D0B3844482588140043410F","D650B4BF0DE3BB714825881400434113"]}},"SampleBulkGetDocumentByUNID":{"value":{"mode":"default","unids":["05B08E4A7874C01E4825881400434111","D2E9CF578D0B3844482588140043410F","D650B4BF0DE3BB714825881400434113"]}}},"schema":{"$ref":"#/components/schemas/BulkFolderDocuments"}}},"description":"Object with mode and array document UNIDs.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleResponse":{"value":{"D2E9CF578D0B3844482588140043410F":"W/\" 6243a80a\""}}},"schema":{"items":{"$ref":"#/components/schemas/StatusMessage"},"type":"array"}}},"description":"Existence check result. Returns status for each document, keyed by UNID"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Adds or removes documents from a folder","tags":["data"],"x-keep-version":1},"summary":"Adds or removes documents from a folder"},"/bulk/unid":{"description":"Retrieve multiple documents with a single call by unids","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"The format RichText fields will be returned. The default if unspecified is mime.","examples":{"RichTextAsMime":{"value":"mime"}},"in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}},{"description":"When set to false, all Json items on the top level of an object get suppressed.\nDefault is true","in":"query","name":"meta","schema":{"type":"boolean"}}],"post":{"description":"Retrieve multiple documents in a single call by unid","operationId":"bulkGetDocumentsByUnid","parameters":[{"description":"When set to false, all metadata Json items on the top level of an object get suppressed.\nDefault is true","in":"query","name":"meta","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"examples":{"Request with mode":{"value":{"mode":"mymode","unids":["1CC22F3EF91B466200258A3100584D9B","20E0116E35C1A29300258A3100587BB4","8D2CFCF259A6197E00258A31004F8853"]}},"SampleBulkGetDocByUNIDNoMode":{"value":{"unids":["05B08E4A7874C01E4825881400434111","D2E9CF578D0B3844482588140043410F","D650B4BF0DE3BB714825881400434113"]}},"SampleBulkGetDocumentByUNID":{"value":{"mode":"default","unids":["05B08E4A7874C01E4825881400434111","D2E9CF578D0B3844482588140043410F","D650B4BF0DE3BB714825881400434113"]}}},"schema":{"$ref":"#/components/schemas/BulkUnids"}}},"description":"Object with mode and array document UNIDs.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleResponse":{"value":[{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6243a80a\"","@lastaccessed":"2022-03-30T08:44:58+08:00","@lastmodified":"2022-03-30T08:44:58+08:00","@noteid":6666,"@size":134,"@unid":"D2E9CF578D0B3844482588140043410F","@unread":true,"Color":"Purple","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","form":"TestForm"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6243a80a\"","@lastaccessed":"2022-03-30T08:44:58+08:00","@lastmodified":"2022-03-30T08:44:58+08:00","@noteid":6670,"@size":134,"@unid":"05B08E4A7874C01E4825881400434111","@unread":false,"Color":"Purple","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","form":"TestForm"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6243a80a\"","@lastaccessed":"2022-03-30T08:44:58+08:00","@lastmodified":"2022-03-30T08:44:58+08:00","@noteid":6674,"@size":134,"@unid":"D650B4BF0DE3BB714825881400434113","@unread":false,"Color":"Purple","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","form":"TestForm"}]}},"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Creation result. Returns success / failure for each document"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Retrieve multiple documents in a single call by unid","tags":["data"],"x-keep-version":1},"summary":"Retrieve multiple documents with a single call by unids"},"/bulk/update":{"description":"Update multiple documents with a single call","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"The format RichText fields will be returned. The default if unspecified is mime.","in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}}],"patch":{"description":"Update multiple documents in a single call","operationId":"bulkUpdateDocumentsByQuery","requestBody":{"content":{"application/json":{"examples":{"SampleBulkUpdate":{"value":{"maxScanDocs":500000,"maxScanEntries":200000,"mode":"default","noViews":false,"query":"Form = 'TestForm' and first_name = 'Kristoffer' and last_name = 'Aaronsohn'","replaceItems":{"first_name":"TestName"},"returnUpdatedDocument":false,"timeoutSecs":300,"viewRefresh":true}}},"schema":{"$ref":"#/components/schemas/BulkUpdateDocuments"}}},"description":"Object with query, mode and fields to update","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleBulkUpdateResponse":{"value":[{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6243a80a\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-30T08:44:58+08:00","@noteid":6666,"@size":124,"@unid":"D2E9CF578D0B3844482588140043410F","@unread":true,"Color":"Purple","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","form":"TestForm"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6243a80a\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-30T08:44:58+08:00","@noteid":6670,"@size":124,"@unid":"05B08E4A7874C01E4825881400434111","@unread":true,"Color":"Purple","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","form":"TestForm"},{"@created":"2022-03-29T20:14:35+08:00","@etag":"W/\" 6243a80a\"","@lastaccessed":"2022-03-29T20:14:35+08:00","@lastmodified":"2022-03-30T08:44:58+08:00","@noteid":6674,"@size":124,"@unid":"D650B4BF0DE3BB714825881400434113","@unread":true,"Color":"Purple","Pet":"Bandicoot, long-nosed","email":"kaaronsohnf5@goo.ne.jp","form":"TestForm"}]}},"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Update result. Returns success / failure for each document"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Update multiple documents in a single call","tags":["data"],"x-keep-version":1},"summary":"Update multiple documents with a single call"},"/consent/revoke/{unid}":{"delete":{"description":"JSON element with consent values,","operationId":"deleteCurrUserConsent","parameters":[{"in":"path","name":"unid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentInfo"}}},"description":"Runtime info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Revoke a consent using the oauth's unid","tags":["admin"],"x-keep-scope":"ANY","x-keep-version":1}},"/consent/{client_id}":{"description":"Retrieves information about all of the currently-authenticated user's consents based from application id/client_id","get":{"description":"JSON element with consent values,","operationId":"getCurrUserConsent","parameters":[{"in":"path","name":"client_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"scope","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentInfo"}}},"description":"Runtime info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Get information about the currently-authenticated user's consents,","tags":["admin"],"x-keep-scope":"ANY","x-keep-version":1},"summary":"Retrieves information about of the currently-authenticated user's consents based from application id/client_id"},"/consents":{"delete":{"description":"Updates the revoke field of the oauth document.","operationId":"deleteCurrentUserConsents","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ConsentInfo"},"type":"array"}}},"description":"Runtime info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Revoke all of consents that a user has access to","tags":["admin"],"x-keep-scope":"ANY","x-keep-version":1},"description":"Operation on all of the consent's that a user have access to","get":{"description":"JSON element with consent data","operationId":"getCurrentUserConsents","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ConsentInfo"},"type":"array"}}},"description":"Runtime info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Get information about the currently-authenticated user's consents,","tags":["admin"],"x-keep-scope":"ANY","x-keep-version":1},"summary":"Operation on all of the consent's that a user have access to"},"/docmeta/{unid}":{"description":"Returns a document's form, creation date, update date, unid, nodeid. Mainly used in Foundry","get":{"description":"Retrieves document meta data including the form name","operationId":"getDocumentMetadata","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"customcontacts"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMeta"}}},"description":"Successful retrieval"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Retrieves document meta data including the form name","tags":["data"],"x-keep-version":1},"parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"customcontacts"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Universal Id of the document to be acted upon","examples":{"sample":{"value":"94CA3B3B5E035D6048258471003639C6"}},"in":"path","name":"unid","required":true,"schema":{"type":"string"}}],"summary":"Retrieves document meta data including the form name"},"/document":{"description":"Create a document in the database for a specified form. And it returns a NotesDocument object that represents the document.","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"The format RichText fields will be returned. The default if unspecified is mime.","in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}}],"post":{"description":"Create a new document for a specified form.","operationId":"createDocument","parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"UNID of an existing document, to make this a response document","in":"query","name":"parentUnid","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"createDocument":{"value":{"Color":"Red","Form":"Customer","Pet":"Black-capped chickadee","email":"gbranthwaite0@nba.com","first_name":"George","gender":"Male","ip_address":"91.254.204.27","last_name":"Branthwaite"}}},"schema":{"$ref":"#/components/schemas/DocumentSimpleRequest"}}},"description":"Document body in JSON format. Key/value pairs of fields and their values to update, 'Form' is required.\n","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"document":{"value":{"@meta":{"addedtofile":"2022-10-13T13:41:30.68+08:00","created":"2022-10-13T13:41:30.64+08:00","lastaccessed":"2022-10-13T13:41:30.68+08:00","lastmodified":"2022-10-13T13:41:30.68+08:00","lastmodifiedinfile":"2022-10-13T13:41:30.69+08:00","noteclass":["DATA","DOCUMENT"],"noteid":44026,"revision":"00000001001F442C482588DA","size":570,"unid":"1C62D55D75387684482588DA001F4428","unread":true},"Color":"Red","Form":"Customer","Pet":"Black-capped chickadee","email":"gbranthwaite0@nba.com","first_name":"George","gender":"Male","ip_address":"91.254.204.27","last_name":"Branthwaite"}}},"schema":{"$ref":"#/components/schemas/DominoDocument"}}},"description":"Successful creation"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Create a new document for a specified form.","tags":["data"],"x-keep-version":1},"summary":"Create a document in the database for a specified form. And it returns a NotesDocument object that represents the document."},"/document/{unid}":{"delete":{"description":"Delete the given document","operationId":"deleteDocument","responses":{"200":{"content":{"application/json":{"examples":{"success":{"value":{"message":"deletion complete","status":"OK","statusCode":200,"unid":"61CCE871E79E8DDB8025852F004DFF2D"}}},"schema":{"$ref":"#/components/schemas/StatusMessage"}}},"description":"Returns data from the document"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Delete the given document","tags":["data"],"x-keep-version":1},"description":"Update access to a document will typically restrict which fields on the document can be changed.\n\nModes are used to define statuses for a document, and will a definition identifying which fields can be seen and changed. A patch request that includes fields outside those restrictions will throw a 400 error (bad request), specifying which fields are illegal or missing.","get":{"description":"Retrieve a given document at its appropriate mode","operationId":"getDocument","parameters":[{"description":"Mark the document as read by the current user when the operation completes","in":"query","name":"markRead","schema":{"type":"boolean"}},{"description":"Mark the document as unread by the current user when the operation completes","in":"query","name":"markUnread","schema":{"type":"boolean"}},{"description":"Scope name","examples":{"CustomApp":{"value":"customcontacts"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Should a document be computed with its form's \"Default Value\", \"Input Translation\" and \"Input Validation\" formulas before retrieval","examples":{"compute":{"value":"true"}},"in":"query","name":"computeWithForm","schema":{"type":"boolean"}},{"description":"The format RichText fields will be returned. The default if unspecified is html.","examples":{"RichTextAsMime":{"value":"mime"}},"in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}},{"description":"When set to false, all metadata Json items on the top level of an object get suppressed.\nDefault is true","in":"query","name":"meta","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"document":{"value":{"@meta":{"addedtofile":"2022-10-13T13:41:30.68+08:00","created":"2022-10-13T13:41:30.64+08:00","lastaccessed":"2022-10-13T13:41:30.68+08:00","lastmodified":"2022-10-13T13:41:30.68+08:00","lastmodifiedinfile":"2022-10-13T13:41:30.69+08:00","noteclass":["DATA","DOCUMENT"],"noteid":44026,"revision":"00000001001F442C482588DA","size":570,"unid":"1C62D55D75387684482588DA001F4428","unread":true},"Color":"Red","Form":"Customer","Pet":"Black-capped chickadee","email":"gbranthwaite0@nba.com","first_name":"George","gender":"Male","ip_address":"91.254.204.27","last_name":"Branthwaite"}}},"schema":{"$ref":"#/components/schemas/DominoDocument"}}},"description":"Successful retrieval"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"406":{"$ref":"#/components/responses/406NotAcceptable"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Retrieve a given document at its appropriate mode","tags":["data"],"x-keep-version":1},"parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"customcontacts"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Universal Id of the document to be acted upon","examples":{"sample":{"value":"94CA3B3B5E035D6048258471003639C6"}},"in":"path","name":"unid","required":true,"schema":{"type":"string"}},{"description":"mode to perform the document access in. Defaults to 'default' if missing. All lowercase, no spaces, letters and numbers only","examples":{"ForApprover":{"value":"approver"},"defaultValue":{"value":"default"}},"in":"query","name":"mode","required":false,"schema":{"type":"string"}}],"patch":{"description":"Provide a JSON structure that is a subset of the document items.\nitems not mentioned stay untouched, items with null values are removed","operationId":"patchDocument","parameters":[{"description":"Mark the document as unread by the current user when the operation completes","in":"query","name":"markUnread","schema":{"type":"boolean"}},{"description":"The format RichText fields will be returned. The default if unspecified is html.","examples":{"RichTextAsMime":{"value":"mime"}},"in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}},{"description":"This field records the current revision version of document. It's a 32-character hex-encoded string of date. \n\nIf db config \"requireRevisionToUpdate\" is enabled, then revision is required when update document and only update document when revision version is right.","examples":{"revisionSample":{"value":"26372571825596dc0db73d0eacf1eacb"}},"in":"query","name":"revision","schema":{"type":"string"}},{"description":"UNID of an existing document, to make this a response document","in":"query","name":"parentUnid","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSimpleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleUpdateDocument":{"value":{"@meta":{"addedtofile":"2022-10-13T13:41:30.68+08:00","created":"2022-10-13T13:41:30.64+08:00","lastaccessed":"2022-10-13T13:41:30.68+08:00","lastmodified":"2022-10-13T13:41:30.68+08:00","lastmodifiedinfile":"2022-10-13T13:41:30.69+08:00","noteclass":["DATA","DOCUMENT"],"noteid":44026,"revision":"00000001001F442C482588DA","size":570,"unid":"1C62D55D75387684482588DA001F4428","unread":true},"Color":"Red","Form":"Customer","Pet":"Black-capped chickadee","email":"gbranthwaite0@nba.com","first_name":"George","gender":"Male","ip_address":"91.254.204.27","last_name":"Branthwaite"}}},"schema":{"$ref":"#/components/schemas/DominoDocument"}}},"description":"Successful mode operation"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Perform a document update on only the fields you specify in the request.","tags":["data"],"x-keep-version":1},"put":{"description":"Perform an update on the document at the relevant mode","operationId":"updateDocument","parameters":[{"description":"Mark the document as unread by the current user when the operation completes","in":"query","name":"markUnread","schema":{"type":"boolean"}},{"description":"The format RichText fields will be returned. The default if unspecified is html.","examples":{"RichTextAsMime":{"value":"mime"}},"in":"query","name":"richTextAs","schema":{"$ref":"#/components/schemas/RichTextRepresentation"}},{"description":"This field records the current revision version of document. It's a 32-character hex-encoded string of date. \n\nIf db config \"requireRevisionToUpdate\" is enabled, then revision is required when update document and only update document when revision version is right.","examples":{"revisionSample":{"value":"26372571825596dc0db73d0eacf1eacb"}},"in":"query","name":"revision","schema":{"type":"string"}},{"description":"UNID of an existing document, to make this a response document","in":"query","name":"parentUnid","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UpdateDocument":{"value":{"Color":"Puce","Form":"TestForm","Pet":"Black-capped chickadee","email":"mbranthwaite0@nba.com","first_name":"Madison","gender":"Female","ip_address":"91.254.204.27","last_name":"Branthwaite"}}},"schema":{"$ref":"#/components/schemas/DocumentSimpleRequest"}}},"description":"Key/value pairs of fields and their values to update. Some modes may not allow any editable fields, in which case an empty JSON object should be passed. 'Form' is required.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"SampleUpdateDocument":{"value":{"@meta":{"addedtofile":"2022-10-13T13:41:30.68+08:00","created":"2022-10-13T13:41:30.64+08:00","lastaccessed":"2022-10-13T13:41:30.68+08:00","lastmodified":"2022-10-13T13:41:30.68+08:00","lastmodifiedinfile":"2022-10-13T13:41:30.69+08:00","noteclass":["DATA","DOCUMENT"],"noteid":44026,"revision":"00000001001F442C482588DA","size":570,"unid":"1C62D55D75387684482588DA001F4428","unread":true},"Color":"Red","Form":"Customer","Pet":"Black-capped chickadee","email":"gbranthwaite0@nba.com","first_name":"George","gender":"Male","ip_address":"91.254.204.27","last_name":"Branthwaite"}}},"schema":{"$ref":"#/components/schemas/DominoDocument"}}},"description":"Successful mode operation"},"400":{"$ref":"#/components/responses/400BadRequest"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Perform an update on the document at the relevant mode","tags":["data"],"x-keep-version":1},"summary":"Actions on a document at a specific mode"},"/documentmodes/{unid}":{"description":"Returns a JSON object of all the modes schemas available for the Form tied to this document.\n\nPeople can configure many different modes which have different fields with Read/Write/Both permission.","get":{"description":"Returns the modes available and fields that can be edited","operationId":"getDocumentFormModes","responses":{"200":{"content":{"application/json":{"examples":{"sampleMode":{"value":[{"computeWithForm":false,"deleteAccessFormula":{"formula":"@False","formulaType":"domino"},"fields":[],"modeName":"default","onLoad":{"formula":"","formulaType":"domino"},"onSave":{"formula":"","formulaType":"domino"},"readAccessFields":[],"readAccessFormula":{"formula":"@True","formulaType":"domino"},"required":[],"validationRules":[],"writeAccessFields":[],"writeAccessFormula":{"formula":"@True","formulaType":"domino"}},{"computeWithForm":false,"deleteAccessFormula":{"formula":"@False","formulaType":"domino"},"fields":[{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"email","summaryField":true,"type":"string","uniqueitems":false},{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"name","summaryField":true,"type":"string","uniqueitems":false},{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"newField","summaryField":true,"type":"array","uniqueitems":false}],"modeName":"odata","onLoad":{"formula":"","formulaType":"domino"},"onSave":{"formula":"","formulaType":"domino"},"readAccessFields":[{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"email","summaryField":true,"type":"string","uniqueitems":false},{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"name","summaryField":true,"type":"string","uniqueitems":false},{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"newField","summaryField":true,"type":"array","uniqueitems":false}],"readAccessFormula":{"formula":"@True","formulaType":"domino"},"required":[],"validationRules":[],"writeAccessFields":[{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"email","summaryField":true,"type":"string","uniqueitems":false},{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"name","summaryField":true,"type":"string","uniqueitems":false},{"exclusiveMinimum":-1,"fieldAccess":"RW","format":"string","itemFlags":["SUMMARY"],"maxLength":-1,"maximum":0,"minLenght":-1,"minimum":0,"minitems":-1,"name":"newField","summaryField":true,"type":"array","uniqueitems":false}],"writeAccessFormula":{"formula":"@True","formulaType":"domino"}}]}},"schema":{"items":{"$ref":"#/components/schemas/KeepFormMode"},"type":"array"}}},"description":"Modes available and details. **Response format TBA**"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"}},"security":[{"jwt":[]}],"summary":"Returns the modes available and fields that can be edited","tags":["data"],"x-keep-version":1},"parameters":[{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"Universal Id of the document to be acted upon","examples":{"sample":{"value":"94CA3B3B5E035D6048258471003639C6"}},"in":"path","name":"unid","required":true,"schema":{"type":"string"}}],"summary":"Provides information of all enabled modes for the relevant document"},"/info":{"description":"Will return Domino and Domino REST API Version\nFor more complete information use the management endpoints typically port 8889","get":{"description":"JSON element with basic version information","operationId":"getInfo","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeepInfo"}}},"description":"Runtime info"},"401":{"$ref":"#/components/responses/401Unauthorized"},"500":{"$ref":"#/components/responses/500InternalServerError"}},"security":[{"jwt":[]}],"summary":"Get information about Domino and Domino REST API Version","tags":["admin"],"x-keep-scope":"ANY","x-keep-version":1},"summary":"Provides basic information about the Domino REST API and Domino runtime"},"/lists":{"description":"Provides the lists (views/folders) present in a database","get":{"description":"Uses db.getViews() and filters out excluded views","operationId":"fetchViews","parameters":[{"description":"Allows to specify views, folders, all\nTODO: categorized / calendar distinction?","in":"query","name":"type","schema":{"enum":["all","folders","views"],"type":"string"}},{"description":"Scope name","examples":{"CustomApp":{"value":"demo"},"Directory":{"value":"dominodirectory"}},"in":"query","name":"dataSource","required":true,"schema":{"type":"string"}},{"description":"When set to true, column information gets returned. Use with caution, slows down the API","in":"query","name":"columns","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"lists":{"value":[{"alias":[],"isFolder":false,"title":"($All)","unid":"0E35D520A1EBBB5B48258