REST API - View a list of questionnaires

Last modified on 2023/04/17 15:16
Contents

GET  /questionnaires

  • This method allows a list of questionnaires to be obtained.

Minimum version Service Manager:

  • To obtain detailed information for a specified questionnaire: GET /questionnaires/{questionnaire_id}. Open url.png See the method.

Notes

       Open url.png  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.
  • Default value: 100
  • example /questionnaires?max_rows=5
sort string Sort in ascending or descending order.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /questionnaires?sort=question_list_en+desc
fields string Select fields to display.
  • example /questionnaires?fields=question_list_en
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /questionnaires?search=question_list_en:"Oracle"
Oxygen 2.1.2 - Build 2018.1.183.0 search

(logical OR operator)

 string Search/filter to several values from a same field
  • Syntax: search=field:value1,field:value2
  • example
    • /questionnaires?search=question_list_en:Dell,question_list_en:Oracle ==> all the questionnaires in which the question_list_en field is equal to Dell or Oracle
Oxygène 1.7 - Build 2018.1.131.0 ~

(equivalent to like)

 string Include the results which begin with or contain a given character string.
  • Syntax: ~ following by the string to include enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = include what begins with < string >.
    • *< string >* = include what contains < string >.
  • example
    • /questionnaires?search=questionnaire_en~"Ora*" ==> all the questionnaires in which the question_list_en field begins with Ora
    • /questionnaires?search=questionnaire_en~"*acl*" ==> all the questionnaires in which the question_list_en field contains acl
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.
  • Syntax: !~ following by the string to exclude enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = exclude what begins with < string >.
    • *< string >* = exclude what contains < string >.
  • example
    • /questionnaires?search=questionnaire_en!~"Ora*" ==> all the questionnaires by excluding those in which the question_list_en field begins with Ora
    • /questionnaires?search=questionnaire_en!~"*acl*" ==> all the questionnaires by excluding those in which the question_list_en field contains al
Oxygen 1.7 - Build 2018.1.131.0 !

(equivalent to not)

 string Exclude all results equal to a given character string.
  • Syntax: ! following by the string to exclude enclosed in quotation marks.
  • example /questionnaires?search=question_list_en!"Oracle" ==> all the questionnaires by excluding those in which the question_list_en field is equal to Oracle
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)
  • Syntax: Field name following by "is_null"
  • example
    • /questionnaires?search=question_list_en:"is_null" ==> all the questionnaires in which the question_list_en field has no value
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)
  • Syntax: Field name following by "is_not_null"
  • example
    • /questionnaires?search=question_list_en:"is_not_null" ==> all the questionnaires in which the question_list_en field has a value
Oxygen 1.7 - Build 2018.1.131.0 formatDate string Format display of Date fields in the HTTP request result.   Open url.png See Description of the options.
  • example
    • /questionnaires?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /questionnaires?fields=last_update&formatDate=l jS \of F Y h:i:s A ==> "last_update_format": "Friday 16th of November 2018 12:00:00 AM"

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 for 2 questionnaires (status code 200)

{
   "record_count": "2",
   "total_record_count": "70",
   "records": [
        {
           "QUESTION_LIST_EN": "Oracle",
           "QUESTION_LIST_FR": "Oracle",
           "QUESTION_LIST_GE": "Oracle",
           "QUESTION_LIST_GUID": "{AE9DC99B-6C55-4193-B79E-B72DEF692432}",
           "QUESTION_LIST_ID": "1",
           "HREF": "http://{your_server}/api/v1/{your_account}/questionnaire/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_EN": "Change*",
           "QUESTION_LIST_FR": "Changement",
           "QUESTION_LIST_GE": "Veränderung",
           "QUESTION_LIST_GUID": "{8A8BAB49-487F-440B-9301-DFF61BFDE1CD}",
           "QUESTION_LIST_ID": "2",
           "HREF": "http://{your_server}/api/v1/{your_account}/questionnaire/2",
           "QUESTION_LIST_IT": "Cambiamento",
           "QUESTION_LIST_L1": "",
           "QUESTION_LIST_L2": "",
           "QUESTION_LIST_L3": "",
           "QUESTION_LIST_L4": "",
           "QUESTION_LIST_L5": "",
           "QUESTION_LIST_L6": "",
           "QUESTION_LIST_PO": "Alterações",
           "QUESTION_LIST_SP": "Cambio"
        }
    ],
   "HREF": "http://{your_server}/api/v1/{your_account}/questionnaire?max_rows=2"
}
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)"  }  }
Tags:
Powered by XWiki © EasyVista 2022