update Method

Update iModel's name and/or description

update(requestContext: AuthorizedClientRequestContext, contextId: string, imodel: HubIModel): Promise<HubIModel>

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

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

throws IModelHubError with [IModelHubStatus.iModelIsNotInitialized]$(bentley) if iModel is not initialized.

throws IModelHubError with [IModelHubStatus.iModelAlreadyExists]$(bentley) if iModel with specified name already exists.

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 connect context (IModelsHandler.Project or IModelsHandler.Asset).
imodel HubIModel iModel to update. See HubIModel.

Defined in

Last Updated: 08 January, 2020