fimidara — docs

`FimidaraEndpoints.workspaces.getWorkspace`

Parameters

props—Optional

{

authToken: string

body?: GetWorkspaceEndpointParams

}

GetWorkspaceEndpointParams

—Optional

{

workspaceId?: string

}

Result

—Optional

{

headers: Headers

body?: GetWorkspaceEndpointResult

}

GetWorkspaceEndpointResult

—Optional

{

workspace: Workspace

}

Workspace

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

rootname: string

description?: string

publicPermissionGroupId: string

billStatusAssignedAt: number

billStatus: string

usageThresholds: WorkspaceUsageThresholds

}

Agent

—Optional

{

agentId: string

agentType: string

}

WorkspaceUsageThresholds

—Optional

{

storage?: UsageThreshold

storageEver?: UsageThreshold

bin?: UsageThreshold

bout?: UsageThreshold

total?: UsageThreshold

}

UsageThreshold

—Optional

{

lastUpdatedBy: Agent

lastUpdatedAt: number

category: string

budget: number

usage: number

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

message: string

field?: string

}

`FimidaraEndpoints.workspaces.getWorkspace`

Parameters

props—Optional

{

authToken: string

body?: GetWorkspaceEndpointParams

}

GetWorkspaceEndpointParams

—Optional

{

workspaceId?: string

}

Result

—Optional

{

headers: Headers

body?: GetWorkspaceEndpointResult

}

GetWorkspaceEndpointResult

—Optional

{

workspace: Workspace

}

Workspace

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

rootname: string

description?: string

publicPermissionGroupId: string

billStatusAssignedAt: number

billStatus: string

usageThresholds: WorkspaceUsageThresholds

}

Agent

—Optional

{

agentId: string

agentType: string

}

WorkspaceUsageThresholds

—Optional

{

storage?: UsageThreshold

storageEver?: UsageThreshold

bin?: UsageThreshold

bout?: UsageThreshold

total?: UsageThreshold

}

UsageThreshold

—Optional

{

lastUpdatedBy: Agent

lastUpdatedAt: number

category: string

budget: number

usage: number

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

message: string

field?: string

}

FimidaraEndpoints.workspaces.getWorkspace

Parameters

GetWorkspaceEndpointParams

Result

GetWorkspaceEndpointResult

Workspace

Agent

WorkspaceUsageThresholds

UsageThreshold

Throws

FimidaraEndpointErrorItem

Loading...

FimidaraEndpoints.workspaces.getWorkspace

Parameters

GetWorkspaceEndpointParams

Result

GetWorkspaceEndpointResult

Workspace

Agent

WorkspaceUsageThresholds

UsageThreshold

Throws

FimidaraEndpointErrorItem

`FimidaraEndpoints.workspaces.getWorkspace`

`FimidaraEndpoints.workspaces.getWorkspace`