Bulk add items to Question Library

curl --request POST \
  --url https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "name": "Library question 1",
    "item": {
      "type": "input",
      "subtype": "number",
      "position": 1,
      "title": "<p>Question title</p>",
      "config": {
        "minValue": 1,
        "maxValue": 10,
        "isRequired": true,
        "allowNA": false
      }
    },
    "locale": "spa_es",
    "questionPackage": "numeric package"
  },
  {
    "name": "Library question 2",
    "item": {
      "type": "multiple",
      "subtype": "text",
      "position": 1,
      "title": "<p>Question title 2</p>",
      "config": {
        "isRequired": true,
        "allowNA": false,
        "allowMultipleSelection": true,
        "minResponses": 1,
        "maxResponses": 3,
        "displayAs": "list"
      },
      "options": [
        {
          "label": "Option 1",
          "position": 1
        },
        {
          "label": "Option 2",
          "position": 2
        },
        {
          "label": "Option 3",
          "position": 3
        },
        {
          "label": "Option 4",
          "position": 4
        }
      ]
    },
    "locale": "spa_es",
    "questionPackage": "multiple choice package"
  }
]
'

import requests

url = "https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk"

payload = [
    {
        "name": "Library question 1",
        "item": {
            "type": "input",
            "subtype": "number",
            "position": 1,
            "title": "<p>Question title</p>",
            "config": {
                "minValue": 1,
                "maxValue": 10,
                "isRequired": True,
                "allowNA": False
            }
        },
        "locale": "spa_es",
        "questionPackage": "numeric package"
    },
    {
        "name": "Library question 2",
        "item": {
            "type": "multiple",
            "subtype": "text",
            "position": 1,
            "title": "<p>Question title 2</p>",
            "config": {
                "isRequired": True,
                "allowNA": False,
                "allowMultipleSelection": True,
                "minResponses": 1,
                "maxResponses": 3,
                "displayAs": "list"
            },
            "options": [
                {
                    "label": "Option 1",
                    "position": 1
                },
                {
                    "label": "Option 2",
                    "position": 2
                },
                {
                    "label": "Option 3",
                    "position": 3
                },
                {
                    "label": "Option 4",
                    "position": 4
                }
            ]
        },
        "locale": "spa_es",
        "questionPackage": "multiple choice package"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      name: 'Library question 1',
      item: {
        type: 'input',
        subtype: 'number',
        position: 1,
        title: '<p>Question title</p>',
        config: {minValue: 1, maxValue: 10, isRequired: true, allowNA: false}
      },
      locale: 'spa_es',
      questionPackage: 'numeric package'
    },
    {
      name: 'Library question 2',
      item: {
        type: 'multiple',
        subtype: 'text',
        position: 1,
        title: '<p>Question title 2</p>',
        config: {
          isRequired: true,
          allowNA: false,
          allowMultipleSelection: true,
          minResponses: 1,
          maxResponses: 3,
          displayAs: 'list'
        },
        options: [
          {label: 'Option 1', position: 1},
          {label: 'Option 2', position: 2},
          {label: 'Option 3', position: 3},
          {label: 'Option 4', position: 4}
        ]
      },
      locale: 'spa_es',
      questionPackage: 'multiple choice package'
    }
  ])
};

