Getting a List of Keep Alert Questions
This section describes the App Broker REST API endpoint to get a list of the questions that a user is required to answer when responding to a keep alert.
Endpoint Example: [GET] http://localhost/esd/api/alerts/22184/keepquestions
Response Body Example:
[
{
"id": 7,
"name": "KeepQuestion1",
"type": "dropDownList",
"description": "Please select the reason for keeping",
"isRequired": true,
"isMaskInput": false,
"focus": "requestSpecific",
"target": "requester",
"answers": [
{
"id": 13,
"text": "I use this software regularly",
"value": "I use this software regularly",
"isDefault": false
},
{
"id": 16,
"text": "Other",
"value": "Other",
"isDefault": false
}
],
"conditionals": [
{
"questionID": 8,
"value": " Other"
}
]
},
{
"id": 8,
"name": "KeepQuestion2",
"type": "multiLine",
"description": "Please specify the reason",
"isRequired": true,
"isMaskInput": false,
"focus": "requestSpecific",
"target": "requester",
"conditionals": [
{
"questionID": 7,
"value": "Other"
}
]
}
]
Keep Alert Question Metadata
This section describes the keep alert question metadata that is returned.
| Item | Description |
|---|---|
| id | Unique identifier of alert resource. |
| name | Name of question. |
| type | User interface format of question, such as dropDownList or multiLine. |
| description | Description of question. |
| isRequired | Specifies ( true or false ) whether a response is required. |
| isMaskInput | Specifies ( true or false ) whether content should be masked in the user interface (such as for a password field). |
| focus | Specifies the bundle format of the question as one of the following:
|
| target | Specifies the appropriate audience for the question as one of the following:
|
| answers | Provides the following information about the response choices:
|
| conditionals | Provides the identifier for the question and conditional value:
|