REST API - View a questionnaire
GET /questionnaires/{questionnaire_id}
- This method allows information for a specified questionnaire to be obtained.
example /questionnaires/1
Notes
See Service Manager REST API Conventions
- If successful, an HTTP status code 200 is returned.
- A URL link (HREF) to the resource is provided.
- All fields are provided, including e_field_name and available_field_x, except for certain sensitive fields reserved for EasyVista.
List of parameters / fields
Mandatory parameters
You must use the parameter below in the URL.
Parameter | Type | Description / Example |
---|---|---|
questionnaire_id | integer | Questionnaire key. |
Optional parameters
You can use the parameters detailed below in the HTTP request string.
Version minimum | Parameter | Type | Description / Example | ||
---|---|---|---|---|---|
fields | string | Select fields to display.
|
|||
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_LIST 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}/questionnaire/1",
"CAPTION_EN": "",
"CAPTION_FR": "",
"CAPTION_GE": "",
"CAPTION_IT": "",
"CAPTION_L1": "",
"CAPTION_L2": "",
"CAPTION_L3": "",
"CAPTION_L4": "",
"CAPTION_L5": "",
"CAPTION_L6": "",
"CAPTION_PO": "",
"CAPTION_SP": "",
"LAST_UPDATE": "2019-11-06",
"QUESTION_LIST_EN": "Oracle",
"QUESTION_LIST_FR": "Oracle",
"QUESTION_LIST_GE": "Oracle",
"QUESTION_LIST_GUID": "{AE9DC99B-6C55-4193-B79E-B72DEF692432}",
"QUESTION_LIST_ID": "1",
"QUESTION_LIST_IT": "Oracle",
"QUESTION_LIST_L1": "",
"QUESTION_LIST_L2": "",
"QUESTION_LIST_L3": "",
"QUESTION_LIST_L4": "",
"QUESTION_LIST_L5": "",
"QUESTION_LIST_L6": "",
"QUESTION_LIST_PO": "Oracle",
"QUESTION_LIST_SP": "Oracle",
"QUESTION_LIST_TYPE": "",
"TARGET_TABLE": "",
"UPDATED_BY": ""
}
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)" } } |