@dynatrace-sdk/client-document v1.7.0
@dynatrace-sdk/client-document
Overview
This API allows you to create and manage documents, as well as manage access to your documents via shares.
Have a look at the service documentation to familiarize yourself with its key concepts.
Note, that the document's content is not inspected by the document-store, therefore it can be entirely schemaless. If your content adheres to a schema, it's your responsibility to enforce that.
Information about authorization can be found here.
Document Sharing
By default, documents are only accessible to their owner. To enable collaboration with other users, you can share the documents with other users.
There are 2 ways of sharing documents.
Environment-Shares allow to share a document with potentially all users in the environment. The owner effectively loses control over who exactly gains access, as any user can claim the share and therefore receive access.
Direct-Shares allow to share a document with specific users and groups. The owner is in total control of who exactly receives access, and can also revoke access retrospectively.
The sharing mechanisms are not mutually exclusive - a document can be shared via multiple sharing mechanisms at the same time.
Document Locking
Document locking can be optionally utilized to prevent conflicts caused by multiple users concurrently updating the same document.
The user can lock a document to prevent other users from updating the document for some time.
Once the user is done updating the document, they can release the lock and therefore enable updates by other users.
Deletion & Restoration
Deleted documents are moved to the trash and permanently deleted after 30 days.
The Trash API can be used to manage deleted documents.
Restoring a deleted document makes the document accessible again for the owner as well as all users who had previously received access via shares.
Installation
npm install @dynatrace-sdk/client-documentAPI reference
Full API reference for this SDK is available at Dynatrace Developer.
Getting help
- Visit SDK for Typescript guide in the Dynatrace Developer
- Ask a question in the Dynatrace Community
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.