Delete Document
Purpose
To delete a particular document in Zoho Writer through a unique document id.
HTTP Request URL
https://{api.office-integrator_domain}/writer/officeapi/v1/documents/<document_id>?apikey=<apikey>
Request Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
apikey | String | Uniquely identifies the web application in which the Writer editor is integrated. |
document_id | String | Unique id of the document to be deleted. |
Note:
Users can find the 'document_id' (it is the key value which you pass inside 'document_info' parameter) in all Zoho Writer API responses. For example, the "document_id" is captured as part of the response and can be seen in Preview, Edit and Co-edit APIs.
Sample Request
Copiedhttps://api.office-integrator.com/writer/officeapi/v1/documents/d26aa7b8029bf4f8d34c7dd00139392357d12ffcb21c1?apikey=423s*****
Copiedconst Levels = require("zoi-nodejs-sdk/routes/logger/logger").Levels;
const Constants = require("zoi-nodejs-sdk/utils/util/constants").Constants;
const APIKey = require("zoi-nodejs-sdk/models/authenticator/apikey").APIKey;
const Environment = require("zoi-nodejs-sdk/routes/dc/environment").Environment;
const LogBuilder = require("zoi-nodejs-sdk/routes/logger/log_builder").LogBuilder;
const UserSignature = require("zoi-nodejs-sdk/routes/user_signature").UserSignature;
const InitializeBuilder = require("zoi-nodejs-sdk/routes/initialize_builder").InitializeBuilder;
const CreateDocumentParameters = require("zoi-nodejs-sdk/core/com/zoho//officeintegrator/office_integrator_sdk/create_document_parameters").CreateDocumentParameters;
const OfficeIntegratorSDKOperations = require("zoi-nodejs-sdk/core/com/zoho//officeintegrator/office_integrator_sdk/office_integrator_sdk_operations").OfficeIntegratorSDKOperations;
const DocumentDeleteSuccessResponse = require("zoi-nodejs-sdk/core/com/zoho//officeintegrator/office_integrator_sdk/document_delete_success_response").DocumentDeleteSuccessResponse;
const InvaildConfigurationException = require("zoi-nodejs-sdk/core/com/zoho//officeintegrator/office_integrator_sdk/invaild_configuration_exception").InvaildConfigurationException;
class DeleteDocument {
//Include zoi-nodejs-sdk package in your package json and the execute this code.
static async initializeSdk() {
let user = new UserSignature("john@zylker.com");
let environment = new Environment("https://api.office-integrator.com", null, null);
let apikey = new APIKey("2ae438cf864488657cc9754a27daa480", Constants.PARAMS);
let logger = new LogBuilder()
.level(Levels.INFO)
.filePath("./app.log")
.build();
let initialize = await new InitializeBuilder();
await initialize.user(user).environment(environment).token(apikey).logger(logger).initialize();
console.log("\nSDK initialized successfully.");
}
static async execute() {
//Initializing SDK once is enough. Calling here since code sample will be tested standalone.
//You can place SDK initializer code in your application and call once while your application start-up.
await this.initializeSdk();
try {
var sdkOperations = new OfficeIntegratorSDKOperations();
var createDocumentParameters = new CreateDocumentParameters();
var createResponse = await sdkOperations.createDocument(createDocumentParameters);
var documentId = createResponse.object.getDocumentId();
console.log("\nCreated a new document to demonstrate the document delete api. Created document ID - " + documentId);
var responseObject = await sdkOperations.deleteDocument(documentId);
if(responseObject != null) {
//Get the status code from response
console.log("\nStatus Code: " + responseObject.statusCode);
//Get the api response object from responseObject
let writerResponseObject = responseObject.object;
if(writerResponseObject != null){
//TODO: Need to fix object type issue
if(writerResponseObject instanceof DocumentDeleteSuccessResponse){
console.log("\nDocument delete status - " + writerResponseObject.getDocumentDeleted());
} else if (writerResponseObject instanceof InvaildConfigurationException) {
console.log("\nInvalid configuration exception. Exception json - ", writerResponseObject);
} else {
console.log("\nRequest not completed successfullly");
}
}
}
} catch (error) {
console.log("\nException while running sample code", error);
}
}
}
DeleteDocument.execute();