Table of Contents

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 RevitServerUiApi

Inheritance

Inherited Members

Constructors

RevitServerUiApi(string, bool, string)

Initializes a new instance of RevitServerUiApi.

public RevitServerUiApi(string host, bool useHttps = false, string serverVersion = "2022")

Parameters

host string

Revit Server host (e.g. "localhost" or IP address)

useHttps bool

Use HTTPS (default: false)

serverVersion string

Server year (default: "2022")

Properties

BaseUrl

Base URL for UI API (without /api suffix).

public string BaseUrl { get; }

Property Value

string

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

id string
destinationId string
pasteAction RevitServerUiApi.PasteAction
replaceExisting bool

Returns

Task<string>

CreateFolderAsync(string)

PUT /api/folder/createfolder?id={id} Returns a URL (JSON string in response body).

public Task<string> CreateFolderAsync(string id)

Parameters

id string

Returns

Task<string>

DeleteAsync(string, Dictionary<string, string>)

public Task<string> DeleteAsync(string apiPath, Dictionary<string, string> query = null)

Parameters

apiPath string
query Dictionary<string, string>

Returns

Task<string>

DeleteItemAsync(string)

Deletes a model or folder permanently (DELETE /api/operation?operationtype=DeleteOrRename&id={id}).

public Task DeleteItemAsync(string id)

Parameters

id string

Returns

Task

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

id string
newName string

Returns

Task

GetAsync(string, Dictionary<string, string>)

public Task<string> GetAsync(string apiPath, Dictionary<string, string> query = null)

Parameters

apiPath string
query Dictionary<string, string>

Returns

Task<string>

GetItemLockDataAsync(string, string)

GET /api/folder/ItemLockData?id={id}&placeholder=

public Task<UiItemLockData> GetItemLockDataAsync(string id, string placeholder = "")

Parameters

id string
placeholder string

Returns

Task<UiItemLockData>

GetModelDetailsAsync(string)

GET /api/model/details?id={id}

public Task<UiModelDetails> GetModelDetailsAsync(string id)

Parameters

id string

Returns

Task<UiModelDetails>

GetModelHistoriesAsync(string, string)

GET /api/model/ModelHistories?type=rs-model&id={id}

public Task<List<UiModelHistoryItem>> GetModelHistoriesAsync(string id, string type = "rs-model")

Parameters

id string
type string

Returns

Task<List<UiModelHistoryItem>>

GetSubItemsAsync(string, int)

GET /api/folder/SubItems?id={id}&depth={depth}

public Task<UiTreeItem> GetSubItemsAsync(string id, int depth = 1)

Parameters

id string
depth int

Returns

Task<UiTreeItem>

LockAsync(string)

PUT /api/operation?operationType=Lock&id={id}

public Task LockAsync(string id)

Parameters

id string

Returns

Task

PostAsync(string, Dictionary<string, string>, string)

public Task<string> PostAsync(string apiPath, Dictionary<string, string> query = null, string data = null)

Parameters

apiPath string
query Dictionary<string, string>
data string

Returns

Task<string>

PutAsync(string, Dictionary<string, string>, string)

public Task<string> PutAsync(string apiPath, Dictionary<string, string> query = null, string data = null)

Parameters

apiPath string
query Dictionary<string, string>
data string

Returns

Task<string>

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

id string
newName string

Returns

Task

UnlockAsync(string, bool)

DELETE /api/operation?operationtype=Unlock&id={id}&itemMustExist={true|false}

public Task UnlockAsync(string id, bool itemMustExist = true)

Parameters

id string
itemMustExist bool

Returns

Task