POST api/AdminBusinessRules

Inserts a Business rule into the DB

Request Information

URI Parameters

None.

Body Parameters

Business Rule to insert

VEMModel.VEMModelClass.adminBusinessRule
NameDescriptionTypeAdditional information
BusinessRuleId

integer

None.

RuleName

string

Max length: 100

Description

string

Max length: 250

ApplicationScreenId

integer

None.

ApplicationScreen

VEMModel.VEMModelClass.ApplicationScreen

None.

RuleType

VEMModel.Logic.ResultEnum

None.

FieldId

string

None.

Condition

string

None.

ExpectedEvaluationResult

boolean

None.

Message

string

None.

Deactivated

boolean

None.

AppliesToPost

boolean

None.

AppliesToPut

boolean

None.

AppliesToDelete

boolean

None.

Deleted

boolean

None.

DateCreated

date

None.

CreatedBy

string

Max length: 50

UpdatedOn

date

None.

UpdatedBy

string

Max length: 50

Request Formats

application/json, text/json

Sample:
{
  "BusinessRuleId": 1,
  "RuleName": "sample string 2",
  "Description": "sample string 3",
  "ApplicationScreenId": 4,
  "ApplicationScreen": {
    "$id": "2",
    "ScreenId": 1,
    "ScreenReferenceId": 2,
    "ScreenMenuTitle": "sample string 3",
    "ScreenMenuIcon": "sample string 4",
    "ScreenMenuItemGroup": "sample string 5",
    "ScreenName": "sample string 6",
    "ScreenTitle": "sample string 7",
    "ScreenDescription": "sample string 8",
    "ForMobile": true,
    "ForDesktop": true,
    "ForWeb": true,
    "DateCreated": "2026-01-11T20:34:46.7800833-05:00",
    "CreatedBy": "sample string 12",
    "UpdatedOn": "2026-01-11T20:34:46.7800833-05:00",
    "UpdatedBy": "sample string 13"
  },
  "RuleType": 0,
  "FieldId": "sample string 5",
  "Condition": "sample string 6",
  "ExpectedEvaluationResult": true,
  "Message": "sample string 8",
  "Deactivated": true,
  "AppliesToPost": true,
  "AppliesToPut": true,
  "AppliesToDelete": true,
  "Deleted": true,
  "DateCreated": "2026-01-11T20:34:46.7800833-05:00",
  "CreatedBy": "sample string 14",
  "UpdatedOn": "2026-01-11T20:34:46.7800833-05:00",
  "UpdatedBy": "sample string 15"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VEMModel.Logic.APIResponseClass
NameDescriptionTypeAdditional information
Result

VEMModel.Logic.ResultEnum

None.

Details

Object

None.

JsonData

Object

None.

ObjectType

string

None.

ruleEvaluationResults

Collection of VEMModel.Logic.RuleEvaluationResult

None.

Response Formats

application/json, text/json

Sample:
{
  "ruleEvaluationResults": [
    {
      "$id": "2",
      "Result": 0,
      "Message": "sample string 1",
      "fieldID": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "Result": 0,
  "Details": {
    "$id": "3"
  },
  "JsonData": {
    "$id": "4"
  },
  "ObjectType": "sample string 3"
}