Claim Rule Procedures

Create ClaimRuleProcedure

Creates a new ClaimRuleProcedure

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimRuleKey
required
integer <int32>

ClaimRule Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimRule_Key
required
integer <int32>
from_Procedure
required
string [ 1 .. 8 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
exclude
required
boolean
thru_Procedure
required
string [ 1 .. 8 ] characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-rules/{claimRuleKey}/procedures
Request samples
{
  • "claimRule_Key": 0,
  • "from_Procedure": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimRuleProcedure

Lists all ClaimRuleProcedure for the given claimRuleKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
claimRuleKey
required
integer <int32>

ClaimRule Key

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-rules/{claimRuleKey}/procedures
Request samples 
Response samples 
No sample
Get ClaimRuleProcedure
Gets ClaimRuleProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-rules/{claimRuleKey}/procedures/{fromProcedure}
Request samples 
Response samples 
No sample
Update ClaimRuleProcedure
Updates a specific ClaimRuleProcedure.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimRule_Key
required
integer <int32> 
 
from_Procedure
required
string  [ 1 .. 8 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
exclude
required
boolean
 
thru_Procedure
required
string  [ 1 .. 8 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/claim-rules/{claimRuleKey}/procedures/{fromProcedure}
Request samples 
{
  • "claimRule_Key": 0,
  • "from_Procedure": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimRuleProcedure
Deletes an ClaimRuleProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-rules/{claimRuleKey}/procedures/{fromProcedure}
Request samples 
Create or Update Batch ClaimRuleProcedure
Create or Update multiple ClaimRuleProcedure at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimRuleKey
required
integer <int32> 
ClaimRule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
claimRule_Key
required
integer <int32> 
 
from_Procedure
required
string  [ 1 .. 8 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
exclude
required
boolean
 
thru_Procedure
required
string  [ 1 .. 8 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/claim-rules/{claimRuleKey}/procedures-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}