All docs
This doc
Lists available business rule instances
Overview
| Description | Returns the list of business rule instances that are currently available. |
|---|---|
| API Context | /business-rules/instances |
| HTTP Method | GET |
| Request/Response Format | |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/business-rules/instances" -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Delete business rule with given UUID
Overview
| Description | Deletes the business rule with the given UUID. |
|---|---|
| API Context | /business-rules/instances/{businessRuleInstanceID}?force-delete=false |
| HTTP Method | DELETE |
| Request/Response Format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{businessRuleInstanceID} | The UUID (Uniquely Identifiable ID) of the business rules instance to be deleted. |
curl command syntax
Sample curl command
curl -X DELETE "https://localhost:9643/business-rules/instances/business-rule-1?force-delete=false" -H "accept: application/json" -u admin:adm
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Fetch template group with the given UUID
Overview
| Description | Returns the template group that has the given UUID. |
|---|---|
| API Context | /business-rules/template-groups/{templateGroupID} |
| HTTP Method | GET |
| Request/Response Format | |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{templateGroupID}
| The UUID of the template group to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/business-rules/template-groups/sweet-factory" -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Fetch rule templates of the template group with given UUID
Overview
| Description | Returns the rule templates of the template group with the given UUID. |
|---|---|
| API Context | /business-rules/template-groups/{templateGroupID}/templates |
| HTTP Method | GET |
| Request/Response Format | |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{templateGroupID} | The UUID of the template group of which the rule templates need to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/business-rules/template-groups/sweet-factory/templates" -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Fetch rule template of specific UUID available under a template group with specific UUID
Overview
| Description | Returns the rule template with the specified UUID that is defined under the template group with the specified UUID. |
|---|---|
| API Context |
/business-rules
/template-groups/{templateGroupID}/templates/{ruleTemplateID}
|
| HTTP Method | GET |
| Request/Response Format | |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{templateGroupID}
| The UUID of the template group from which the specified rule template needs to be retrieved. |
{ruleTemplateID}
| The UUID of the rule template that needs to be retrieved from the specified template group. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/business-rules/template-groups/sweet-factory/templates/identifying-continuous-production-decrease" -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Fetch available template groups
Overview
| Description | Returns all the template groups that are currently available in the SP setup. |
|---|---|
| API Context | /business-rules/template-groups |
| HTTP Method | GET |
| Request/Response Format | |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/business-rules/template-groups" -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Fetch business rule instance with given UUID
Overview
| Description | Returns the business rule instance with the given UUID. |
|---|---|
| API Context | /business-rules/instances/{businessRuleInstanceID} |
| HTTP Method | GET |
| Request/Response Format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{businessRuleInstanceID}
| The UUID of the business rules instance to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/business-rules/instances/business-rule-1" -H "accept: application/json" -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Create and save a business rule
Overview
| Description | Creates and saves a business rule. |
|---|---|
| API Context |
/business-rules
/instances?deploy={deploymentStatus}
|
| HTTP Method | POST |
| Request/Response Format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{deploymentStatus} |
curl command syntax
Sample curl command
curl -X POST "https://localhost:9643/business-rules/instances?deploy=true" -H "accept: application/json" -H "content-type: multipart/form-data" -F 'businessRule={"name":"Business Rule 5","uuid":"business-rule-5","type":"template","templateGroupUUID":"sweet-factory","ruleTemplateUUID":"identifying-continuous-production-decrease","properties":{"timeInterval":"6","timeRangeInput":"5","email":"[email protected]"}}' -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Update business rules instance with given UUID
Overview
| Description | Updates the business rules instance with the given UUID. |
|---|---|
| API Context |
/business-rules
/instances/{businessRuleInstanceID}?deploy={deploymentStatus}
|
| HTTP Method | PUT |
| Request/Response Format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter description
| Parameter | Description |
|---|---|
{businessRuleInstanceID}
| The UUID of the business rules instance to be updated. |
{deploymentStatus} |
curl command syntax
Sample curl command
curl -X PUT "https://localhost:9643/business-rules/instances/business-rule-5?deploy=true" -H "accept: application/json" -H "content-type: application/json" -d '{"name":"Business Rule 5","uuid":"business-rule-5","type":"template","templateGroupUUID":"sweet-factory","ruleTemplateUUID":"identifying-continuous-production-decrease","properties":{"timeInterval":"9","timeRangeInput":"8","email":"[email protected]"}}' -u admin:admin -k
Sample output
Response
| HTTP Status Code | 200 or 404 For descriptions of the HTTP status codes, see HTTP Status Codes. |
|---|
Overview
Content Tools
Activity
- Get Support
Download PDF
Download a PDF file of the documentation