Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Survey Questions

Survey Questions appear on and can be responded to through surveys. This feature requires the Surveys account add-on.

Fetching a list of Survey Questions

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.

Request
query Parameters
external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refs
string

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

has_external_references
boolean

Filter by whether or not the object has external references.

include
string

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.
included_on_template
integer <int32>

Filter results for questions included on a particular template.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "updated_at:desc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, updated_at:asc, and updated_at:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

Responses
200

A list of Survey Questions have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/survey_questions
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "survey_questions": {
    },
  • "external_references": {
    }
}
Creating a new Survey Question
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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
text
required
string
The text of the question.


 
question_type
required
string
The type of the question. Valid values: single, multi, date, string, integer, decimal.


 
Array of objects
List of possible choices for the question. Only valid with single and multiple question type.


 
Responses 
200
Survey Question has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/survey_questions
Request samples 
application/json
{
  • "survey_question": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "survey_questions": {
    },
  • "external_references": {
    }
}
Updating an existing Survey Question
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
text
string
The text of the question.


 
Responses 
200
Survey Question has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/survey_questions/{id}
Request samples 
application/json
{
  • "survey_question": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "survey_questions": {
    },
  • "external_references": {
    }
}
Deleting an existing Survey Question
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Survey Question has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/survey_questions/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Survey Responses