Auth Review

Create AuthReview

Creates a new AuthReview.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
authReview_Key
required
integer <int32>

Unique identifier for each record.

auth_Number
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the authorization.

review_Comment
string or null <= 512 characters

Allows the reviewing User to add any additional information to the review.

review_Date
string or null <date-time>

Date when the authorization was reviewed.

review_Level
string or null <= 32 characters

Level of the review. This is configurable in 'Auth Configuration'.

review_Severity
string or null <= 32 characters

Severity of the review. This is configurable in 'Auth Configuration'.

review_Status
string or null <= 32 characters

Status of the review. This is configurable in 'Auth Configuration'.

review_Type
string or null <= 32 characters

Type of the review. This is configurable in 'Auth Configuration'.

review_Urgency_Type
string or null <= 32 characters

Urgency type of the review. This is configurable in 'Auth Configuration'.

review_User
string or null <= 20 characters

ID of the User who reviewed the authorization.

Responses
200

Success

401

Unauthorized

post/auth-reviews
Request samples
{
  • "authReview_Key": 0,
  • "auth_Number": "string",
  • "review_Comment": "string",
  • "review_Date": "2019-08-24T14:15:22Z",
  • "review_Level": "string",
  • "review_Severity": "string",
  • "review_Status": "string",
  • "review_Type": "string",
  • "review_Urgency_Type": "string",
  • "review_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List AuthReviews

Lists all AuthReviews

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
authNumber
string

Auth Number

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/auth-reviews
Request samples 
Response samples 
No sample
Get AuthReview
Gets AuthReview


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authReviewKey
required
integer <int32> 
AuthReview Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/auth-reviews/{authReviewKey}
Request samples 
Response samples 
No sample
Update AuthReview
Updates a specific AuthReview.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authReviewKey
required
integer <int32> 
AuthReview Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
authReview_Key
required
integer <int32> 
Unique identifier for each record.


 
auth_Number
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the authorization.


 
review_Comment
string or null  <= 512 characters 
Allows the reviewing User to add any additional information to the review.


 
review_Date
string or null <date-time> 
Date when the authorization was reviewed.


 
review_Level
string or null  <= 32 characters 
Level of the review. This is configurable in 'Auth Configuration'.


 
review_Severity
string or null  <= 32 characters 
Severity of the review. This is configurable in 'Auth Configuration'.


 
review_Status
string or null  <= 32 characters 
Status of the review. This is configurable in 'Auth Configuration'.


 
review_Type
string or null  <= 32 characters 
Type of the review. This is configurable in 'Auth Configuration'.


 
review_Urgency_Type
string or null  <= 32 characters 
Urgency type of the review. This is configurable in 'Auth Configuration'.


 
review_User
string or null  <= 20 characters 
ID of the User who reviewed the authorization.


 
Responses 
200
Success


401
Unauthorized


put/auth-reviews/{authReviewKey}
Request samples 
{
  • "authReview_Key": 0,
  • "auth_Number": "string",
  • "review_Comment": "string",
  • "review_Date": "2019-08-24T14:15:22Z",
  • "review_Level": "string",
  • "review_Severity": "string",
  • "review_Status": "string",
  • "review_Type": "string",
  • "review_Urgency_Type": "string",
  • "review_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete AuthReview
Deletes an AuthReview


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authReviewKey
required
integer <int32> 
AuthReview Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/auth-reviews/{authReviewKey}
Request samples 
Update Batch AuthReview
Updates a multiple AuthReview.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
authReview_Key
required
integer <int32> 
Unique identifier for each record.


 
auth_Number
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the authorization.


 
review_Comment
string or null  <= 512 characters 
Allows the reviewing User to add any additional information to the review.


 
review_Date
string or null <date-time> 
Date when the authorization was reviewed.


 
review_Level
string or null  <= 32 characters 
Level of the review. This is configurable in 'Auth Configuration'.


 
review_Severity
string or null  <= 32 characters 
Severity of the review. This is configurable in 'Auth Configuration'.


 
review_Status
string or null  <= 32 characters 
Status of the review. This is configurable in 'Auth Configuration'.


 
review_Type
string or null  <= 32 characters 
Type of the review. This is configurable in 'Auth Configuration'.


 
review_Urgency_Type
string or null  <= 32 characters 
Urgency type of the review. This is configurable in 'Auth Configuration'.


 
review_User
string or null  <= 20 characters 
ID of the User who reviewed the authorization.


 
Responses 
207
Success


401
Unauthorized


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