REST API - View a list of questions associated with a questionnaire

Last modified on 2023/09/27 16:03

Minimum version Service Manager : 2023.2 - Build 2023.2.111.0

GET  /questions-questionnaire/{questionnaire_id}

  • This method allows a list of questions for a specified questionnaire to be obtained.
        example    /questions-questionnaire/123

Notes

     Open url.png  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 identifier

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 /questions-questionnaire/123?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /questions-questionnaire/123?sort=question_list_id+asc
fields string Select fields to display.
  • example /questions-questionnaire/123?fields=email
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /questions-questionnaire/123?search=question.question_en:"Cause of change"
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
    • /questions-questionnaire/123?search=question.question_en:"Cause of change", question.question_en:"Product" ==> all the questions for the 123 questionnaire in which the question_en field is equal to Cause of change or Product
Oxygen 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
    • /questions-questionnaire/123?search=question.question_en~"cause*" ==> all the questions for the 123 questionnaire in which the question_en field begins with cause
    • /questions-questionnaire/123?search=question.question_en~"*oup* ==> all the questions for the 123 questionnaire in which the question_en field contains oup
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
    • /questions-questionnaire/123?search=question.question_en!~"group*" ==> all the questions for the 123 questionnaire by excluding those in which the question_en field begins with group
    • /questions-questionnaire/123?search=question.question_en!~"*oup*" ==> all the questions for the 123 questionnaire by excluding those in which the question_en field contains oup
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 /questions-questionnaire/123?search=question.question_en!"Cause of change" ==> all the questions for the 123 questionnaire by excluding those in which the question_en field is equal to Cause of change
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
    • /questions-questionnaire/123?search=question.question_en:"is_null" ==> all the questions for the 123 questionnaire in which the question_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
    • /questions-questionnaire/123?search=question.question_en:"is_not_null" ==> all the questions for the 123 questionnaire in which the question_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
    • /questions-questionnaire/123?fields=start_date&formatDate=l/M/Y ==> "start_date_format": "Friday/Feb/2023"
    • /questions-questionnaire/123?fields=start_date&formatDate=l jS \of F Y h:i:s A ==> "start_date_format": "Friday 17th of February 2023 12:00:00 AM"

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

   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/1?max_rows=2",
   "record_count": "2",
   "total_record_count": "6",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/questions-questionnaire/1",
           "ALONE": "",
           "ANSWER_CANNOT_BE_MODIFIED": "",
           "CONDITION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/questions_questionnaire/1/condition"
            },
           "CONSTRAINT_MESSAGE_EN": "",
           "CONSTRAINT_MESSAGE_FR": "",
           "CONSTRAINT_MESSAGE_GE": "",
           "CONSTRAINT_MESSAGE_IT": "",
           "CONSTRAINT_MESSAGE_L1": "",
           "CONSTRAINT_MESSAGE_L2": "",
           "CONSTRAINT_MESSAGE_L3": "",
           "CONSTRAINT_MESSAGE_L4": "",
           "CONSTRAINT_MESSAGE_L5": "",
           "CONSTRAINT_MESSAGE_L6": "",
           "CONSTRAINT_MESSAGE_PO": "",
           "CONSTRAINT_MESSAGE_SP": "",
           "CONSTRAINT_VALIDATION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/questions_questionnaire/1/constraint_validation"
            },
           "DISABLED": "",
           "DISPLAY_ORDER": "1",
           "MANDATORY": "",
           "QUESTION_ID": "6",
           "QUESTION_LIST_ID": "1",
           "TARGET_FIELD_1": "",
           "TARGET_FIELD_1_APPEND": "",
           "TARGET_FIELD_2": "",
           "TARGET_FIELD_2_APPEND": "",
           "XML": {
               "HREF": "https://{your_server}/api/v1/{your_account}/questions_questionnaire/1/xml"
            },
           "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",
           "ALONE": "",
           "ANSWER_CANNOT_BE_MODIFIED": "",
           "CONDITION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/questions_questionnaire/1/condition"
            },
           "CONSTRAINT_MESSAGE_EN": "",
           "CONSTRAINT_MESSAGE_FR": "",
           "CONSTRAINT_MESSAGE_GE": "",
           "CONSTRAINT_MESSAGE_IT": "",
           "CONSTRAINT_MESSAGE_L1": "",
           "CONSTRAINT_MESSAGE_L2": "",
           "CONSTRAINT_MESSAGE_L3": "",
           "CONSTRAINT_MESSAGE_L4": "",
           "CONSTRAINT_MESSAGE_L5": "",
           "CONSTRAINT_MESSAGE_L6": "",
           "CONSTRAINT_MESSAGE_PO": "",
           "CONSTRAINT_MESSAGE_SP": "",
           "CONSTRAINT_VALIDATION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/questions_questionnaire/1/constraint_validation"
            },
           "DISABLED": "",
           "DISPLAY_ORDER": "2",
           "MANDATORY": "",
           "QUESTION_ID": "8",
           "QUESTION_LIST_ID": "1",
           "TARGET_FIELD_1": "",
           "TARGET_FIELD_1_APPEND": "",
           "TARGET_FIELD_2": "",
           "TARGET_FIELD_2_APPEND": "",
           "XML": {
               "HREF": "https://{your_server}/api/v1/{your_account}/questions_questionnaire/1/xml"
            },
           "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)"  }  }
Tags:
Powered by XWiki © EasyVista 2024