Request

Create Request

Creates a new Request

SecurityapiKeyAuth
Request
header Parameters
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Request Body schema:
required
request_Key
required
integer <int32>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

dismiss_Date
string or null <date-time>
owner_UserId
string or null <uuid>
request_Date
string or null <date-time>
request_Description
string or null <= 512 characters
request_JSON
string or null

Note: The database will apply a default value of {} for this field if a value is not provided.

request_Priority
string or null <= 32 characters
request_Source
string or null <= 32 characters
request_Status
string or null <= 32 characters
request_Type
string or null <= 32 characters
userId
required
string <uuid>

Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/requests
Request samples
{
  • "request_Key": 0,
  • "dismiss_Date": "2019-08-24T14:15:22Z",
  • "owner_UserId": "d5147461-f75a-4081-ab73-6b529801c972",
  • "request_Date": "2019-08-24T14:15:22Z",
  • "request_Description": "string",
  • "request_JSON": "string",
  • "request_Priority": "string",
  • "request_Source": "string",
  • "request_Status": "string",
  • "request_Type": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Request

Lists all Request

SecurityapiKeyAuth
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
vbagateway-client-id
required
string

Client ID

vbagateway-client-code
required
string

Client code

vbagateway-user-id
required
string

User ID

vbagateway-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/requests
Request samples 
Response samples 
No sample
Get Request
Gets Request


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/requests/{Request_Key}
Request samples 
Response samples 
No sample
Update Request
Updates a specific Request.


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
request_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
dismiss_Date
string or null <date-time> 
 
owner_UserId
string or null <uuid> 
 
request_Date
string or null <date-time> 
 
request_Description
string or null  <= 512 characters 
 
request_JSON
string or null
Note: The database will apply a default value of {} for this field if a value is not provided.


 
request_Priority
string or null  <= 32 characters 
 
request_Source
string or null  <= 32 characters 
 
request_Status
string or null  <= 32 characters 
 
request_Type
string or null  <= 32 characters 
 
userId
required
string <uuid> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/requests/{Request_Key}
Request samples 
{
  • "request_Key": 0,
  • "dismiss_Date": "2019-08-24T14:15:22Z",
  • "owner_UserId": "d5147461-f75a-4081-ab73-6b529801c972",
  • "request_Date": "2019-08-24T14:15:22Z",
  • "request_Description": "string",
  • "request_JSON": "string",
  • "request_Priority": "string",
  • "request_Source": "string",
  • "request_Status": "string",
  • "request_Type": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Request
Deletes an Request


SecurityapiKeyAuth 
Request 
path Parameters
Request_Key
required
integer <int32> 
Request Key


 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/requests/{Request_Key}
Request samples 
Create or Update Batch Request
Create or Update multiple Request at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth 
Request 
header Parameters
vbagateway-client-id
required
string
Client ID


 
vbagateway-client-code
required
string
Client code


 
vbagateway-user-id
required
string
User ID


 
vbagateway-database
required
string
Target database


 
Request Body schema: 
required
 Array 
request_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
dismiss_Date
string or null <date-time> 
 
owner_UserId
string or null <uuid> 
 
request_Date
string or null <date-time> 
 
request_Description
string or null  <= 512 characters 
 
request_JSON
string or null
Note: The database will apply a default value of {} for this field if a value is not provided.


 
request_Priority
string or null  <= 32 characters 
 
request_Source
string or null  <= 32 characters 
 
request_Status
string or null  <= 32 characters 
 
request_Type
string or null  <= 32 characters 
 
userId
required
string <uuid> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


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