get_hcls_store_details

HclsApi.get_hcls_store_details(hcls_name, id, role_id, action=None, limit=None, marker=None, offset=None, sortorder=None, sortby=None, projection_expression=None, imageset_id=None, version=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get details of an HCLS store or workflow

Returns details of a single HCLS store or workflow. When no query parameters are provided, returns the full store/workflow item including AccessType. Optional action query parameter selects nested resource operations (references, readsets, imagesets, dependent resources).

Parameters:

  • hcls_name (str) – HCLS service type. Valid values: healthlake (FHIR datastore), omics-storage (Omics reference/sequence stores), omics-workflows (Omics workflows), health-imaging (HealthImaging datastore). (required)

  • id (str) – StoreId or HclsWorkflowId of the HCLS resource. (required)

  • role_id (str) – Amorphic role identifier used for authorization. (required)

  • action (str) – Nested resource action. Required when any other query parameter is supplied. For stores: get_references, get_readsets, get_dependent_resources, list_imageset, get_imageset, list_imageset_versions, get_imageset_metadata. For omics-workflows: get_dependent_resources only.

  • limit (str) – Page size for list actions (get_references, get_readsets, list_imageset). Default is 20.

  • marker (str) – Pagination marker/token returned by a previous list call.

  • offset (str) – 1-based page offset for pagination. Default is 1 (internally converted to 0-based).

  • sortorder (str) – Sort direction for the result set. Default is desc.

  • sortby (str) – Sort attribute for list_imageset. Default is CreationTime.

  • projection_expression (str) – Comma-separated list of attributes to include in each returned item. When omitted, all attributes are returned.

  • imageset_id (str) – HealthImaging ImageSetId. Required for get_imageset, list_imageset_versions, and get_imageset_metadata.

  • version (str) – Optional imageset version id for get_imageset / get_imageset_metadata. When omitted, the latest version is used.

  • _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:

HclsStores

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /hcls/{hcls_name}/{id}

Success (HTTP 200)

Successfully returns HCLS store/workflow details or nested action result

Errors

HTTP 400

Invalid input parameters

HTTP 500

Something went wrong at backend