fetch('https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'name' => 'Library question 1',
        'item' => [
                'type' => 'input',
                'subtype' => 'number',
                'position' => 1,
                'title' => '<p>Question title</p>',
                'config' => [
                                'minValue' => 1,
                                'maxValue' => 10,
                                'isRequired' => true,
                                'allowNA' => false
                ]
        ],
        'locale' => 'spa_es',
        'questionPackage' => 'numeric package'
    ],
    [
        'name' => 'Library question 2',
        'item' => [
                'type' => 'multiple',
                'subtype' => 'text',
                'position' => 1,
                'title' => '<p>Question title 2</p>',
                'config' => [
                                'isRequired' => true,
                                'allowNA' => false,
                                'allowMultipleSelection' => true,
                                'minResponses' => 1,
                                'maxResponses' => 3,
                                'displayAs' => 'list'
                ],
                'options' => [
                                [
                                                                'label' => 'Option 1',
                                                                'position' => 1
                                ],
                                [
                                                                'label' => 'Option 2',
                                                                'position' => 2
                                ],
                                [
                                                                'label' => 'Option 3',
                                                                'position' => 3
                                ],
                                [
                                                                'label' => 'Option 4',
                                                                'position' => 4
                                ]
                ]
        ],
        'locale' => 'spa_es',
        'questionPackage' => 'multiple choice package'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk"

	payload := strings.NewReader("[\n  {\n    \"name\": \"Library question 1\",\n    \"item\": {\n      \"type\": \"input\",\n      \"subtype\": \"number\",\n      \"position\": 1,\n      \"title\": \"<p>Question title</p>\",\n      \"config\": {\n        \"minValue\": 1,\n        \"maxValue\": 10,\n        \"isRequired\": true,\n        \"allowNA\": false\n      }\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"numeric package\"\n  },\n  {\n    \"name\": \"Library question 2\",\n    \"item\": {\n      \"type\": \"multiple\",\n      \"subtype\": \"text\",\n      \"position\": 1,\n      \"title\": \"<p>Question title 2</p>\",\n      \"config\": {\n        \"isRequired\": true,\n        \"allowNA\": false,\n        \"allowMultipleSelection\": true,\n        \"minResponses\": 1,\n        \"maxResponses\": 3,\n        \"displayAs\": \"list\"\n      },\n      \"options\": [\n        {\n          \"label\": \"Option 1\",\n          \"position\": 1\n        },\n        {\n          \"label\": \"Option 2\",\n          \"position\": 2\n        },\n        {\n          \"label\": \"Option 3\",\n          \"position\": 3\n        },\n        {\n          \"label\": \"Option 4\",\n          \"position\": 4\n        }\n      ]\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"multiple choice package\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"name\": \"Library question 1\",\n    \"item\": {\n      \"type\": \"input\",\n      \"subtype\": \"number\",\n      \"position\": 1,\n      \"title\": \"<p>Question title</p>\",\n      \"config\": {\n        \"minValue\": 1,\n        \"maxValue\": 10,\n        \"isRequired\": true,\n        \"allowNA\": false\n      }\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"numeric package\"\n  },\n  {\n    \"name\": \"Library question 2\",\n    \"item\": {\n      \"type\": \"multiple\",\n      \"subtype\": \"text\",\n      \"position\": 1,\n      \"title\": \"<p>Question title 2</p>\",\n      \"config\": {\n        \"isRequired\": true,\n        \"allowNA\": false,\n        \"allowMultipleSelection\": true,\n        \"minResponses\": 1,\n        \"maxResponses\": 3,\n        \"displayAs\": \"list\"\n      },\n      \"options\": [\n        {\n          \"label\": \"Option 1\",\n          \"position\": 1\n        },\n        {\n          \"label\": \"Option 2\",\n          \"position\": 2\n        },\n        {\n          \"label\": \"Option 3\",\n          \"position\": 3\n        },\n        {\n          \"label\": \"Option 4\",\n          \"position\": 4\n        }\n      ]\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"multiple choice package\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"name\": \"Library question 1\",\n    \"item\": {\n      \"type\": \"input\",\n      \"subtype\": \"number\",\n      \"position\": 1,\n      \"title\": \"<p>Question title</p>\",\n      \"config\": {\n        \"minValue\": 1,\n        \"maxValue\": 10,\n        \"isRequired\": true,\n        \"allowNA\": false\n      }\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"numeric package\"\n  },\n  {\n    \"name\": \"Library question 2\",\n    \"item\": {\n      \"type\": \"multiple\",\n      \"subtype\": \"text\",\n      \"position\": 1,\n      \"title\": \"<p>Question title 2</p>\",\n      \"config\": {\n        \"isRequired\": true,\n        \"allowNA\": false,\n        \"allowMultipleSelection\": true,\n        \"minResponses\": 1,\n        \"maxResponses\": 3,\n        \"displayAs\": \"list\"\n      },\n      \"options\": [\n        {\n          \"label\": \"Option 1\",\n          \"position\": 1\n        },\n        {\n          \"label\": \"Option 2\",\n          \"position\": 2\n        },\n        {\n          \"label\": \"Option 3\",\n          \"position\": 3\n        },\n        {\n          \"label\": \"Option 4\",\n          \"position\": 4\n        }\n      ]\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"multiple choice package\"\n  }\n]"

response = http.request(request)
puts response.read_body

[
  {
    "name": "Library question 1",
    "isDefaultItem": true,
    "isShared": false,
    "item": {
      "type": "input",
      "subtype": "number",
      "position": 1,
      "title": "<p>Question title</p>",
      "config": {
        "minValue": 1,
        "maxValue": 10,
        "isRequired": true,
        "allowNA": false
      }
    },
    "locale": "spa_es",
    "questionPackage": "NUMERIC PACKAGE",
    "_id": "672e7c9726573a37f1d6a14f",
    "__v": 0,
    "createdAt": "2024-11-08T21:03:19.608Z",
    "updatedAt": "2024-11-08T21:03:19.608Z"
  },
  {
    "name": "Library question 2",
    "isDefaultItem": true,
    "isShared": false,
    "item": {
      "type": "multiple",
      "subtype": "text",
      "position": 1,
      "title": "<p>Question title 2</p>",
      "config": {
        "isRequired": true,
        "allowNA": false,
        "allowMultipleSelection": true,
        "minResponses": 1,
        "maxResponses": 3
      },
      "options": [
        {
          "label": "Option 1",
          "position": 1
        },
        {
          "label": "Option 2",
          "position": 2
        },
        {
          "label": "Option 3",
          "position": 3
        },
        {
          "label": "Option 4",
          "position": 4
        }
      ]
    },
    "locale": "spa_es",
    "questionPackage": "MULTIPLE CHOICE PACKAGE",
    "_id": "672e7c9726573a37f1d6a150",
    "__v": 0,
    "createdAt": "2024-11-08T21:03:19.609Z",
    "updatedAt": "2024-11-08T21:03:19.609Z"
  }
]

Build / Netquest

Bulk add items to Question Library

Description

Add multiple survey items to the question library.

Payload

The endpoint receives an array with the multiple items to be added to the library.

[
  {
    "item": {
        "type": "string",
        "subtype": "string",
        "frontendId": "number",
        "position": "number",
        "title": "string",
        "config": "object",
        "netquestId": "string",
        "netquestName": "string"
    },
    "name": "string",
    "questionPackage": "string",
    "locale": "string",
    "companyId": "string"
  }
]

name: Item name that appears in the library. Required.
item: See below for more information. Required
questionPackage: Question package. Optional.
locale: If present, the question will only be available to add if the project uses the same locale. Optional.
companyId: Company the item is gonna belong to. If not present it will be created as a default item (usable by every user). Optional.

Item

The item is the question to be added:

{
    "type": "string",
    "subtype": "string",
    "config": {
        "isRequired": "boolean",
        "allowNA": "boolean",
        "minValue": "number",
        "maxValue": "number",
        "allowMultipleSelection": "boolean",
        "minResponses": "number",
        "maxResponses": "number"
    },
    "position": "number",
    "title": "string",
    "options": "array",
    "netquestId": "string",
    "netquestName": "string"
}

type: The type of the item. Required. Possible values are:
- multiple: Multiple choice question.
- input: Numeric question.
subtype: The subtype of the item. Required:
- text: Only valid when type is multiple.
- number: Only valid when type is input.
config: Object containing item configurations.
- isRequired: Whether the item is required or not. Required.
- allowNA: Whether the item accepts N/A as an answer or not. Required.
- minValue: Minimum value allowed for the answer of the question. Required for type: input, subtype: number.
- maxValue: Maximum value allowed for the answer of the question. Required for type: input, subtype: number.
- allowMultipleSelection: Whether or not the question allows to select multiple options. Required for type: multiple, subtype: text.
- minResponses: Minimum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1. Required for type: multiple, subtype: text.
- maxResponses: Maximum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1. Required for type: multiple, subtype: text.
- displayAs: Value to determine how the item is going to be visualized in the survey. Supported values: dropdownor list. Required for type: multiple, subtype: text.
position: The position of the item. Not in use. Required
title: The title of the question.
netquestId: Netquest identifier. Optional.
netquestName: Netquest url variable name. Optional.

For each type of item, there can be more specific properties.

Options

Options is an array of objects containing the options for the multiple choice question. It has the following structure:

[
    {
        "label": "string",
        "position": "number",
        "netquestOptionValue": "string"
    }
]

label: The label of the option. Required.
position: The position of the option relative to the item. Required.
netquestOptionValue: The value used to map to the question option when the answer for the question is passed as an url variable. Optional.

Response

200 OK

Array of created items

{
    "item": {
        "type": "string",
        "subtype": "string",
        "frontendId": "number",
        "position": "number",
        "title": "string",
        "config": "object"
    },
    "name": "string",
    "questionPackage": "string",
    "locale": "string",
    "companyId": "string",
    "isDefaultItem": "boolean",
    "isShared": "boolean"
}

where:

name: Item name that appears in the library.
item: See below for more information.
questionPackage: Question package.
locale: If present, the question will only be available to add if the project uses the same locale.
companyId: Company the item is gonna belong to. If not present it will be created as a default item (usable by every user).
isDefaultItem: Item is a default one or not.
isShared: Item is shared for that company.

Item

The item is the question to would be added in the project:

{
    "type": "string",
    "subtype": "string",
    "config": {
        "isRequired": "boolean",
        "allowNA": "boolean",
        "minValue": "number",
        "maxValue": "number",
        "allowMultipleSelection": "boolean",
        "minResponses": "number",
        "maxResponses": "number"
    },
    "position": "number",
    "title": "string",
    "options": "array",
    "netquestId": "string",
    "netquestName": "string"
}

type: The type of the item. Required. Possible values are:
- multiple: Multiple choice question.
- input: Numeric question.
subtype: The subtype of the item. Required:
- text: Only valid when type is multiple.
- number: Only valid when type is input.
config: Object containing item configurations.
- isRequired: Whether the item is required or not.
- allowNA: Whether the item accepts N/A as an answer or not.
- minValue: Minimum value allowed for the answer of the question.
- maxValue: Maximum value allowed for the answer of the question.
- allowMultipleSelection: Whether or not the question allows to select multiple options.
- minResponses: Minimum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1.
- maxResponses: Maximum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1.
position: The position of the item. Not in use.
title: The title of the question.
netquestId: Netquest identifier.
netquestName: Netquest url variable name.

Options

Options is an array of objects containing the options for the multiple choice question:

[
    {
        "label": "string",
        "position": "number",
        "netquestOptionValue": "string"
    }
]

label: The label of the option.
position: The position of the option relative to the item.
netquestOptionValue: The value used to map to the question option when the answer for the question is passed as an url variable.

401 Unauthorized

The user is not authorized

403 Forbidden

The user doesn’t have enough privileges to use this endpoint

The company is not enabled to perform this action

500 Internal Server Error

Error occurred while processing the request.

POST

projects-api

questionsLibrary

bulk

Bulk add items to Question Library

curl --request POST \
  --url https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "name": "Library question 1",
    "item": {
      "type": "input",
      "subtype": "number",
      "position": 1,
      "title": "<p>Question title</p>",
      "config": {
        "minValue": 1,
        "maxValue": 10,
        "isRequired": true,
        "allowNA": false
      }
    },
    "locale": "spa_es",
    "questionPackage": "numeric package"
  },
  {
    "name": "Library question 2",
    "item": {
      "type": "multiple",
      "subtype": "text",
      "position": 1,
      "title": "<p>Question title 2</p>",
      "config": {
        "isRequired": true,
        "allowNA": false,
        "allowMultipleSelection": true,
        "minResponses": 1,
        "maxResponses": 3,
        "displayAs": "list"
      },
      "options": [
        {
          "label": "Option 1",
          "position": 1
        },
        {
          "label": "Option 2",
          "position": 2
        },
        {
          "label": "Option 3",
          "position": 3
        },
        {
          "label": "Option 4",
          "position": 4
        }
      ]
    },
    "locale": "spa_es",
    "questionPackage": "multiple choice package"
  }
]
'

