Sharing

Save PDF

Last UpdatedApr 16, 2025
4 minute read

The Sharing Asp.net Core controller.

`List virtual table shares`

Returns the List of virtual table shares.

Request

GET /api/v1/tenants/{tenantid}/namespaces/{namespaceid}/shares
?query={query}&orderBy={orderBy}&skip={skip}&count={count}

Parameters

string tenantId
Tenant Id

string namespaceId
Namespace Id

string query
query

string orderBy
orderBy

[optional] integer skip
skip

[optional] integer count
count

Response

Status Code	Body Type	Description
200	ShareView	list of shares
403	ErrorResponse	You are not authorized for this operation.
404	ErrorResponse	Not Found.
500	ErrorResponse	An error occurred while processing the request.

Example response body

200 Response (ShareView)

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "VirtualTableId": "string",
      "VirtualTableName": "string",
      "Status": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  }
}

`Create virtual table share`

Created the Virtual Table Share.

Request

POST /api/v1/tenants/{tenantid}/namespaces/{namespaceid}/shares

Parameters

string tenantId
Tenant Id

string namespaceId
Namespace Id

Request Body

Virtual table share details

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "id": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  },
  "SerializedSecurable": "string",
  "CreatedBy": "string",
  "CreatedOn": "2019-08-24T14:15:22Z"
}

Response

Status Code	Body Type	Description
201	ShareView	None
400	ErrorResponse	None
403	ErrorResponse	You are not authorized for this operation.
500	ErrorResponse	An error occurred while processing the request.

Example response body

201 Response (ShareView)

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "VirtualTableId": "string",
      "VirtualTableName": "string",
      "Status": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  }
}

`Get virtual table share`

Returns the Virtual Table Share.

Request

GET /api/v1/tenants/{tenantid}/namespaces/{namespaceid}/shares/{id}

Parameters

string tenantId
Tenant Id

string namespaceId
Namespace Id

string id
Virtual table share Id

Response

Status Code	Body Type	Description
200	ShareView	Successfully returns the virtual table share.
403	ErrorResponse	You are not authorized for this operation.
500	ErrorResponse	An error occurred while processing the request.

Example response body

200 Response (ShareView)

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "VirtualTableId": "string",
      "VirtualTableName": "string",
      "Status": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  }
}

`Update virtual table share`

Updated the Virtual Table Share.

Request

PUT /api/v1/tenants/{tenantid}/namespaces/{namespaceid}/shares/{id}

Parameters

string tenantId
Tenant Id

string namespaceId
Namespace Id

string id
Virtual table share Id

Request Body

Virtual table share details

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "id": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  },
  "SerializedSecurable": "string",
  "CreatedBy": "string",
  "CreatedOn": "2019-08-24T14:15:22Z"
}

Response

Status Code	Body Type	Description
200	ShareView	Successfully updated the Virtual Table Share.
400	ErrorResponse	None
403	ErrorResponse	You are not authorized for this operation.
500	ErrorResponse	An error occurred while processing the request.

Example response body

200 Response (ShareView)

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "VirtualTableId": "string",
      "VirtualTableName": "string",
      "Status": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  }
}

`Delete virtual table share`

Deleted the Virtual Table Share.

Request

DELETE /api/v1/tenants/{tenantid}/namespaces/{namespaceid}/shares/{id}

Parameters

string tenantId
Tenant Id

string namespaceId
Namespace Id

string id
Virtual table share Id

Response

Status Code	Body Type	Description
204	None	Successfully deleted the Virtual Table Share.
403	ErrorResponse	You are not authorized for this operation.
404	ErrorResponse	Not Found.
500	ErrorResponse	An error occurred while processing the request.

Definitions

ShareView

Share view list

Properties

Property Name	Data Type	Required	Nullable	Description
id	string	false	true	Share Id
name	string	false	true	Share name
type	string	false	true	Share Type
virtualTables	[ShareVirtualTableView]	false	true	List of virtual tables associated with the share.
externalConfig	ShareExternalConfig	false	false	External configuration details for the share.

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "VirtualTableId": "string",
      "VirtualTableName": "string",
      "Status": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  }
}

ShareVirtualTableView

Share virtual table view

Properties

Property Name	Data Type	Required	Nullable	Description
VirtualTableId	string	false	false	Virtual Table Id
VirtualTableName	string	false	false	Virtual Table Name
Status	string	false	false	Materialization Status

{
  "VirtualTableId": "string",
  "VirtualTableName": "string",
  "Status": "string"
}

ShareExternalConfig

Share External Config

Properties

Property Name	Data Type	Required	Nullable	Description
globalMetastoreId	string	false	true	Global Metastore Id
clientId	string	false	true	Client Id
clientSecret	string	false	true	Client Secret
snowflakeId	string	false	true	Snowflake Id

{
  "globalMetastoreId": "string",
  "clientId": "string",
  "clientSecret": "string",
  "snowflakeId": "string"
}

ErrorResponse

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	false	true	None
Error	string	false	true	None
Reason	string	false	true	None
Resolution	string	false	true	None
Parameters	object	false	true	None
ChildErrors	object	false	true	None

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  },
  "ChildErrors": {
    "property1": null,
    "property2": null
  }
}

Property Name	Data Type	Required	Nullable	Description
id	string	false	true	Share Id
name	string	false	true	Share name
type	string	false	true	Share Type
virtualTables	[ShareVirtualTableParam]	false	true	List of virtual tables associated with the share.
externalConfig	ShareExternalConfig	false	false	External configuration details for the share.
SerializedSecurable	string	false	true	SerializedSecurable
CreatedBy	string	false	true	CreatedBy
CreatedOn	date-time	false	true	CreatedOn

{
  "id": "string",
  "name": "string",
  "type": "string",
  "virtualTables": [
    {
      "id": "string"
    }
  ],
  "externalConfig": {
    "globalMetastoreId": "string",
    "clientId": "string",
    "clientSecret": "string",
    "snowflakeId": "string"
  },
  "SerializedSecurable": "string",
  "CreatedBy": "string",
  "CreatedOn": "2019-08-24T14:15:22Z"
}

ShareVirtualTableParam

Share virtual table param

Properties

Property Name	Data Type	Required	Nullable	Description
id	string	false	true	Virtual Table Id

{
  "id": "string"
}

CONNECT data services developer documentation

Sharing

Table of Contents

Sharing

In This Topic

Related Links