Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Query Caseplans API – New Filter-Based Query Contract

  • 1.  Query Caseplans API – New Filter-Based Query Contract

    Posted 4 hours ago

    Summary

    The Query Caseplans API is introducing a new filter-based request contract that replaces the legacy query fields (name, nameSearchType, and divisionIds). The new contract uses a generic filters array that supports searching by name, id, and divisionId, with filters combined using AND logic.

    This change is feature-toggled and backward compatible during the migration period.

    Affected APIs

    HTTP Method: POST

    API: /api/v2/casemanagement/caseplans/query

    Description: Query for Caseplans

    Effective Date

    Monday, July 13, 2026

    Details

    The existing query contract relies on flat request fields (name, nameSearchType, and divisionIds). The new filter-based contract provides a more flexible and extensible query model by allowing multiple filters to be combined using AND logic, with configurable operators for each filter.

    • Requests containing the filters field will use the new query model.
    • Requests using only the legacy fields will continue to use the existing query behavior during the migration period.

    This approach provides a seamless migration path while enabling more advanced query capabilities.

    Customer Impact

    The new filters field supports the following filter types:

    • name (type: String, operators: CONTAINS, BEGINS_WITH)
    • id (type: String, operator: IN)
    • divisionId (type: String, operator: IN)

    Sample new contract request:

    {
  "filters": [
    {
      "name": "name",
      "type": "String",
      "operator": "CONTAINS",
      "values": ["Onboarding"]
    },
    {
      "name": "id",
      "type": "String",
      "operator": "IN",
      "values": ["d2d7f82c-6d4a-40e6-b267-1cab28bec2f2"]
    }
  ],
  "attributes": ["name"],
  "pageSize": 25
}

    The legacy request fields (name, nameSearchType, and divisionIds) will continue to function during the migration period. Clients using only the legacy fields are not affected immediately.

    Customers are encouraged to begin migrating to the new filters request model. Once the migration period ends, support for the legacy query fields will be removed (subject to 0 usage).

    Impacted Resources

    Query for Caseplans: POST /api/v2/casemanagement/caseplans/query

    Issue References

    WORKITEMS-8088

    Contacts

    @Zoltan Sojtory  @Edel Kelly  

    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.



Related Content