WKC API must return a specific error messages

WKC API must return a specific error so VZ can pinpoint why an extract is failing

When the data profiling script is executed, we are receiving errors/ exceptions from the WKC API call intermittently.

The response error code that it returns is not sufficient to understand what it means.

An exception happens in one execution and does not happen in the next execution for the same set of schemas.

Exception code needs to be more explicit about what failed.

• Requesting for a specific WKC error code and what it means. The standard API error codes are not sufficient

Please see below examples: provided in the Jira as well → https://onejira.verizon.com/browse/AIDR-773

Executed CDL profile extraction on 5/16 17:03

• got the following error → No resource found

Executed OVA extract on 5/20 15:50

• This was the exception. We were told that this is a Gateway Timeout (502) issue

File "/apps/opt/application/wkc-scripts-master/wkc-scripts/scripts/get_metadata_dataprofile_CC.py", line 280, in get_asset_ids

raise Exception(asset_search_response.text)

Exception: 3.5.0.0 (20211119_0901) x86_64

Executed on 5/27 and getting below exceptions:

• OVA extract error

  • 
    

  • File "/apps/opt/application/wkc-scripts-master/wkc-scripts/scripts/get_metadata_dataprofile_CC.py", line 285, in get_asset_ids

  • raise Exception(asset_search_response.text)

  • Exception: 3.5.0.0 (20211119_0901) x86_64

  • 
    

• CDL extract error

  • File "/apps/opt/application/wkc-scripts-master/wkc-scripts/scripts/get_metadata_dataprofile_CC.py", line 51, in find_catalog_id

  • raise Exception(catalogs_list_request.text)

  • Exception: 3.5.0.0 (20211119_0901) x86_64

  • 
    

The information provided to us was to use the below swagger document. Please see below

WKC apis and a list of response codes - swagger document

• https://api.dataplatform.cloud.ibm.com/v2/cams/explorer/#!/Data_Assets/getDataAssetV2

● Data Assets → GET /v2/data_assets/{data_asset_id}

● response codes section

The response that this shows are 4 codes. We cannot understand why it failed with a status of 400 or 500. IBM team said that the API can return 500 when the input data has a formatting/bad character. We cannot identify that by seeing 500 Internal Server errors.

We need deeper reason codes and exact messages.