Security Area Objects

Create SecurityAreaObject

Creates a new SecurityAreaObject

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.

object_Name
required
string [ 1 .. 128 ] characters

Name of the object from the object list. The purpose of this list is to allow the Administrator to select which objects will be contained within the associated ‘Security Area’. The User may select objects from this list, right-click, and select 'Apply Selected' from the context menu.

Responses
200

Success

401

Unauthorized

post/security-areas/{securityArea}/objects
Request samples
{
  • "security_Area": "string",
  • "object_Name": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SecurityAreaObject

Lists all SecurityAreaObject 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}/objects
Request samples 
Response samples 
No sample
Create or Update Batch SecurityAreaObject
Create or Update multiple SecurityAreaObject 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
securityArea
required
string
Security Area


 
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.


 
object_Name
required
string  [ 1 .. 128 ] characters 
Name of the object from the object list. The purpose of this list is to allow the Administrator to select which objects will be contained within the associated ‘Security Area’. The User may select objects from this list, right-click, and select 'Apply Selected' from the context menu.


 
Responses 
207
Success


401
Unauthorized


put/security-areas/{securityArea}/objects
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get SecurityAreaObject
Gets SecurityAreaObject


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
objectName
required
string
Object Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
objectName
required
string
Object Name


 
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.


 
object_Name
required
string  [ 1 .. 128 ] characters 
Name of the object from the object list. The purpose of this list is to allow the Administrator to select which objects will be contained within the associated ‘Security Area’. The User may select objects from this list, right-click, and select 'Apply Selected' from the context menu.


 
Responses 
200
Success


401
Unauthorized


put/security-areas/{securityArea}/objects/{objectName}
Request samples 
{
  • "security_Area": "string",
  • "object_Name": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SecurityAreaObject
Deletes an SecurityAreaObject


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
objectName
required
string
Object Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-areas/{securityArea}/objects/{objectName}
Request samples