Jump to

• Request
• Response

Get a question

get

/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}

Request

Path Parameters

• questionnaireTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Questionnaire Templates resource and used to uniquely identify an instance of Questionnaire Templates. The client should not generate the hash key value. Instead, the client should query on the Questionnaire Templates collection resource in order to navigate to a specific instance of Questionnaire Templates to get the hash key.
• questionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Questions resource and used to uniquely identify an instance of Questions. The client should not generate the hash key value. Instead, the client should query on the Questions collection resource in order to navigate to a specific instance of Questions to get the hash key.
• sectionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sections resource and used to uniquely identify an instance of Sections. The client should not generate the hash key value. Instead, the client should query on the Sections collection resource in order to navigate to a specific instance of Sections to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : questionnaireTemplates-sections-questions-item-response

Type: object

Show Source

• AllowAdditionalCommentsFlag: boolean
  Title: Allow Additional Comments

  Read Only: true

  Maximum Length: 20

  Default Value: false

  Indicates whether a participant can provide additional comments while responding to a question. Valid values are Y and N. The default value is N.
• answers: array Answers
  Title: Answers

  The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.
• ControllingQuestionCode: string
  Title: Question Code

  Read Only: true

  Maximum Length: 240

  Question code for the controlling question that determines if the question is to be presented to the participant to respond. Valid values are defined in the list questionsLOV.
• ControllingQuestionId: integer (int64)
  Title: Controlling Question Id

  Read Only: true

  Surrogate identifier for the controlling question.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who added the question to the questionnaire template section.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the question was added to the questionnaire template section.
• InstructionsText: string
  Title: Instruction Text

  Read Only: true

  Maximum Length: 4000

  Instructions or additional information for the question.
• KeepWithPreviousFlag: boolean
  Title: Keep with Previous

  Maximum Length: 30

  Default Value: false

  Indicates whether the question is always paired with the previous question even when the question order is randomized. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the question was last updated in the questionnaire template section.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the question in the questionnaire template section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockQuestionFlag: boolean
  Title: Lock Question

  Maximum Length: 8

  Default Value: false

  Indicates whether the question can be removed or modified in the questionnaire. The default value is false.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 30

  Default Value: false

  Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.
• MaximumPossibleScore: integer (int64)
  Title: Maximum Possible Score

  Read Only: true

  Maximum possible score which is the sum of the maximum possible scores of the possible answer choices. This can be zero if none of the answer choices have a positive score defined.
• QuestionCode: string
  Title: Question Code

  Read Only: true

  Maximum Length: 240

  Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.
• QuestionId: integer (int64)
  Title: Question Id

  Read Only: true

  Surrogate identifier for the question.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question Id

  Read Only: true

  Surrogate identifier of the question in the questionnaire.
• QuestionText: string
  Title: Question Text

  Read Only: true

  Maximum Length: 2000

  Question text for the question.
• QuestionType: string
  Title: Question Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: TEXT

  Question type code indicating the type of the question.
• QuestionTypeMeaning: string
  Title: Question Type

  Read Only: true

  Maximum Length: 80

  Meaning of the question type code.
• QuestionVersionNumber: integer (int64)
  Title: Version Number

  Version number of the question used in the questionnaire template section.
• ResponseOrderCode: string
  Title: Response Order Code

  Read Only: true

  Maximum Length: 30

  Code that shows whether the question is enabled for random order. Possible values are Random to randomize the answer choices and Vertical to present the answer choices in the defined sequence.
• ResponseOrderMeaning: string
  Title: Response Order

  Read Only: true

  Maximum Length: 80

  Meaning of the response order code.
• ResponseType: string
  Title: Response Type Code

  Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.
• ResponseTypeMeaning: string
  Title: Response Type

  Read Only: true

  Meaning of the response type code.
• SampleSize: integer (int64)
  Title: Sample Size

  Read Only: true

  Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence number of the question in a questionnaire template section.

