GET Workspace

GET 
/workspaces/:workspaceId

GET Workspace

Request

Path Parameters

workspaceId uuidrequired

Responses

200

Workspace.

application/json

Schema

Schema

workspaceId uuidrequired
displayName stringrequired
createdAt date-timerequired
createdBy uuidrequired
state int32required

Possible values: [Enabled, Disabled]

isInitial booleanrequired
stateChangeReason int32

Possible values: [Manual, TrialExpiration, SubscriptionAssigned, SubscriptionEnabled, SubscriptionExpiration, WorkspaceDeletion]

workspaceDefaultStorage

object

required

subscriptionId stringrequired

resourceGroupName stringrequired

storageAccountName stringrequired

Example (from schema)

{
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "displayName": "string",
  "createdAt": "2024-12-17T17:37:35.083Z",
  "createdBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "Enabled",
  "isInitial": true,
  "stateChangeReason": "Manual",
  "workspaceDefaultStorage": {
    "subscriptionId": "string",
    "resourceGroupName": "string",
    "storageAccountName": "string"
  }
}

example-1

{
  "workspaceId": "23d8e4f8-70ef-4ed8-96eb-6a3553b95497",
  "displayName": "My Workspace",
  "createdAt": "2023-01-29T09:45:00Z",
  "createdBy": "3c5abcb0-5faf-401c-b8c8-e026b7ceee57",
  "state": "Enabled",
  "isInitial": false,
  "workspaceDefaultStorage": {
    "subscriptionId": "7850ea3f-249d-4e90-92f6-28ce50224dd7",
    "resourceGroupName": "ddp-workspaces-data-prd-rg",
    "storageAccountName": "32yx15nw5xc2merh9junfke4"
  }
}

404

Workspace not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...