{"name":"dataroom","stage":"ga","description":"Package dataroom is a secure document room you share by link and watch page by page.","operations":[{"operationId":"get_dataroom_analytics_dataroom_by_dataroomid","method":"GET","href":"/v1/dataroom/analytics/dataroom/{dataroomId}","summary":"Rolls up every share link pointing at one data room: session and page-view totals for the room, plus the per-page breakdown for each link beneath it."},{"operationId":"get_dataroom_analytics_link_by_linkid","method":"GET","href":"/v1/dataroom/analytics/link/{linkId}","summary":"Reports how one share link was actually read: total viewing sessions, total page views, and per page the view count, the summed dwell measure and its average."},{"operationId":"get_dataroom_datarooms","method":"GET","href":"/v1/dataroom/datarooms","summary":"Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps."},{"operationId":"post_dataroom_datarooms","method":"POST","href":"/v1/dataroom/datarooms","summary":"Opens a new data room for the caller org and answers with it, including the short public id it is addressed by."},{"operationId":"get_dataroom_datarooms_by_id","method":"GET","href":"/v1/dataroom/datarooms/{id}","summary":"Reads one of the caller org's data rooms together with every document in it, each carrying its membership id and order index."},{"operationId":"post_dataroom_datarooms_by_id_documents","method":"POST","href":"/v1/dataroom/datarooms/{id}/documents","summary":"Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id."},{"operationId":"get_dataroom_documents","method":"GET","href":"/v1/dataroom/documents","summary":"Returns every document in the caller org's own store, newest first — name, opaque storage key, content type, page count, size and timestamps."},{"operationId":"post_dataroom_documents","method":"POST","href":"/v1/dataroom/documents","summary":"Upload a document's bytes and record it"},{"operationId":"get_dataroom_documents_by_id","method":"GET","href":"/v1/dataroom/documents/{id}","summary":"Reads one of the caller org's documents — its name, opaque storage key, content type, page count, size and timestamps."},{"operationId":"get_dataroom_documents_by_id_file","method":"GET","href":"/v1/dataroom/documents/{id}/file","summary":"Download a document's bytes as its owner"},{"operationId":"get_dataroom_health","method":"GET","href":"/v1/dataroom/health","summary":"Reports that the data room subsystem is up."},{"operationId":"get_dataroom_links","method":"GET","href":"/v1/dataroom/links","summary":"Returns every live share link in the caller org's own store, newest first, with the controls a visitor will meet: whether an address is required, whether a password is set, the allow and deny lists, whether download is permitted, and when the link expires."},{"operationId":"post_dataroom_links","method":"POST","href":"/v1/dataroom/links","summary":"Grants access: it mints a public share link over one data room (`dataroomId`) or one document (`documentId`) — one of the two is required — and answers with the link, whose `id` is the token a visitor opens it with."},{"operationId":"get_dataroom_trust","method":"GET","href":"/v1/dataroom/trust","summary":"Answers the caller org's OWN trust centre: its settings, every item it holds in both tiers, the requests waiting on it, and the grants it has made."},{"operationId":"put_dataroom_trust","method":"PUT","href":"/v1/dataroom/trust","summary":"SetCenter opens, publishes or withdraws the caller org's trust centre and answers with the centre as it now stands."},{"operationId":"post_dataroom_trust_artifacts","method":"POST","href":"/v1/dataroom/trust/artifacts","summary":"Puts an item on the caller org's trust centre and answers with it."},{"operationId":"patch_dataroom_trust_artifacts_by_id","method":"PATCH","href":"/v1/dataroom/trust/artifacts/{id}","summary":"Changes an item on the caller org's trust centre — replace its file with a newer edition, move it between public and gated, rewrite what it says, or retire it — and answers with the item as it now stands."},{"operationId":"get_dataroom_trust_center_by_slug","method":"GET","href":"/v1/dataroom/trust/center/{slug}","summary":"Answers an org's public trust centre: its name, the text a party must accept to ask for a document, and every item it publishes."},{"operationId":"get_dataroom_trust_center_by_slug_file_by_item","method":"GET","href":"/v1/dataroom/trust/center/{slug}/file/{item}","summary":"Read a public trust-centre item's bytes"},{"operationId":"post_dataroom_trust_center_by_slug_requests","method":"POST","href":"/v1/dataroom/trust/center/{slug}/requests","summary":"Records a request to read what an independent auditor signed, and answers with its id."},{"operationId":"post_dataroom_trust_requests_by_id_grant","method":"POST","href":"/v1/dataroom/trust/requests/{id}/grant","summary":"Answers a request by opening access: it mints a share link over what was asked for, addressed to the address that asked and closing at expiry, records the decision, and mails the asker."},{"operationId":"post_dataroom_trust_requests_by_id_refuse","method":"POST","href":"/v1/dataroom/trust/requests/{id}/refuse","summary":"Answers a request by declining it, recording who declined and why."},{"operationId":"get_dataroom_view_by_linkid","method":"GET","href":"/v1/dataroom/view/{linkId}","summary":"What a share link's visitor sees before authenticating"},{"operationId":"post_dataroom_view_by_linkid_authenticate","method":"POST","href":"/v1/dataroom/view/{linkId}/authenticate","summary":"Pass a share link's gates and open a viewing session"},{"operationId":"get_dataroom_view_by_linkid_document_by_documentid_file","method":"GET","href":"/v1/dataroom/view/{linkId}/document/{documentId}/file","summary":"Read a document's bytes as an authorised link visitor"},{"operationId":"post_dataroom_view_by_linkid_pageview","method":"POST","href":"/v1/dataroom/view/{linkId}/pageview","summary":"Record one page-view against an open viewing session"}],"_links":{"describedby":{"href":"/v1/openapi.json?capability=dataroom"},"self":{"href":"/v1/dataroom"},"up":{"href":"/v1"}}}