RequestStatus

Create RequestStatus

Creates a new RequestStatus

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_Status
required
string [ 1 .. 32 ] characters
description
string or null <= 256 characters
Responses
200

Success

401

Unauthorized

post/request-statuses
Request samples
{
  • "request_Status": "string",
  • "description": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List RequestStatus

Lists all RequestStatus

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/request-statuses
Request samples
Response samples
No sample

Get RequestStatus

Gets RequestStatus

SecurityapiKeyAuth
Request
path Parameters
Request_Status
required
string

Request Status

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/request-statuses/{Request_Status}
Request samples
Response samples
No sample

Update RequestStatus

Updates a specific RequestStatus.

SecurityapiKeyAuth
Request
path Parameters
Request_Status
required
string

Request Status

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_Status
required
string [ 1 .. 32 ] characters
description
string or null <= 256 characters
Responses
200

Success

401

Unauthorized

put/request-statuses/{Request_Status}
Request samples
{
  • "request_Status": "string",
  • "description": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete RequestStatus

Deletes an RequestStatus

SecurityapiKeyAuth
Request
path Parameters
Request_Status
required
string

Request Status

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/request-statuses/{Request_Status}
Request samples

Create or Update Batch RequestStatus

Create or Update multiple RequestStatus 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_Status
required
string [ 1 .. 32 ] characters
description
string or null <= 256 characters
Responses
207

Success

401

Unauthorized

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