Security Field User Groups

Create SecurityFieldUserGroup

Creates a new SecurityFieldUserGroup

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
securityFieldUserGroup_Key
required
integer <int32>

Unique identifier for the Security Field User Group entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

field_Access
string or null <= 16 characters

Type of Field access that is applied. Only two values: VIEW or VIEW_MASK. VIEW locks the field down but shows the information in the field. VIEW_MASK allow the field to be viewed only but also the information is masked.

field_Mask
string or null <= 512 characters

Identifies the type of Mask applied to this feild. For now, only two values apply: SSN or ALL. SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.

securityFieldSet_ID
string or null <= 32 characters

Unique identifier for the Security Field Set entry.

securityField_ID
string or null <= 32 characters

Unique identifier for the Security Field entry.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

userGroup_Key
required
integer <int32>

ID of the User Group that the level is being set for. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/security-field-user-groups
Request samples
{
  • "securityFieldUserGroup_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "field_Access": "string",
  • "field_Mask": "string",
  • "securityFieldSet_ID": "string",
  • "securityField_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "userGroup_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SecurityFieldUserGroup

Lists all SecurityFieldUserGroup

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/security-field-user-groups
Request samples 
Response samples 
No sample
Get SecurityFieldUserGroup
Gets SecurityFieldUserGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SecurityFieldUserGroup_Key
required
integer <int32> 
SecurityFieldUserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-field-user-groups/{SecurityFieldUserGroup_Key}
Request samples 
Response samples 
No sample
Update SecurityFieldUserGroup
Updates a specific SecurityFieldUserGroup.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SecurityFieldUserGroup_Key
required
integer <int32> 
SecurityFieldUserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
securityFieldUserGroup_Key
required
integer <int32> 
Unique identifier for the Security Field User Group entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
field_Access
string or null  <= 16 characters 
Type of Field access that is applied.  Only two values:  VIEW or VIEW_MASK.  VIEW locks the field down but shows the information in the field.  VIEW_MASK allow the field to be viewed only but also the information is masked.


 
field_Mask
string or null  <= 512 characters 
Identifies the type of Mask applied to this feild.  For now, only two values apply:  SSN or ALL.  SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.


 
securityFieldSet_ID
string or null  <= 32 characters 
Unique identifier for the Security Field Set entry.


 
securityField_ID
string or null  <= 32 characters 
Unique identifier for the Security Field entry.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
userGroup_Key
required
integer <int32> 
ID of the User Group that the level is being set for. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/security-field-user-groups/{SecurityFieldUserGroup_Key}
Request samples 
{
  • "securityFieldUserGroup_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "field_Access": "string",
  • "field_Mask": "string",
  • "securityFieldSet_ID": "string",
  • "securityField_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "userGroup_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SecurityFieldUserGroup
Deletes an SecurityFieldUserGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
SecurityFieldUserGroup_Key
required
integer <int32> 
SecurityFieldUserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-field-user-groups/{SecurityFieldUserGroup_Key}
Request samples 
Create or Update Batch SecurityFieldUserGroup
Create or Update multiple SecurityFieldUserGroup 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 
securityFieldUserGroup_Key
required
integer <int32> 
Unique identifier for the Security Field User Group entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
field_Access
string or null  <= 16 characters 
Type of Field access that is applied.  Only two values:  VIEW or VIEW_MASK.  VIEW locks the field down but shows the information in the field.  VIEW_MASK allow the field to be viewed only but also the information is masked.


 
field_Mask
string or null  <= 512 characters 
Identifies the type of Mask applied to this feild.  For now, only two values apply:  SSN or ALL.  SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.


 
securityFieldSet_ID
string or null  <= 32 characters 
Unique identifier for the Security Field Set entry.


 
securityField_ID
string or null  <= 32 characters 
Unique identifier for the Security Field entry.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
userGroup_Key
required
integer <int32> 
ID of the User Group that the level is being set for. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/security-field-user-groups-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}