Class RevitServerUiApi
- Namespace
- RevitServerNet
- Assembly
- RevitServerNet.dll
Client for Revit Server Admin UI API (used by RevitServerAdmin{YEAR} web UI). Base path example: http://{host}/RevitServerAdmin2022/api/...
public class RevitServerUiApiInheritance
Inherited Members
Constructors
RevitServerUiApi(string, bool, string)
Initializes a new instance of RevitServerUiApi.
public RevitServerUiApi(string host, bool useHttps = false, string serverVersion = "2022")Parameters
hoststring-
Revit Server host (e.g. "localhost" or IP address)
useHttpsbool-
Use HTTPS (default: false)
serverVersionstring-
Server year (default: "2022")
Properties
BaseUrl
Base URL for UI API (without /api suffix).
public string BaseUrl { get; }Property Value
Methods
CopyOrMoveAsync(string, string, PasteAction, bool)
POST /api/folder/copyOrMove?id={id}&destinationid={destinationId}&pasteAction={Copy|Move}&replaceExisting={true|false} Returns a URL (JSON string in response body).
public Task<string> CopyOrMoveAsync(string id, string destinationId, RevitServerUiApi.PasteAction pasteAction, bool replaceExisting = false)Parameters
idstringdestinationIdstringpasteActionRevitServerUiApi.PasteActionreplaceExistingbool
Returns
CreateFolderAsync(string)
PUT /api/folder/createfolder?id={id} Returns a URL (JSON string in response body).
public Task<string> CreateFolderAsync(string id)Parameters
idstring
Returns
DeleteAsync(string, Dictionary<string, string>)
public Task<string> DeleteAsync(string apiPath, Dictionary<string, string> query = null)Parameters
apiPathstringqueryDictionary<string, string>
Returns
DeleteItemAsync(string)
Deletes a model or folder permanently (DELETE /api/operation?operationtype=DeleteOrRename&id={id}).
public Task DeleteItemAsync(string id)Parameters
idstring
Returns
DeleteOrRenameAsync(string, string)
DELETE /api/operation?operationtype=DeleteOrRename&id={id}[&newName={newName}] newName null -> delete (irreversible); otherwise rename. An empty or whitespace newName throws System.ArgumentException: the server would treat it as a delete. Prefer RevitServerNet.RevitServerUiApi.DeleteItemAsync(System.String) and RevitServerNet.RevitServerUiApi.RenameAsync(System.String,System.String).
public Task DeleteOrRenameAsync(string id, string newName = null)Parameters
Returns
GetAsync(string, Dictionary<string, string>)
public Task<string> GetAsync(string apiPath, Dictionary<string, string> query = null)Parameters
apiPathstringqueryDictionary<string, string>
Returns
GetItemLockDataAsync(string, string)
GET /api/folder/ItemLockData?id={id}&placeholder=
public Task<UiItemLockData> GetItemLockDataAsync(string id, string placeholder = "")Parameters
Returns
GetModelDetailsAsync(string)
GET /api/model/details?id={id}
public Task<UiModelDetails> GetModelDetailsAsync(string id)Parameters
idstring
Returns
GetModelHistoriesAsync(string, string)
GET /api/model/ModelHistories?type=rs-model&id={id}
public Task<List<UiModelHistoryItem>> GetModelHistoriesAsync(string id, string type = "rs-model")Parameters
Returns
GetSubItemsAsync(string, int)
GET /api/folder/SubItems?id={id}&depth={depth}
public Task<UiTreeItem> GetSubItemsAsync(string id, int depth = 1)Parameters
Returns
LockAsync(string)
PUT /api/operation?operationType=Lock&id={id}
public Task LockAsync(string id)Parameters
idstring
Returns
PostAsync(string, Dictionary<string, string>, string)
public Task<string> PostAsync(string apiPath, Dictionary<string, string> query = null, string data = null)Parameters
apiPathstringqueryDictionary<string, string>datastring
Returns
PutAsync(string, Dictionary<string, string>, string)
public Task<string> PutAsync(string apiPath, Dictionary<string, string> query = null, string data = null)Parameters
apiPathstringqueryDictionary<string, string>datastring
Returns
RenameAsync(string, string)
Renames a model or folder (DELETE /api/operation?operationtype=DeleteOrRename&id={id}&newName={newName}).
public Task RenameAsync(string id, string newName)Parameters
Returns
UnlockAsync(string, bool)
DELETE /api/operation?operationtype=Unlock&id={id}&itemMustExist={true|false}
public Task UnlockAsync(string id, bool itemMustExist = true)