get_doc_folder_list
Get all document folders visible to the current user.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofDataDocFolder objects with folder details including ID, name, color, and access restrictions.
get_doc_folder
Get a document folder by its identifier.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | The folder ID. Use get_doc_folder_list. |
Returns
ADataDocFolder with folder details.
create_doc_folder
Create a new document folder.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
model | DataDocFolder | Yes | Folder object with name, color, and optional access restrictions. |
Returns
The createdDataDocFolder.
update_doc_folder
Update a document folder: name, color, access restrictions, archived status.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | The folder ID. Use get_doc_folder_list. |
model | DataDocFolder | Yes | Folder object with updated fields. |
Returns
No content on success.delete_doc_folder
Delete a document folder.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | The folder ID. Use get_doc_folder_list. |
Returns
No content on success.get_doc_list
Get all documents in a specific folder, filtered by user permissions.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | The folder ID. Use get_doc_folder_list. |
Returns
A list ofDataDoc objects with document details including ID, name, folder assignment, context links, and access restrictions.
get_doc
Get a document by its identifier.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
docId | string | Yes | The document ID. Use get_doc_list. |
Returns
ADataDoc with document details.
create_doc
Create a new document in a folder.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
model | DataDoc | Yes | Document object with name, folder ID, context links, and optional access restrictions. |
Returns
The createdDataDoc.
update_doc
Update a document: name, context links, access restrictions, archived status.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
docId | string | Yes | The document ID. Use get_doc_list. |
model | DataDoc | Yes | Document object with updated fields. |
Returns
No content on success.delete_doc
Delete a document.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
docId | string | Yes | The document ID. Use get_doc_list. |
Returns
No content on success.get_doc_content
Get the content body of a document.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
docId | string | Yes | The document ID. Use get_doc_list. |
Returns
ADataDocContent object with the document’s body content.
update_doc_content
Update the content body of a document.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
docId | string | Yes | The document ID. Use get_doc_list. |
model | DataDocContent | Yes | Content object with the updated body text. |