Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

[Preview APIs] Case Management – Simplified Schema Setup and Removal of version from CaseplanDataSchema

  • 1.  [Preview APIs] Case Management – Simplified Schema Setup and Removal of version from CaseplanDataSchema

    Posted 3 hours ago

    Summary

    Enhancements to Case Management introduce a simplified approach to Caseplan schema handling:

    • Schema assignment is now optionalduring caseplan creation and remains editable until the caseplan is published. Once published, the schema becomes fixed.

    • Schema versioning is now automatic. Caseplans will always resolve and use the latest available schema version at runtime.

    As part of this change, the Preview Public API type CaseplanDataSchema will no longer include a version property. Clients must reference schemas using id only, and must not send or rely on schema version information.

    Request examples

    Draft dataschema POST/PUT →id only:

    {
  "id": "de819219-75c0-43b1-81da-47d5fe9965c4"
}

    Caseplan create — nested dataSchemas on POST /api/v2/casemanagement/caseplans

    Before (version included):

    {
  "name": "MyCaseplan",
  "divisionId": "0e819219-75c0-43b1-81da-47d5fe9965c4",
  "referencePrefix": "PLAN",
  "customerIntentId": "0373acd7-5afa-447e-920a-006cd5082890",
  "dataSchemas": [
    {
      "id": "00819219-75c0-43b1-81da-47d5fe9965c4",
      "version": 1
    }
  ]
}

    After:

    {
  "name": "MyCaseplan",
  "divisionId": "0e819219-75c0-43b1-81da-47d5fe9965c4",
  "referencePrefix": "PLAN",
  "customerIntentId": "0373acd7-5afa-447e-920a-006cd5082890",
  "dataSchemas": [
    {
      "id": "00819219-75c0-43b1-81da-47d5fe9965c4"
    }
  ]
}

    (Other create fields optional and omitted for clarity)

    Effective Date

    Monday, May 25, 2026

    Details

    Schema handling has been simplified to reduce configuration complexity and ensure consistent behavior:

    • Schema association is optional during draft creation.

    • Caseplans reference schemas by ID only.

    • Schema version resolution is handled automatically by the system.

    • Version-specific schema selection is no longer supported.

    Customer Impact

    These APIs are in Preview and are not expected to have customer impact.

    Requests:

    Clients should provide schema ID only when working with CaseplanDataSchema (and related request types), wherever schema association is supported (e.g. draft schema operations during caseplan creation). The version field should no longer be sent or relied upon in Public API requests.

    Responses:

    The version property has been removed from CaseplanDataSchema. Any clients, SDKs, or integrations that currently expect this field in JSON API responses must be updated accordingly.

    Legacy or stored payloads:

    If older configs or tools still include version, do not depend on it being present or honoured in the Public API contract going forward; align automation and tests with id only.

    Impacted Resources

    POST /casemanagement/caseplans

    Creates a new caseplan. Schema association is optional at creation.

    GET /casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas

    Returns a list of CaseplanDataSchema associated with the specified caseplan version. Note: versionId refers to the caseplan version, not the schema version.

    POST /casemanagement/caseplans/{caseplanId}/dataschemas

    Returns created CaseplanDataSchema (new resource).

    PUT /casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}

    Returns updated CaseplanDataSchema (new resource).

    Issue References

    [WORKITEMS-6991]

    [WORKITEMS-7309]

    [WORKITEMS-6799]

    Contacts

    @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