import JsonBulkBuilder from 'opengate-js/src/provision/entities/JsonBulkBuilder.js'

public class | source

JsonBulkBuilder

BaseProvision → BulkBuilder → JsonBulkBuilder

Json builder. This builder give you the necessary tools to create a json bulk using our OpenGate REST.

Constructor Summary

Public Constructor
public	constructor(ogapi: InternalOpenGateAPI, organization: string, resource: resource, timeout: number, async: boolean) Constructor

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

From class BulkBuilder
public	create(rawFile: string \| Blob, csv_response: boolean): * Execute the bulk creation operation
public	delete(rawFile: string \| Blob, csv_response: boolean): * Execute the bulk delete operation
public	deleteAll(rawFile: string \| Blob, csv_response: boolean): * Execute the bulk delete full operation
public	patch(rawFile: string \| Blob, csv_response: boolean): * Execute the bulk patch operation
public	update(rawFile: string \| Blob, csv_response: boolean): * Execute the bulk update operation

Constructor

Name	Type	Attribute	Description
ogapi	InternalOpenGateAPI		required field. This is ogapi instance
organization	string		required field. This is the organization name where entities will be created, updated or deleted
resource	resource		required field. This is the resource used for the bulk provision
timeout	number	optional	timeout in millisecons. The request will have a specific time out if it will be exceeded then the promise throw an exception
async	boolean	optional	forces async execution for the bulk operation