{
    "type":"object",
    "properties":{
        "AllowAdditionalCommentsFlag":{
            "title":"Allow Additional Comments",
            "maxLength":20,
            "type":"boolean",
            "description":"Indicates whether a participant can provide additional comments while responding to a question. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ControllingQuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Question code for the controlling question that determines if the question is to be presented to the participant to respond. Valid values are defined in the list questionsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ControllingQuestionId":{
            "title":"Controlling Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the controlling question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who added the question to the questionnaire template section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the question was added to the questionnaire template section.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionsText":{
            "title":"Instruction Text",
            "maxLength":4000,
            "type":"string",
            "description":"Instructions or additional information for the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KeepWithPreviousFlag":{
            "title":"Keep with Previous",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the question is always paired with the previous question even when the question order is randomized. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the question was last updated in the questionnaire template section.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the question in the questionnaire template section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LockQuestionFlag":{
            "title":"Lock Question",
            "maxLength":8,
            "type":"boolean",
            "description":"Indicates whether the question can be removed or modified in the questionnaire. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"Maximum possible score which is the sum of the maximum possible scores of the possible answer choices. This can be zero if none of the answer choices have a positive score defined.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Question text for the question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "QuestionType":{
            "title":"Question Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Question type code indicating the type of the question.",
            "nullable":false,
            "readOnly":true,
            "default":"TEXT",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "QuestionTypeMeaning":{
            "title":"Question Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the question type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionVersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the question used in the questionnaire template section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier of the question in the questionnaire.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseOrderCode":{
            "title":"Response Order Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that shows whether the question is enabled for random order. Possible values are Random to randomize the answer choices and Vertical to present the answer choices in the defined sequence.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ResponseOrderMeaning":{
            "title":"Response Order",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the response order code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResponseType":{
            "title":"Response Type Code",
            "type":"string",
            "description":"Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ResponseTypeMeaning":{
            "title":"Response Type",
            "type":"string",
            "description":"Meaning of the response type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SampleSize":{
            "title":"Sample Size",
            "type":"integer",
            "description":"Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence number of the question in a questionnaire template section.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "answers":{
            "title":"Answers",
            "type":"array",
            "description":"The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.",
            "items":{
                "$ref":"#/components/schemas/questionnaireTemplates-sections-questions-answers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Answers

Type: array

Title: Answers

The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.

Show Source

• Array of: object questionnaireTemplates-sections-questions-answers-item-response

{
    "title":"Answers",
    "type":"array",
    "description":"The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.",
    "items":{
        "$ref":"#/components/schemas/questionnaireTemplates-sections-questions-answers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : questionnaireTemplates-sections-questions-answers-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionAnswerId: integer (int64)
  Title: Question Answer Id

  Surrogate identifier for the answer choice defined for a question.
• ResponseCode: string
  Title: Response Code

  Maximum Length: 240

  Unique code for the answer choice defined for a question.
• ResponseFeedback: string (byte)
  Title: Response Feedback

  Feedback provided to the participant when the answer choice is selected.
• Score: integer (int64)
  Title: Score

  Score for the answer.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 240

  Answer text for the answer choices of a question.

{
    "type":"object",
    "properties":{
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier for the answer choice defined for a question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseCode":{
            "title":"Response Code",
            "maxLength":240,
            "type":"string",
            "description":"Unique code for the answer choice defined for a question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ResponseFeedback":{
            "title":"Response Feedback",
            "type":"string",
            "description":"Feedback provided to the participant when the answer choice is selected.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Score for the answer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":240,
            "type":"string",
            "description":"Answer text for the answer choices of a question.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ControllingQuestionLov

Operation: /hcmRestApi/resources/11.13.18.05/questionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ControllingQuestionCode; Target Attribute: QuestionCode
• Display Attribute: QuestionCode, QuestionId

QuestionLov

Operation: /hcmRestApi/resources/11.13.18.05/questionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: QuestionCode; Target Attribute: QuestionCode
• Display Attribute: QuestionCode, QuestionId

ResponseTypeLov

Operation: /hcmRestApi/resources/11.13.18.05/questionnaireResponseTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ResponseType; Target Attribute: ResponseTypeCode
• Display Attribute: ResponseTypeCode

answers

Operation: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers

Parameters:

• questionnaireTemplatesUniqID: $request.path.questionnaireTemplatesUniqID
• questionsUniqID: $request.path.questionsUniqID
• sectionsUniqID: $request.path.sectionsUniqID

The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.

Back to Top