Genesys Cloud - Developer Announcements!

 View Only

Sign Up

  • 1.  Case Management: remove the unsupported before query parameter and unused pagination fields from listing endpoints

    Posted 16 days ago

    Summary

    Case Management listing endpoints only page forwards, using the after cursor. Several of them advertise options that have never worked:

    • The before query parameter is removed from these list endpoints: Stages, Steps, Case Associations, Stageplans and Stepplans. The parameter was accepted but ignored, and backward paging was never supported. Use after (or the returned nextUri) to page.
    • Pagination fields that are always empty are removed from listing response schemas: 
      • GET list responses (CaseplanListing, StageplanListing, StepplanListing, StageListing, StepListing, CaseListing, CaseAssociationListing, CommentListing): selfUri and previousUri are removed. The responses keep entities and nextUri.
      • POST query responses (CaseplanQueryEntityListing, CaseAssociationQueryEntityListing): selfUri, previousUri and nextUri are removed. The responses keep entities and after. To get the next page, send after in the next query request body.

    These fields were never filled in, so the JSON that comes back over the wire doesn't change. The change shows up in the API documentation and in generated SDK models.

    Effective Date

    Monday, November 2, 2026

    Details

    The Case Management service only supports forward, after-cursor pagination. Advertising before, previousUri and selfUri (and nextUri on query responses) wrongly suggests those features work. It also leads customers and SDK users to write code against fields that are always null, or a parameter that does nothing. This change brings the documented contract in line with what the API actually does, and makes Case Management pagination consistent across all its endpoints.

    Customer Impact

    Raw HTTP / JSON consumers: response bodies don't change, because these fields were never returned with a value. Requests that still send before will keep working, since unknown query parameters are ignored, but the parameter has no effect, as before.

    SDK users: after the next SDK release, the removed properties (getSelfUri(), getPreviousUri(), and getNextUri() on query responses) and the before argument on the affected list methods will no longer exist. Code that references them will fail to compile once you upgrade the SDK. Action: remove any references to these properties or arguments. They always returned null or had no effect, so removing them doesn't change behaviour. If you don't, your build will fail when you upgrade the SDK. Nothing breaks at runtime or before you upgrade.

    Impacted Resources

    Request parameter before removed:

    GET /api/v2/casemanagement/cases/{caseId}/stages

    GET /api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps

    GET /api/v2/casemanagement/cases/{caseId}/associations

    GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans

    GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans

    Response properties selfUri and previousUri removed:

    GET /api/v2/casemanagement/caseplans

    GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans

    GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans

    GET /api/v2/casemanagement/cases/{caseId}/stages

    GET /api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps

    GET /api/v2/casemanagement/cases/{caseId}/associations

    GET /api/v2/casemanagement/cases/{caseId}/comments

    GET /api/v2/casemanagement/cases/externalcontacts/{externalContactId}

    Response properties selfUri, previousUri and nextUri removed:

    POST /api/v2/casemanagement/caseplans/query

    POST /api/v2/casemanagement/cases/associations/query

    Issue References

    [WORKITEMS-7709]

    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.



  • 2.  RE: Case Management: remove the unsupported before query parameter and unused pagination fields from listing endpoints

    Posted 16 days ago
    Thanks for sharing this update!


    ------------------------------
    Akhil
    ------------------------------



  • 3.  RE: Case Management: remove the unsupported before query parameter and unused pagination fields from listing endpoints

    Posted 16 days ago

    Thank you for sharing.



    ------------------------------
    Phaneendra
    Technical Solutions Consultant
    ------------------------------