REST API - View a list of questions associated with all questionnaires
GET /questions-questionnaire
- This method allows all questions for all questionnaires to be obtained.
- To obtain a list of questions for a specified questionnaire: GET /questions-questionnaire/{questionnaire_id} -
See the method
Notes
see Service Manager REST API Conventions
- If successful, an HTTP status code 200 is returned.
- By default, if the optional parameter fields is not used, only an extract of the most useful fields selected by EasyVista is displayed for each record provided.
- A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained.
List of parameters / fields
Mandatory parameters
None
Optional parameters
You can use the parameters detailed below in the HTTP request string.
Minimum version | Parameter | Type | Description / Example | ||
---|---|---|---|---|---|
max_rows | integer | Maximum number of records to display.
|
|||
sort | string | Sort in ascending or descending order.
|
|||
fields | string | Select fields to display.
|
|||
search | string | Search/filter the specified fields. ![]()
|
|||
Oxygen 2.1.2 - Build 2018.1.183.0 | search
(logical OR operator) |
string | Search/filter to several values from a same field
|
||
Oxygen 1.7 - Build 2018.1.131.0 | ~
(equivalent to like) |
string | Include the results which begin with or contain a given character string.
|
||
Oxygen 1.7 - Build 2018.1.131.0 | !~
(equivalent to not like) |
string | Exclude the results which begin with or contain a given character string.
|
||
Oxygen 1.7 - Build 2018.1.131.0 | !
(equivalent to not) |
string | Exclude all results equal to a given character string.
|
||
Oxygen 2.1.2 - Build 2018.1.183.0 | is_null | string | Retrieve all results in which the field has no value (field value = null)
|
||
Oxygen 2.1.2 - Build 2018.1.183.0 | is_not_null | string | Retrieve all results in which the field has a value (field value = not null)
|
||
Oxygen 1.7 - Build 2018.1.131.0 | formatDate | string | Format display of Date fields in the HTTP request result. ![]()
|
Fields that could be used in optional parameters
You can use all the fields from the SD_QUESTION_RESULT table.
HTTP status codes for the method
StatusHeader
Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).
Code | Error | Description |
---|
Status200
200 | OK (Successful) | Request successfully processed. |
Status401
401 | Unauthorized | Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.
example { "error": "Invalid Login / Password" } |
Example
Result with a status code 200 returned
"HREF": "https://{your_server}/api/v1/{your_account}/QUESTIONS-QUESTIONNAIRE?max_rows=2",
"record_count": "2",
"total_record_count": "80",
"records": [
{
"HREF": "https://{your_server}/api/v1/{your_account}/questions-questionnaire/1",
"DISPLAY_ORDER": "1",
"QUESTION_LIST_ID": "1",
"QUESTION": {
"DEPENDS_ON_ANOTHER_QUESTION": "",
"IS_REST_SUPPORTED": "1",
"IS_VARIABLE": "",
"QUESTION_CODE": "",
"QUESTION_EN": "Patch ID",
"QUESTION_FR": "Numéro de patch",
"QUESTION_GE": "Verbesserungsnummer",
"QUESTION_GUID": "{5572E6AC-979C-4722-A05C-B6E6D65CC8CB}",
"HREF": "https://{your_server}/api/v1/{your_account}/question/6",
"QUESTION_ID": "6",
"QUESTION_IT": "Patch ID",
"QUESTION_L1": "",
"QUESTION_L2": "",
"QUESTION_L3": "",
"QUESTION_L4": "",
"QUESTION_L5": "",
"QUESTION_L6": "",
"QUESTION_PO": "Patch ID",
"QUESTION_SP": "Número de Parche",
"VALUE_TYPE": "text"
}
},
{
"HREF": "https://{your_server}/api/v1/{your_account}/questions-questionnaire/1",
"DISPLAY_ORDER": "2",
"QUESTION_LIST_ID": "1",
"QUESTION": {
"DEPENDS_ON_ANOTHER_QUESTION": "",
"IS_REST_SUPPORTED": "1",
"IS_VARIABLE": "",
"QUESTION_CODE": "",
"QUESTION_EN": "Availability Date",
"QUESTION_FR": "Date de mise à disposition du patch par l'éditeur",
"QUESTION_GE": "Verfügbarkeitsdatum",
"QUESTION_GUID": "{FFE07814-580F-4619-B3E6-62B001EC5C90}",
"HREF": "https://{your_server}/api/v1/{your_account}/question/8",
"QUESTION_ID": "8",
"QUESTION_IT": "Disponibilità della patch",
"QUESTION_L1": "",
"QUESTION_L2": "",
"QUESTION_L3": "",
"QUESTION_L4": "",
"QUESTION_L5": "",
"QUESTION_L6": "",
"QUESTION_PO": "Availability Date",
"QUESTION_SP": "Fecha de Disponibilidad",
"VALUE_TYPE": "date"
}
}
]
}
ConventionsAPI
REST API Conventions
Convention | Meaning | |
---|---|---|
Orange | Parameters used in an HTTP request string which do not correspond to Service Manager database fields.
example Method View a list of assets https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag |
|
Black and Bold | Parameters used in the URL of an HTTP request which correspond to Service Manager database fields.
example Method View an asset https://{your_server}/api/v1/{your_account}/assets/{asset_id} |
|
Green | Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified.
example Method Close an incident/request { "closed": { "end_date": "11/20/2016 12:12:12", } } |
|
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.
example Method Reopen an incident/request { "restarted": { "comment": "string (required)" } } |