Error: REST API call times out when fetching Jobstream ID by name

Products

• Automation Analytics & Intelligence

Issue/Introduction

 When attempting to fetch a Jobstream ID using a REST API call with the jobstream name via script or Swagger UI, the request times out and fails to return the desired output․​​​‌​‍

Environment

AAI 24.x

Cause

The API request times out because the search parameter was formatted incorrectly by providing just the jobstream name instead of the required name='<value>' format․

Resolution

PREREQUISITES:

• Access to the REST API or Swagger UI․

• Known jobstream name․

STEPS:

Step 1․ USE CORRECT SEARCH FIELD SYNTAX

Use the field operator format name='<jobstreamName>' instead of just entering the name․

For example, for a jobstream named 'demo_box1', use:

name='demo_box1'․

EXPECTED: The API call executes successfully without timing out and returns the correct Jobstream details including the ID․

 

Step 2․ ALTERNATIVE: RETRIEVE ID FROM WEB UI

Path/Command: You can manually get the jobstreamId from the URL by clicking on a jobstream definition in the Web UI․

Example URL: https://<hostname>:<port>/aai/web/v2/jobstreams/XXXXXXX=/basic

The valueXXXXXXX= represents the jobstream definition ID․

Additional Information

If you run into issues with the API call taking a long time or timing out, change the "fetch" field to "none" and try again and it should return results much quicker.