Claim Rule Set Headers

Create ClaimRuleSetHeader

Creates a new ClaimRuleSetHeader

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimRuleSetHeader_Key
required
integer <int32>
business_Object
string or null <= 64 characters
description
string or null <= 128 characters
display
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/claim-rule-set-headers
Request samples
{
  • "claimRuleSetHeader_Key": 0,
  • "business_Object": "string",
  • "description": "string",
  • "display": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimRuleSetHeader

Lists all ClaimRuleSetHeader

SecurityapiKeyAuth and bearerAuth
Request
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-rule-set-headers
Request samples
Response samples
No sample

Get ClaimRuleSetHeader

Gets ClaimRuleSetHeader

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

ClaimRuleSetHeader Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-rule-set-headers/{claimRuleSetHeaderKey}
Request samples
Response samples
No sample

Update ClaimRuleSetHeader

Updates a specific ClaimRuleSetHeader.

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

ClaimRuleSetHeader Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimRuleSetHeader_Key
required
integer <int32>
business_Object
string or null <= 64 characters
description
string or null <= 128 characters
display
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/claim-rule-set-headers/{claimRuleSetHeaderKey}
Request samples
{
  • "claimRuleSetHeader_Key": 0,
  • "business_Object": "string",
  • "description": "string",
  • "display": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ClaimRuleSetHeader

Deletes an ClaimRuleSetHeader

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

ClaimRuleSetHeader Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/claim-rule-set-headers/{claimRuleSetHeaderKey}
Request samples

Create or Update Batch ClaimRuleSetHeader

Create or Update multiple ClaimRuleSetHeader at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
claimRuleSetHeader_Key
required
integer <int32>
business_Object
string or null <= 64 characters
description
string or null <= 128 characters
display
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/claim-rule-set-headers-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}