import requests

url = "https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk"

payload = [
    {
        "name": "Library question 1",
        "item": {
            "type": "input",
            "subtype": "number",
            "position": 1,
            "title": "<p>Question title</p>",
            "config": {
                "minValue": 1,
                "maxValue": 10,
                "isRequired": True,
                "allowNA": False
            }
        },
        "locale": "spa_es",
        "questionPackage": "numeric package"
    },
    {
        "name": "Library question 2",
        "item": {
            "type": "multiple",
            "subtype": "text",
            "position": 1,
            "title": "<p>Question title 2</p>",
            "config": {
                "isRequired": True,
                "allowNA": False,
                "allowMultipleSelection": True,
                "minResponses": 1,
                "maxResponses": 3,
                "displayAs": "list"
            },
            "options": [
                {
                    "label": "Option 1",
                    "position": 1
                },
                {
                    "label": "Option 2",
                    "position": 2
                },
                {
                    "label": "Option 3",
                    "position": 3
                },
                {
                    "label": "Option 4",
                    "position": 4
                }
            ]
        },
        "locale": "spa_es",
        "questionPackage": "multiple choice package"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      name: 'Library question 1',
      item: {
        type: 'input',
        subtype: 'number',
        position: 1,
        title: '<p>Question title</p>',
        config: {minValue: 1, maxValue: 10, isRequired: true, allowNA: false}
      },
      locale: 'spa_es',
      questionPackage: 'numeric package'
    },
    {
      name: 'Library question 2',
      item: {
        type: 'multiple',
        subtype: 'text',
        position: 1,
        title: '<p>Question title 2</p>',
        config: {
          isRequired: true,
          allowNA: false,
          allowMultipleSelection: true,
          minResponses: 1,
          maxResponses: 3,
          displayAs: 'list'
        },
        options: [
          {label: 'Option 1', position: 1},
          {label: 'Option 2', position: 2},
          {label: 'Option 3', position: 3},
          {label: 'Option 4', position: 4}
        ]
      },
      locale: 'spa_es',
      questionPackage: 'multiple choice package'
    }
  ])
};

