get_datalab_resource_access

DatalabsApi.get_datalab_resource_access(role_id, id, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get resources attached to a datalab

Returns the datasets, domains and parameters attached to a datalab beyond its own configuration, with the state of the most recent access update.

Parameters:

  • role_id (str) – User role id (required)

  • id (str) – Identifier of the datalab. (required)

  • projection_expression (str) – Comma-separated list of fields to return; all other fields are omitted.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DatalabResourceAccessResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datalabs/{id}/resourceaccess

Success (HTTP 200)

Successful API response

Request / response example

{
  "Status": "completed",
  "Message": "N/A",
  "DatasetAccess": {
    "Owner": [
      {
        "DatasetId": "d41f8a02-1b7c-4e6a-9d3f-5c8e7b2a1f90",
        "DatasetName": "monthly_orders",
        "Domain": "sales"
      }
    ],
    "ReadOnly": [],
    "ReadOnlyFileLevel": []
  },
  "DomainAccess": {
    "Owner": [
      {
        "DomainName": "sales"
      }
    ],
    "ReadOnly": []
  },
  "ParameterAccess": [
    "/adp/amorphic/pstore/user/db-password"
  ]
}

Errors

Documented error codes: IPV-1002, AUTH-1002, DLB-1002.

HTTP 400

Invalid input

DatalabId does not exist

{
  "Message": "IPV-1002 - Invalid DatalabId - b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f, resource not found."
}

Caller has no access on the datalab

{
  "Message": "AUTH-1002 - User action is not permitted"
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "DLB-1002 - Datalab b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f doesn't exist"
}