Skip to content

Creating a new Survey Question

Request

This endpoint returns structured Survey Question objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the survey_questions top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • choices (SurveyQuestionChoice) - The available choices associated with a question. Only populated on single or multi choice questions.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
Bodyapplication/jsonrequired
survey_questionobject
{
  "survey_question": {
    "text": "string",
    "question_type": "string",
    "choices": [
      {
        "label": "string"
      }
    ]
  }
}

Responses

Survey Question has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
survey_questionsobject
external_referencesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "survey_questions": {
    "property1": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "question_type": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "question_type": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}