fetch('https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'name' => 'Library question 1',
        'item' => [
                'type' => 'input',
                'subtype' => 'number',
                'position' => 1,
                'title' => '<p>Question title</p>',
                'config' => [
                                'minValue' => 1,
                                'maxValue' => 10,
                                'isRequired' => true,
                                'allowNA' => false
                ]
        ],
        'locale' => 'spa_es',
        'questionPackage' => 'numeric package'
    ],
    [
        'name' => 'Library question 2',
        'item' => [
                'type' => 'multiple',
                'subtype' => 'text',
                'position' => 1,
                'title' => '<p>Question title 2</p>',
                'config' => [
                                'isRequired' => true,
                                'allowNA' => false,
                                'allowMultipleSelection' => true,
                                'minResponses' => 1,
                                'maxResponses' => 3,
                                'displayAs' => 'list'
                ],
                'options' => [
                                [
                                                                'label' => 'Option 1',
                                                                'position' => 1
                                ],
                                [
                                                                'label' => 'Option 2',
                                                                'position' => 2
                                ],
                                [
                                                                'label' => 'Option 3',
                                                                'position' => 3
                                ],
                                [
                                                                'label' => 'Option 4',
                                                                'position' => 4
                                ]
                ]
        ],
        'locale' => 'spa_es',
        'questionPackage' => 'multiple choice package'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk"

	payload := strings.NewReader("[\n  {\n    \"name\": \"Library question 1\",\n    \"item\": {\n      \"type\": \"input\",\n      \"subtype\": \"number\",\n      \"position\": 1,\n      \"title\": \"<p>Question title</p>\",\n      \"config\": {\n        \"minValue\": 1,\n        \"maxValue\": 10,\n        \"isRequired\": true,\n        \"allowNA\": false\n      }\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"numeric package\"\n  },\n  {\n    \"name\": \"Library question 2\",\n    \"item\": {\n      \"type\": \"multiple\",\n      \"subtype\": \"text\",\n      \"position\": 1,\n      \"title\": \"<p>Question title 2</p>\",\n      \"config\": {\n        \"isRequired\": true,\n        \"allowNA\": false,\n        \"allowMultipleSelection\": true,\n        \"minResponses\": 1,\n        \"maxResponses\": 3,\n        \"displayAs\": \"list\"\n      },\n      \"options\": [\n        {\n          \"label\": \"Option 1\",\n          \"position\": 1\n        },\n        {\n          \"label\": \"Option 2\",\n          \"position\": 2\n        },\n        {\n          \"label\": \"Option 3\",\n          \"position\": 3\n        },\n        {\n          \"label\": \"Option 4\",\n          \"position\": 4\n        }\n      ]\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"multiple choice package\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"name\": \"Library question 1\",\n    \"item\": {\n      \"type\": \"input\",\n      \"subtype\": \"number\",\n      \"position\": 1,\n      \"title\": \"<p>Question title</p>\",\n      \"config\": {\n        \"minValue\": 1,\n        \"maxValue\": 10,\n        \"isRequired\": true,\n        \"allowNA\": false\n      }\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"numeric package\"\n  },\n  {\n    \"name\": \"Library question 2\",\n    \"item\": {\n      \"type\": \"multiple\",\n      \"subtype\": \"text\",\n      \"position\": 1,\n      \"title\": \"<p>Question title 2</p>\",\n      \"config\": {\n        \"isRequired\": true,\n        \"allowNA\": false,\n        \"allowMultipleSelection\": true,\n        \"minResponses\": 1,\n        \"maxResponses\": 3,\n        \"displayAs\": \"list\"\n      },\n      \"options\": [\n        {\n          \"label\": \"Option 1\",\n          \"position\": 1\n        },\n        {\n          \"label\": \"Option 2\",\n          \"position\": 2\n        },\n        {\n          \"label\": \"Option 3\",\n          \"position\": 3\n        },\n        {\n          \"label\": \"Option 4\",\n          \"position\": 4\n        }\n      ]\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"multiple choice package\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sx-projects.sightx.io/projects-api/v2/questionsLibrary/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"name\": \"Library question 1\",\n    \"item\": {\n      \"type\": \"input\",\n      \"subtype\": \"number\",\n      \"position\": 1,\n      \"title\": \"<p>Question title</p>\",\n      \"config\": {\n        \"minValue\": 1,\n        \"maxValue\": 10,\n        \"isRequired\": true,\n        \"allowNA\": false\n      }\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"numeric package\"\n  },\n  {\n    \"name\": \"Library question 2\",\n    \"item\": {\n      \"type\": \"multiple\",\n      \"subtype\": \"text\",\n      \"position\": 1,\n      \"title\": \"<p>Question title 2</p>\",\n      \"config\": {\n        \"isRequired\": true,\n        \"allowNA\": false,\n        \"allowMultipleSelection\": true,\n        \"minResponses\": 1,\n        \"maxResponses\": 3,\n        \"displayAs\": \"list\"\n      },\n      \"options\": [\n        {\n          \"label\": \"Option 1\",\n          \"position\": 1\n        },\n        {\n          \"label\": \"Option 2\",\n          \"position\": 2\n        },\n        {\n          \"label\": \"Option 3\",\n          \"position\": 3\n        },\n        {\n          \"label\": \"Option 4\",\n          \"position\": 4\n        }\n      ]\n    },\n    \"locale\": \"spa_es\",\n    \"questionPackage\": \"multiple choice package\"\n  }\n]"

response = http.request(request)
puts response.read_body

[
  {
    "name": "Library question 1",
    "isDefaultItem": true,
    "isShared": false,
    "item": {
      "type": "input",
      "subtype": "number",
      "position": 1,
      "title": "<p>Question title</p>",
      "config": {
        "minValue": 1,
        "maxValue": 10,
        "isRequired": true,
        "allowNA": false
      }
    },
    "locale": "spa_es",
    "questionPackage": "NUMERIC PACKAGE",
    "_id": "672e7c9726573a37f1d6a14f",
    "__v": 0,
    "createdAt": "2024-11-08T21:03:19.608Z",
    "updatedAt": "2024-11-08T21:03:19.608Z"
  },
  {
    "name": "Library question 2",
    "isDefaultItem": true,
    "isShared": false,
    "item": {
      "type": "multiple",
      "subtype": "text",
      "position": 1,
      "title": "<p>Question title 2</p>",
      "config": {
        "isRequired": true,
        "allowNA": false,
        "allowMultipleSelection": true,
        "minResponses": 1,
        "maxResponses": 3
      },
      "options": [
        {
          "label": "Option 1",
          "position": 1
        },
        {
          "label": "Option 2",
          "position": 2
        },
        {
          "label": "Option 3",
          "position": 3
        },
        {
          "label": "Option 4",
          "position": 4
        }
      ]
    },
    "locale": "spa_es",
    "questionPackage": "MULTIPLE CHOICE PACKAGE",
    "_id": "672e7c9726573a37f1d6a150",
    "__v": 0,
    "createdAt": "2024-11-08T21:03:19.609Z",
    "updatedAt": "2024-11-08T21:03:19.609Z"
  }
]

Description

Add multiple survey items to the question library.

Payload

The endpoint receives an array with the multiple items to be added to the library.

[
  {
    "item": {
        "type": "string",
        "subtype": "string",
        "frontendId": "number",
        "position": "number",
        "title": "string",
        "config": "object",
        "netquestId": "string",
        "netquestName": "string"
    },
    "name": "string",
    "questionPackage": "string",
    "locale": "string",
    "companyId": "string"
  }
]

name: Item name that appears in the library. Required.
item: See below for more information. Required
questionPackage: Question package. Optional.
locale: If present, the question will only be available to add if the project uses the same locale. Optional.
companyId: Company the item is gonna belong to. If not present it will be created as a default item (usable by every user). Optional.

Item

The item is the question to be added:

{
    "type": "string",
    "subtype": "string",
    "config": {
        "isRequired": "boolean",
        "allowNA": "boolean",
        "minValue": "number",
        "maxValue": "number",
        "allowMultipleSelection": "boolean",
        "minResponses": "number",
        "maxResponses": "number"
    },
    "position": "number",
    "title": "string",
    "options": "array",
    "netquestId": "string",
    "netquestName": "string"
}

type: The type of the item. Required. Possible values are:
- multiple: Multiple choice question.
- input: Numeric question.
subtype: The subtype of the item. Required:
- text: Only valid when type is multiple.
- number: Only valid when type is input.
config: Object containing item configurations.
- isRequired: Whether the item is required or not. Required.
- allowNA: Whether the item accepts N/A as an answer or not. Required.
- minValue: Minimum value allowed for the answer of the question. Required for type: input, subtype: number.
- maxValue: Maximum value allowed for the answer of the question. Required for type: input, subtype: number.
- allowMultipleSelection: Whether or not the question allows to select multiple options. Required for type: multiple, subtype: text.
- minResponses: Minimum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1. Required for type: multiple, subtype: text.
- maxResponses: Maximum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1. Required for type: multiple, subtype: text.
- displayAs: Value to determine how the item is going to be visualized in the survey. Supported values: dropdownor list. Required for type: multiple, subtype: text.
position: The position of the item. Not in use. Required
title: The title of the question.
netquestId: Netquest identifier. Optional.
netquestName: Netquest url variable name. Optional.

For each type of item, there can be more specific properties.

Options

Options is an array of objects containing the options for the multiple choice question. It has the following structure:

[
    {
        "label": "string",
        "position": "number",
        "netquestOptionValue": "string"
    }
]

label: The label of the option. Required.
position: The position of the option relative to the item. Required.
netquestOptionValue: The value used to map to the question option when the answer for the question is passed as an url variable. Optional.

Response

200 OK

Array of created items

{
    "item": {
        "type": "string",
        "subtype": "string",
        "frontendId": "number",
        "position": "number",
        "title": "string",
        "config": "object"
    },
    "name": "string",
    "questionPackage": "string",
    "locale": "string",
    "companyId": "string",
    "isDefaultItem": "boolean",
    "isShared": "boolean"
}

where:

name: Item name that appears in the library.
item: See below for more information.
questionPackage: Question package.
locale: If present, the question will only be available to add if the project uses the same locale.
companyId: Company the item is gonna belong to. If not present it will be created as a default item (usable by every user).
isDefaultItem: Item is a default one or not.
isShared: Item is shared for that company.

Item

The item is the question to would be added in the project:

{
    "type": "string",
    "subtype": "string",
    "config": {
        "isRequired": "boolean",
        "allowNA": "boolean",
        "minValue": "number",
        "maxValue": "number",
        "allowMultipleSelection": "boolean",
        "minResponses": "number",
        "maxResponses": "number"
    },
    "position": "number",
    "title": "string",
    "options": "array",
    "netquestId": "string",
    "netquestName": "string"
}

type: The type of the item. Required. Possible values are:
- multiple: Multiple choice question.
- input: Numeric question.
subtype: The subtype of the item. Required:
- text: Only valid when type is multiple.
- number: Only valid when type is input.
config: Object containing item configurations.
- isRequired: Whether the item is required or not.
- allowNA: Whether the item accepts N/A as an answer or not.
- minValue: Minimum value allowed for the answer of the question.
- maxValue: Maximum value allowed for the answer of the question.
- allowMultipleSelection: Whether or not the question allows to select multiple options.
- minResponses: Minimum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1.
- maxResponses: Maximum amount of options that can be selected. If allowMultipleSelection is false this value should always be 1.
position: The position of the item. Not in use.
title: The title of the question.
netquestId: Netquest identifier.
netquestName: Netquest url variable name.

Options

Options is an array of objects containing the options for the multiple choice question:

[
    {
        "label": "string",
        "position": "number",
        "netquestOptionValue": "string"
    }
]

label: The label of the option.
position: The position of the option relative to the item.
netquestOptionValue: The value used to map to the question option when the answer for the question is passed as an url variable.

401 Unauthorized

The user is not authorized

403 Forbidden

The user doesn’t have enough privileges to use this endpoint

The company is not enabled to perform this action

500 Internal Server Error

Error occurred while processing the request.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Authorization token

Body

application/json

The body is of type object.

Response

Bulk add items to Question Library response

The response is of type object.

Get project Update question library item

⌘I

​Description

​Payload

​Item

​Options

​Response

​200 OK

​Item

​Options

​401 Unauthorized

​403 Forbidden

​500 Internal Server Error

Authorizations

Headers

Body

Response

Description

Payload

Item

Options

Response

200 OK

Item

Options

401 Unauthorized

403 Forbidden

500 Internal Server Error