Summary
We are updating the Preview API contracts for Business Rules Schema to:
- Replace old DSS contracts with custom CCA schema contracts.
- Introduce dedicated request objects instead of generic models.
- Improve API documentation accuracy.
- Remove unnecessary fields to simplify the contract structure.
Effective Date
Monday, September 29, 2025
Details
We want to have better documentation and remove unnecessary fields to simplify the contracts, so the dedicated request objects will now be used instead of the model when creating and updating the schema.
Conversation Service introduced a similar change for their own contracts. We are making equivalent changes under the same requirement.
Customer Impact
Impacted APIs (Preview):
POST /api/v2/businessrules/schemas
PUT /api/v2/businessrules/schemas/{schemaId}
Key changes:
- id, name, and enabled fields removed from POST payload (since these are system-generated or not required).
- PUT payload now only requires version, enabled, and jsonSchema.
- jsonSchema now includes an optional definitions section.
For POST /api/v2/businessrules/schemas:
The requested payload changed from
{
"id":"",
"name":"",
"version":0,
"enabled":true,
"jsonSchema":{
"id":"",
"$schema":"",
"title":"",
"description":"",
"type":"",
"required":[
""
],
"properties":{
"":{
}
},
"additionalProperties":{
}
}
}
to:
{
"jsonSchema":{
"id":"",
"$schema":"",
"title":"",
"description":"",
"type":"",
"required":[
""
],
"properties":{
"":{
}
},
"additionalProperties":{
},
"definitions":{
}
}
}
For PUT /api/v2/businessrules/schemas/{schemaId}
The requested payload changed from:
{
"id":"",
"name":"",
"version":0,
"enabled":true,
"jsonSchema":{
"id":"",
"$schema":"",
"title":"",
"description":"",
"type":"",
"required":[
""
],
"properties":{
"":{
}
},
"additionalProperties":{
}
}
}
to:
{
"version":0,
"enabled":true,
"jsonSchema":{
"id":"",
"$schema":"",
"title":"",
"description":"",
"type":"",
"required":[
""
],
"properties":{
"":{
}
},
"additionalProperties":{
},
"definitions":{
}
}
}
Impacted Resources
POST /api/v2/businessrules/schemas
PUT /api/v2/businessrules/schemas/{schemaId}
Issue References
[RULES-1043]
Contacts
@Jiongxu Hou 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.