generate_hcls_store_flexview_token

HclsApi.generate_hcls_store_flexview_token(hcls_name, id, hcls_action, role_id, action=None, study_instance_uid=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Perform FlexView connection-related GET requests

HealthImaging FlexView helpers. Only supported when hcls_name is health-imaging. When hcls_action is view and action=generate-token, generates a FlexView access token (and optionally a study viewer URL when studyInstanceUID is provided). When hcls_action is datasourcetoken, generates an AWS datasource token for FlexView.

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) – HealthImaging datastore StoreId. (required)

  • hcls_action (str) – FlexView action resource. view for token/viewer requests; datasourcetoken for AWS datasource token generation. (required)

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

  • action (str) – Required when hcls_action is view. Must be generate-token.

  • study_instance_uid (str) – DICOM StudyInstanceUID. When provided with action=generate-token, returns FlexView viewer URL/config for that study.

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

HclsActionGetResponse

Returns:

Returns the result object.

Request and Response Examples

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

Success (HTTP 200)

Successfully generated FlexView token, viewer URL, or datasource token

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend