RequestQuestionConfig

Create RequestQuestionConfig

Creates a new RequestQuestionConfig

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
requestQuestionConfig_Key
required
integer <int32>

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

answer_Text
string or null <= 512 characters
answer_Type
string or null <= 32 characters
config_String
required
string non-empty
dateAnswer
string or null <= 1 characters
multiAnswer
string or null <= 1 characters
multiList
string or null
numericAnswer
string or null <= 1 characters
question
string or null <= 512 characters
question_Seq
required
integer <int32>

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

radioAnswer
string or null <= 1 characters
radioList
string or null
request_Type
string or null <= 32 characters
require_Answer
string or null <= 1 characters
terminal
string or null <= 32 characters
textAnswer
string or null <= 1 characters
yesNoAnswer
string or null <= 1 characters
Responses
200

Success

401

Unauthorized

post/request-question-configs
Request samples
{
  • "requestQuestionConfig_Key": 0,
  • "answer_Text": "string",
  • "answer_Type": "string",
  • "config_String": "string",
  • "dateAnswer": "s",
  • "multiAnswer": "s",
  • "multiList": "string",
  • "numericAnswer": "s",
  • "question": "string",
  • "question_Seq": 0,
  • "radioAnswer": "s",
  • "radioList": "string",
  • "request_Type": "string",
  • "require_Answer": "s",
  • "terminal": "string",
  • "textAnswer": "s",
  • "yesNoAnswer": "s"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List RequestQuestionConfig

Lists all RequestQuestionConfig

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-question-configs
Request samples 
Response samples 
No sample
Get RequestQuestionConfig
Gets RequestQuestionConfig


SecurityapiKeyAuth 
Request 
path Parameters
RequestQuestionConfig_Key
required
integer <int32> 
RequestQuestionConfig 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/request-question-configs/{RequestQuestionConfig_Key}
Request samples 
Response samples 
No sample
Update RequestQuestionConfig
Updates a specific RequestQuestionConfig.


SecurityapiKeyAuth 
Request 
path Parameters
RequestQuestionConfig_Key
required
integer <int32> 
RequestQuestionConfig 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
requestQuestionConfig_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
answer_Text
string or null  <= 512 characters 
 
answer_Type
string or null  <= 32 characters 
 
config_String
required
string  non-empty 
 
dateAnswer
string or null  <= 1 characters 
 
multiAnswer
string or null  <= 1 characters 
 
multiList
string or null
 
numericAnswer
string or null  <= 1 characters 
 
question
string or null  <= 512 characters 
 
question_Seq
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
radioAnswer
string or null  <= 1 characters 
 
radioList
string or null
 
request_Type
string or null  <= 32 characters 
 
require_Answer
string or null  <= 1 characters 
 
terminal
string or null  <= 32 characters 
 
textAnswer
string or null  <= 1 characters 
 
yesNoAnswer
string or null  <= 1 characters 
 
Responses 
200
Success


401
Unauthorized


put/request-question-configs/{RequestQuestionConfig_Key}
Request samples 
{
  • "requestQuestionConfig_Key": 0,
  • "answer_Text": "string",
  • "answer_Type": "string",
  • "config_String": "string",
  • "dateAnswer": "s",
  • "multiAnswer": "s",
  • "multiList": "string",
  • "numericAnswer": "s",
  • "question": "string",
  • "question_Seq": 0,
  • "radioAnswer": "s",
  • "radioList": "string",
  • "request_Type": "string",
  • "require_Answer": "s",
  • "terminal": "string",
  • "textAnswer": "s",
  • "yesNoAnswer": "s"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete RequestQuestionConfig
Deletes an RequestQuestionConfig


SecurityapiKeyAuth 
Request 
path Parameters
RequestQuestionConfig_Key
required
integer <int32> 
RequestQuestionConfig 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/request-question-configs/{RequestQuestionConfig_Key}
Request samples 
Create or Update Batch RequestQuestionConfig
Create or Update multiple RequestQuestionConfig 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 
requestQuestionConfig_Key
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
answer_Text
string or null  <= 512 characters 
 
answer_Type
string or null  <= 32 characters 
 
config_String
required
string  non-empty 
 
dateAnswer
string or null  <= 1 characters 
 
multiAnswer
string or null  <= 1 characters 
 
multiList
string or null
 
numericAnswer
string or null  <= 1 characters 
 
question
string or null  <= 512 characters 
 
question_Seq
required
integer <int32> 
Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
radioAnswer
string or null  <= 1 characters 
 
radioList
string or null
 
request_Type
string or null  <= 32 characters 
 
require_Answer
string or null  <= 1 characters 
 
terminal
string or null  <= 32 characters 
 
textAnswer
string or null  <= 1 characters 
 
yesNoAnswer
string or null  <= 1 characters 
 
Responses 
207
Success


401
Unauthorized


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