Documents
Documents
[PUT] /api/v2/common/documents/{id}/thumbnails/upload
Upload documents thumbnail.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[DELETE] /api/v2/common/documents/{id}/thumbnails
Delete specified document thumbnail.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[PUT] /api/v2/common/documents/{id}/referenced-documents/update
Updates documents that depend on the specified document to reference the latest version of the specified document.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Specified document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[DELETE] /api/v2/common/documents/{id}/delete
Delete document.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Request Schema
DocumentModel+DocumentDeleteRequestModel
Response
Status Code: 200
Success
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[DELETE] /api/v2/common/documents/batch-delete
Batch delete documents.
Request Schema
DocumentModel+BatchDeleteDocumentsRequestModel
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/common/documents/{id}/restore
Restore document.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[POST] /api/v2/common/documents/batch-restore
Batch restore documents.
Request Schema
DocumentModel+BatchRestoreDocumentsRequestModel
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[PUT] /api/v2/common/documents/{id}/properties/update
Update document properties
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Request Schema
DocumentModel+DocumentPropertyRequestModel
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/common/documents/batch-hide-in-document-portal
Batch hide document in document portal.
Request Schema
DocumentModel+BatchHideDocumentInDocumentPortalRequestModel
Response
Status Code: 200
Success
BatchHideDocumentInDocumentPortalReponseModel
Status Code: 400
Bad Request
[POST] /api/v2/common/documents/{id}/duplicate
duplicate document. use range: data model, dataset, report, dashboard, language resource.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
Request Schema
DocumentModel+CopyDocumentRequestModel
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/common/documents/{id}/document-translate-titles
Update document translate title
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/common/documents/{id}/document-translate-titles
Get document all translate title
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/common/documents/{id}/document-translate-titles/{languageCode}
Get document translate title by language code
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | |
languageCodeRequired | string | path | language code. For example: EN |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/admin/export
Export documents with their references.
Request Schema
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
[POST] /api/v2/admin/import
Import documents.
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[PUT] /api/v2/documents/{id}/permission
Update document permission
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id |
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/documents/permission/batch-update
Batch change documents permission
Request Schema
BatchChangePermissionRequestModel
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/documents/{id}/permission/apply-min-needed-permission
Grant min needed permission to the referenced documents of the current document
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id |
Request Schema
MinNeededPermissionRequestModel
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/documents/permission/batch-apply-min-needed-permission
Batch grant min needed permission to the referenced documents of the current documents
Request Schema
BatchApplyMinNeededPermissionRequestModel
Response
Status Code: 200
Success
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/common/resources/download
Batch download resources.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
ids | string | query | Document ids. For example: ["F00FC3E6-8554-467D-9A7E-4598E623BB2F", "8259E551-5AFB-489E-8593-0FD6384E123B"] |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
[GET] /api/v2/common/resources/{id}/download
Get resources.
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | Document id. For example: 1E5D7247-450E-4383-B0DD-09D5CF651907 |
rev | int32 | query | Document revision. For example: null or 1 |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/common/documents/upload
Upload file.
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Models
Ƭ ThumbnailUploadResponseModel
Represent the upload document thumbnail response model.
Name | Type | Description | Example |
---|---|---|---|
thumbnailUrlNullable | string | Document thumbnail url. |
Ƭ ServerPluginError
Server plugin error
Name | Type | Description | Example |
---|---|---|---|
codeNullable | string | error code | |
messageNullable | string | error message | |
contextNullable | string | error context | |
innerError | ServerPluginError |
Ƭ DocumentResponseModel
Document response model
Name | Type | Description | Example |
---|---|---|---|
documentIdNullable | string | Document id | |
titleNullable | string | Document title | |
fileExtNullable | string | Document file extension | |
contentTypeNullable | string | Document content type | |
creatorNameNullable | string | Document creator name | |
modifierNameNullable | string | Document modifier name | |
deleterNameNullable | string | Document deleter name | |
descriptionNullable | string | Document description | |
isSystemReservedNullable | Boolean | Whether document is system reserved | |
isResource | Boolean | Whether document is resource | |
hideOnMobileNullable | Boolean | Hide document on mobile | |
metaNullable | string | Document meta | |
hideInDocumentPortalNullable | Boolean | Hide document in document portal | |
organizationIdNullable | string | Document organization id | |
organizationIdPathNullable | string | Document organization id path | |
thumbnailNullable | string | Document thumbnail | |
schemaVersionNullable | string | Document schema version |
Ƭ DocumentModel+DocumentDeleteRequestModel
Document delete information
Name | Type | Description | Example |
---|---|---|---|
force | Boolean | Whether force delete document | true |
permanent | Boolean | Whether delete document permanently | true |
Ƭ DocumentModel+BatchDeleteDocumentsRequestModel
Document information with batch delete
Name | Type | Description | Example |
---|---|---|---|
documentIds | Array<string> |
Batch operate document ids | ["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"] |
force | Boolean | Whether force delete document | |
permanent | Boolean | Whether delete document permanently |
Ƭ DocumentModel+BatchRestoreDocumentsRequestModel
Document information with batch restore
Name | Type | Description | Example |
---|---|---|---|
documentIds | Array<string> |
Batch operate document ids | ["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"] |
Ƭ DocumentModel+DocumentPropertyRequestModel
Document property
Name | Type | Description | Example |
---|---|---|---|
newNameNullable | string | New document name | "newDocument" |
metaNullable | string | Document meta | "DSC_PROVIDER=CSV" |
descriptionNullable | string | Document description | "Document Description" |
fontOriginalNameNullable | string | Font document original name | "Oswald" |
hideOnMobileNullable | Boolean | Whether hide the document on mobile | |
hideInDocumentPortalNullable | Boolean | Whether hide the document in document portal |
Ƭ BatchHideDocumentInDocumentPortalReponseModel
Batch hide documents in document portal
Name | Type | Description | Example |
---|---|---|---|
updated_Document_IdsNullable | Array<string> |
Updated document ids. | |
updated_Failed_DocumentsNullable | UpdateFailedInfo | Update failed documents. |
Ƭ UpdateFailedInfo
update hide document failed information
Name | Type | Description | Example |
---|---|---|---|
documentIdsNullable | Array<string> |
Document id list | |
error | ServerPluginError |
Ƭ DocumentModel+BatchHideDocumentInDocumentPortalRequestModel
Document information with batch hide in document portal
Name | Type | Description | Example |
---|---|---|---|
documentIds | Array<string> |
Batch operate document ids | ["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"] |
hideInDocumentPortal | Boolean | Whether hide document in document portal |
Ƭ DocumentModel+CopyDocumentRequestModel
Copy document basic information
Name | Type | Description | Example |
---|---|---|---|
newDocName | string | New document name | "newDocumentName" |
currentTagIdNullable | string | Current tag id | "D01EF9CA-48A2-4ABA-B54E-AD9DA89955F3" |
copyAsTemplate | Boolean | Whether copy the document as a template, use range: report document. |
Ƭ DocumentTranslateTitleRequest
Translate title's Languagecode and title model
Name | Type | Description | Example |
---|---|---|---|
translateTitles | DocumentTranslateTitleItem | Translate title's Languagecode and title list |
Ƭ DocumentTranslateTitleItem
Document tanslate title
Name | Type | Description | Example |
---|---|---|---|
languageCode | string | Language code | "EN" |
titleNullable | string | Document translate title | "Translate title" |
isDefault | Boolean | Is default title, same with orginal document name |
Ƭ DocumentTranslateTitle
Name | Type | Description | Example |
---|---|---|---|
docIdNullable | string | ||
languageCodeNullable | string | ||
titleNullable | string | ||
isDefault | Boolean |
Ƭ ExportRequestModel
Represent an export model.
Name | Type | Description | Example |
---|---|---|---|
items | ExportItemModel | The need to be exported items. | |
includeDocumentPermissions | Boolean | Whether include the document's permissions when exporting documents, the default value is false. | true |
excludeReferenceDocumentTypesNullable | Array<string> |
The document types of the referenced documents that are not allowed to be exported, it has a higher priority than the parameter 'IncludeReferenceDocumentTypes'. |
["dst","dbd"] |
includeReferenceDocumentTypesNullable | Array<string> |
The document types of the referenced documents that are allowed to be exported, it has a lower priority than the parameter 'ExcludeReferenceDocumentTypes'. |
["dst","dbd"] |
Ƭ ExportItemModel
Represent an export item model.
Name | Type | Description | Example |
---|---|---|---|
type | string | The type of the items that need to be exported, the valid types are: "$$documents" -> documents, "sys-conf-ui" -> UI settings, "sys-cat" -> categories, "sys-clp" -> custom language packages, "sys-ctheme" -> custom themes, "sys-et" -> export templates, "sys-role" -> roles, "sys-st" -> schedule templates, "sys-secprovider" -> security providers, "sys-secset" -> security settings, "sys-uf" -> user functions, "sys-conf-wq" -> worker queue settings, "auditLogConfiguration" -> audit log settings, "sys-conf-dashboard-common" -> dashboard common settings, "sys-conf-dashboard-designer" -> dashboard designer settings, "sys-conf-dashboard-view" -> dashboard view settings, "sys-conf-ddt" -> default document theme, "sys-conf-es" -> email settings, "sys-conf-rs" -> report settings, "sys-conf-ss" -> schedule settings, |
"sys-conf-ui" |
items | Array<string> |
Get or set items need to be exported. | ["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"] |
Ƭ ImportResult
Represent an import result model.
Name | Type | Description | Example |
---|---|---|---|
documentsNullable | DocumentImportResult | Get or set imported documents. | |
settingsNullable | UploadSetting | Get or set imported settings. |
Ƭ DocumentImportResult
Represent an document import result model.
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | Get or set document import result. | |
operation | DocumentOperation | ||
error | ImportError | ||
document | UploadDocument |
Ƭ UploadSetting
Represent an upload setting model.
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | Get or set the setting name. | |
typeNullable | string | Get or set the setting type. |
Ƭ DocumentOperation
Enum:
Add
Update
Ignore
Upgrade
Enumeration of import document operation types.
* Add
- 0 - Add document.
* Update
- 1 - Update document.
* Ignore
- 3 - Ignore document.
* Upgrade
- 4 - Upgrade docuemnt.
Ƭ ImportError
Name | Type | Description | Example |
---|---|---|---|
errorCode | int32 | ||
errorTextNullable | string | ||
contextNullable | any |
Ƭ UploadDocument
Represent an upload document model.
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | Get or set the document id. | |
titleNullable | string | Get or set the document title. | |
documentTypeNullable | string | Get or set the document type. | |
fileExtNullable | string | Get or set the document file ext. | |
contentTypeNullable | string | Get or set the document content type. | |
createdByNullable | string | Get or set the document creator. | |
modifiedByNullable | string | Get or set the document editor. | |
createdNullable | ISO DateTime Sting | Get or set the document creation time. | |
modifiedNullable | ISO DateTime Sting | Get or set the document modification time. |
Ƭ PermissionRequestModel
Permission request model
Name | Type | Description | Example |
---|---|---|---|
grantCollectionNullable | AccessEntryStringDto | The collection of permissions to be granted | |
revokeCollectionNullable | AccessEntryStringDto | The collection of permissions to be revoked |
Ƭ AccessEntryStringDto
Access entry string Dto
Name | Type | Description | Example |
---|---|---|---|
roleNullable | string | Role name | "Tester" |
opsNullable | Array<string> |
Operations: / Execute: ["Execute"] / Read: ["Execute", "Read"] / Write: ["Execute", "Read", "Update"] | ["Execute","Read","Update"] |
Ƭ BatchChangePermissionRequestModel
Batch chage document permission request model
Name | Type | Description | Example |
---|---|---|---|
documentIdsNullable | Array<string> |
Document ids of change permission. | ["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"] |
operationTypeNullable | string | Operation type(AddNew/RemoveExisting/RemoveExistingAndAddNew) | "AddNew" |
grantCollectionNullable | AccessEntryStringDto | The collection of permissions to be granted. |
Ƭ MinNeededPermissionRequestModel
Grant min needed permission to the referenced documents of the current document request model
Name | Type | Description | Example |
---|---|---|---|
roleNullable | string | Role name | "Tester" |
Ƭ BatchApplyMinNeededPermissionRequestModel
Batch grant min needed permission to the referenced documents of the current documents request model
Name | Type | Description | Example |
---|---|---|---|
documentIdsNullable | Array<string> |
Document ids | ["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"] |
roleNamesNullable | Array<string> |
Role names | ["Tester","Viewer"] |
Ƭ QueueStatsResponseModel
Represent a queue statistical response model.
Name | Type | Description | Example |
---|---|---|---|
workersNullable | WorkerInfo | Get or set worker info list. | |
tasksNullable | CommonTaskInfo | Get or set task info list. |
Ƭ WorkerInfo
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
urlNullable | string | ||
lastSeen | ISO DateTime Sting | ||
tasksInProgress | int32 | ||
displayNameNullable | string | ||
specializationsNullable | Array<string> |
Ƭ CommonTaskInfo
Represent a common task info response model.
Name | Type | Description | Example |
---|---|---|---|
taskID | TaskID | ||
workerUrlNullable | string | Get or set worker url. | |
workerIDNullable | string | Get or set worker id. | |
initiatorNullable | string | Get or set task initiator. | |
documentNameNullable | string | Get or set document name. | |
documentIdNullable | string | Get or set document id. | |
documentTypeNullable | string | Get or set document type. | |
startTime | ISO DateTime Sting | Get or set task start time. | |
endTimeNullable | ISO DateTime Sting | Get or set task end time. | |
progressNullable | string | Get or set task progress. | |
errorMessageNullable | string | Get or set task error message. | |
descriptionNullable | string | Get or set task description. | |
breakStatus | CommonTaskInfo+TaskStatus | ||
status | CommonTaskInfo+TaskStatus | ||
type | CommonTaskInfo+TaskType |
Ƭ TaskID
Name | Type | Description | Example |
---|---|---|---|
parent | TaskID | ||
idNullable | string |
Ƭ CommonTaskInfo+TaskStatus
Enum:
NotStarted
WaitingForActivation
WaitingToRun
Started
ReadingResult
Verifying
Canceled
Failed
Finished
Enumeration of task status
* NotStarted
- 0 - Not started.
* WaitingForActivation
- 1 - Waiting for activation.
* WaitingToRun
- 2 - Waiting to run.
* Started
- 3 - Started.
* ReadingResult
- 4 - Reading result.
* Verifying
- 5 - Verifying.
* Canceled
- 6 - Canceled.
* Failed
- 7 - Failed.
* Finished
- 8 - Finished.
Ƭ CommonTaskInfo+TaskType
Enum:
Queue
Scheduler
Enumeration of task types.
* Queue
- 0 - Queue task.
* Scheduler
- 1 - Scheduler task.