Security Areas

Create SecurityArea

Creates a new SecurityArea

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
security_Area
required
string [ 1 .. 16 ] characters

Name of the security area that the displayed security options will apply to.

description
string or null <= 64 characters

Description of the security area.

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

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

Responses
200

Success

401

Unauthorized

post/security-areas
Request samples
{
  • "security_Area": "string",
  • "description": "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 SecurityArea

Lists all SecurityArea

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/security-areas
Request samples 
Response samples 
No sample
Get SecurityArea
Gets SecurityArea


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-areas/{securityArea}
Request samples 
Response samples 
No sample
Update SecurityArea
Updates a specific SecurityArea.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
security_Area
required
string  [ 1 .. 16 ] characters 
Name of the security area that the displayed security options will apply to.


 
description
string or null  <= 64 characters 
Description of the security area.


 
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


 
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


 
Responses 
200
Success


401
Unauthorized


put/security-areas/{securityArea}
Request samples 
{
  • "security_Area": "string",
  • "description": "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 SecurityArea
Deletes an SecurityArea


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-areas/{securityArea}
Request samples 
Create or Update Batch SecurityArea
Create or Update multiple SecurityArea 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 
security_Area
required
string  [ 1 .. 16 ] characters 
Name of the security area that the displayed security options will apply to.


 
description
string or null  <= 64 characters 
Description of the security area.


 
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


 
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


 
Responses 
207
Success


401
Unauthorized


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