Genesys Cloud - Developer Announcements!

 View Only

Sign Up

API Change: Stricter Validation for jobId in Work Item Queries

  • 1.  API Change: Stricter Validation for jobId in Work Item Queries

    Posted 07-04-2025 05:33
    Edited by Ananya Singh 07-04-2025 05:49

    Summary

    The GET /api/v2/taskmanagement/workitems/query/jobs/{jobId} and GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results endpoints will now validate the jobId provided in the request path.

    Previously, these endpoints didn't check if the jobId was a valid UUID. An invalid jobId would typically result in a 404 Not Found error. With this change, if an invalid jobId is provided (i.e., not a valid version 4 UUID), the API will now return a 400 Bad Request error. A 404 Not Found or a 5XX server error will no longer be returned for an invalid jobId.

    The error message for a 400 Bad Request will be:

    id - a version 4 UUID is required, received: [value]

    Where [value] will be the invalid jobId that was provided.

    Effective Date

    Monday, October 6, 2025

    Details

    This change is being implemented to improve API robustness and prevent invalid strings from being processed as jobId values. Validating the jobId at the request level ensures cleaner data handling and more precise error reporting.

    Customer Impact

    When requesting an invalid job ID, the customer will no longer receive a 404 Not Found error or a 5XX server error. Instead, a 400 Bad Request error will be received with the message:

    id - a version 4 UUID is required, received: [value]

    Impacted Resources

    GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}

    GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results

    Issue References

    [WORKITEMS-4701]

    Contacts

    @Rory Tummon  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.