getDescriptor()
Home > @gooddata/sdk-backend-spi > IAnalyticalWorkspace > getDescriptor
IAnalyticalWorkspace.getDescriptor() method
Returns details about the analytical workspace. Throws error in case the workspace does not exist.
Signature:
getDescriptor(includeParentPrefixes?: boolean): Promise<IWorkspaceDescriptor>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| includeParentPrefixes | boolean | (Optional) Optional parameter to include parent prefixes in the workspace descriptor. |
Returns:
Promise<IWorkspaceDescriptor>