Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT data services developer documentation

TABLE OF CONTENTS

Access Control

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedApr 16, 2025
  • 6 minute read

List Virtual Table Access Rights

Returns the Virtual Table Access Rights.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accessrights/virtualTables

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

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

List Sharing Table Access Rights

Returns the Sharing Table Access Rights.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accessrights/shares

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code Body Type Description
200 Inline Successfully returns the Sharing table access rights.
403 ErrorResponse You are not authorized for this operation.
500 ErrorResponse An error occurred while processing the request.

Access Control

Get virtualtable Access Control List

Returns the Virtualtable Access Control List

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/virtualTables

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code Body Type Description
200 AccessControlList Successfully retrieved the Virtualtable Access Control List.
403 ErrorResponse You are not authorized for this operation.
500 ErrorResponse An error occurred while processing the request.

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Update virtualtable Access Control List

Updates the Virtualtable Access Control List

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/virtualTables

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

Access Control List

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code Body Type Description
204 None Successfully updated the Virtualtable Access Control List.
400 ErrorResponse Bad request.
403 ErrorResponse You are not authorized for this operation.
500 ErrorResponse An error occurred while processing the request.

Get Sharing Table Access Control List

Returns the Sharing Table Access Control List

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/shares

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code Body Type Description
200 AccessControlList Successfully retrieved the Sharing Table Access Control List.
403 ErrorResponse You are not authorized for this operation.
500 ErrorResponse An error occurred while processing the request.

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Update Sharing Access Control List

Updates the Sharing Table Access Control List

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/shares

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

Access Control List

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code Body Type Description
204 None Successfully updated the Sharing Table Access Control List.
400 ErrorResponse Bad request.
403 ErrorResponse You are not authorized for this operation.
500 ErrorResponse An error occurred while processing the request.

Access Control

Virtual Table Access Control List 1

Returns the Virtual Table Access Control List.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/virtualTables/{id}/accesscontrol

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Response

Status Code Body Type Description
200 AccessControlList Successfully retrieved the Virtual Table Access Control List.
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 (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Virtual Table Access Control List 2

Updates the Virtual Table Access Control List.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/virtualTables/{id}/accesscontrol

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Request Body

Access Control List

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code Body Type Description
200 AccessControlList Successfully updated the Virtual Table Access Control List.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse None
500 ErrorResponse An error occurred while processing the request.

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Get Virtual Table Owner

Returns the Virtual Table Owner.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/virtualTables/{id}/owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Response

Status Code Body Type Description
200 Trustee Successfully returns the Virtual Table Owner.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse None
500 ErrorResponse An error occurred while processing the request.

Example response body

200 Response (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Update Virtual Table Owner

Updates the Virtual Table Owner.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/virtualTables/{id}/owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Request Body

Virtual Table Owner

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Response

Status Code Body Type Description
200 Trustee Successfully updates the Virtual Table Owner.
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 (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

List Virtual Table Access Rights

Returns the Virtual Table Access Rights.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/virtualTables/{id}/accessrights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Response

Status Code Body Type Description
200 Inline Successfully returns the Virtual Table Access Rights.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse Not Found.
500 ErrorResponse An error occurred while processing the request.

Access Control

Sharing Table Access Control List

Returns the Sharing Table Access Control List.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/shares/{id}/accesscontrol

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Response

Status Code Body Type Description
200 AccessControlList Successfully retrieved the Sharing Table Access Control List.
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 (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Sharing Access Control List

Updates the Sharing Table Access Control List.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/shares/{id}/accesscontrol

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Request Body

Access Control List

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code Body Type Description
200 AccessControlList Successfully updated the Sharing Table Access Control List.
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 (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Get Share Table Owner

Returns the Share Table Owner.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/shares/{id}/owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Response

Status Code Body Type Description
200 Trustee Successfully returns the Share Table Owner.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse None
500 ErrorResponse An error occurred while processing the request.

Example response body

200 Response (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Update Share Table Owner

Updates the Share Table Owner.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/shares/{id}/owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Request Body

Virtual Table Owner

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Response

Status Code Body Type Description
200 Trustee Successfully updates the Share Table Owner.
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 (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

List Virtual Table Access Rights

Returns the Virtual Table Access Rights.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/shares/{id}/accessrights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string id
Virtual Table identifier.

Response

Status Code Body Type Description
200 Inline Successfully returns the Virtual Table Access Rights.
403 ErrorResponse You are not authorized for this operation.
404 ErrorResponse Not Found.
500 ErrorResponse An error occurred while processing the request.

Definitions

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
  }
}

AccessControlList

Properties

Property Name Data Type Required Nullable Description
RoleTrusteeAccessControlEntries [AccessControlEntry] false true None 
{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

AccessControlEntry

Properties

Property Name Data Type Required Nullable Description
Trustee Trustee false true None
AccessType AccessType false false None
AccessRights int64 false false None 
{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}

Trustee

Properties

Property Name Data Type Required Nullable Description
Type TrusteeType false false None
ObjectId string false true None
TenantId string false true None 
{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

TrusteeType

Enumerated Values

Property Value
User 1
Client 2
Role 3

AccessType

Enumerated Values

Property Value
Allowed 0
Denied 1
In This Topic
TitleResults for “How to create a CRG?”Also Available in