Skip to content

Create ClaimRule

Request

Creates a new ClaimRule

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
claimRule_Keyinteger, (int32)required
claimRule_Objectstring or null, <= 64 characters
claimRule_Resultstring or null, <= 1 characters
debugbooleanrequired
descriptionstring or null, <= 512 characters
displaystring or null, <= 64 characters
entry_Datestring, (date-time)
entry_Userstring or null, <= 20 characters
error_Codestring or null, <= 8 characters
error_Typestring or null, <= 32 characters
ex_Codestring or null, <= 6 characters
process_If_Errorbooleanrequired
process_If_Overridebooleanrequired
requiredbooleanrequired
system_Rulebooleanrequired
update_Datestring, (date-time)
update_Userstring or null, <= 20 characters
curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/claim-rules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "claimRule_Key": 0,
    "claimRule_Object": "string",
    "claimRule_Result": "s",
    "debug": true,
    "description": "string",
    "display": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "error_Code": "string",
    "error_Type": "string",
    "ex_Code": "string",
    "process_If_Error": true,
    "process_If_Override": true,
    "required": true,
    "system_Rule": true,
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}