Security Area Reports

Create SecurityAreaReport

Creates a new SecurityAreaReport

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

Security area that the report is being applied to/removed from.

reportDefinition_Key
required
integer <int32>

Name of the report that is being applied or removed from the security area. 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

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/{securityArea}/reports
Request samples
{
  • "security_Area": "string",
  • "reportDefinition_Key": 0,
  • "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 SecurityAreaReport

Lists all SecurityAreaReport 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}/reports
Request samples 
Response samples 
No sample
Create or Update Batch SecurityAreaReport
Create or Update multiple SecurityAreaReport 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 
Security area that the report is being applied to/removed from.


 
reportDefinition_Key
required
integer <int32> 
Name of the report that is being applied or removed from the security area. 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


 
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/{securityArea}/reports
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get SecurityAreaReport
Gets SecurityAreaReport


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
security_Area
required
string  [ 1 .. 16 ] characters 
Security area that the report is being applied to/removed from.


 
reportDefinition_Key
required
integer <int32> 
Name of the report that is being applied or removed from the security area. 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


 
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}/reports/{reportDefinitionKey}
Request samples 
{
  • "security_Area": "string",
  • "reportDefinition_Key": 0,
  • "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 SecurityAreaReport
Deletes an SecurityAreaReport


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-areas/{securityArea}/reports/{reportDefinitionKey}
Request samples