Get one Workspace by workspace type, name and tenant, all of them required.

The descendants will be represented as a nested structure

GET /users/workspaces/type/{workspaceType}/name/{workspaceName}/tenant/{tenantId}/nested

Operation id: WorkspaceService_GetNestedWorkspace

Description

Permission Level: Read

Tags: WorkspaceService

Parameters

Path parameters

Query parameters

Security

• Authorization (apiKey)
  • Bearer token

Responses

200 — A successful response.

Content type: application/json

default — An unexpected error response.

Content type: application/json

Response models

200 — A successful response.

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "parent": {
      "type": "string",
      "description": "Name of the parent of the workspace. Empty if root workspace."
    },
    "workspaceType": {
      "type": "string"
    },
    "tenantId": {
      "type": "string"
    },
    "ancestors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "descendants": {
      "type": "object"
    },
    "displayName": {
      "type": "string"
    },
    "attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scope": {
            "type": "string"
          },
          "fieldName": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          }
        }
      }
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "description": "The ID of the tenant. Required: false. Defaults to the tenant of the user making the call."
          },
          "userId": {
            "type": "string",
            "description": "The user ID. Required: true."
          },
          "firstName": {
            "type": "string",
            "description": "The first name. Required: false."
          },
          "lastName": {
            "type": "string",
            "description": "The last name. Required: false."
          }
        }
      }
    }
  }
}

default — An unexpected error response.

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32"
    },
    "message": {
      "type": "string"
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string"
          }
        }
      }
    }
  }
}