delete Method

Delete an iModel with specified id from a context. This method is not supported in iModelBank.

delete(requestContext: AuthorizedClientRequestContext, contextId: string, iModelId: string): Promise<void>

throws IModelHubError with [IModelHubStatus.iModelDoesNotExist]$(bentley) if iModel with specified id does not exist.

throws IModelHubError with IModelHubStatus.UserDoesNotHavePermission if the user does not have DeleteiModel permission.

throws Common iModelHub errors

Parameter Type Description
requestContext AuthorizedClientRequestContext The client request context.
contextId string Id for the iModel's context. For iModelHub it should be the id of the iTwin context (Project or Asset).
iModelId string Id of the iModel to be deleted. See HubIModel.

Returns - Promise<void>

Defined in

Last Updated: 12 June, 2024