Get a questionnaire template
get
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}
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.
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : questionnaireTemplates-item-response
Type:
Show Source
object
-
AllowFormatChangeFlag: boolean
Title:
Allow changes to format options
Maximum Length:30
Default Value:false
Indicates whether the format options can be changed in the questionnaire. The default value is false. -
AllowInstrChangeFlag: boolean
Title:
Allow changes to instructions
Maximum Length:30
Default Value:false
Indicates whether the instructions can be changed in the questionnaire. The default value is false. -
AllowPlainTextFlag: boolean
Title:
Plain Text Box
Indicates whether questions with plain text response type can be added to the questionnaire. The default value is false. -
AllowRichTextFlag: boolean
Title:
Rich Text Box
Indicates whether questions with rich text response type can be added to the questionnaire. The default value is false. -
AllowSectionChangeFlag: boolean
Title:
Allow changes to sections
Maximum Length:30
Default Value:false
Indicates whether a section can be changed in the questionnaire. The default value is false. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CalculationRule: string
Title:
Score Calculation Rule Code
Read Only:true
Maximum Length:30
Calculation rule code for questionnaires that are scored. -
CalculationRuleMeaning: string
Title:
Score Calculation Rule
Read Only:true
Maximum Length:80
Name of the score calculation rule for questionnaires that are scored. -
CheckBoxWithImageFlag: boolean
Title:
Check Box With Image
Indicates whether questions with check box with image response type can be added to the questionnaire. The default value is true. -
CheckMultipleChoicesFlag: boolean
Title:
Check Multiple Choices
Indicates whether questions with multiple choice check box response type can be added to the questionnaire. The default value is true. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the questionnaire template. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the questionnaire template was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:2000
Description of the questionnaire template. -
Editor: string
Title:
Owner
Read Only:true
Maximum Length:64
Person Identifier of the person having the privileges to edit the questionnaire template marked as private. -
EditorPersonName: string
Title:
Person Name
Read Only:true
Maximum Length:2000
Name of the person with privileges to edit the questionnaire template marked as private. -
EditorPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the person with privileges to edit the questionnaire template that's marked private. -
InstructionText: string
Title:
Instruction Text
Read Only:true
Maximum Length:4000
Instructions or additional information for the questionnaire template. -
InUseFlag: boolean
Title:
In Use Code
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether the questionnaire template is used by any questionnaires. The default value is false. -
InUseMeaning: string
Title:
In Use
Read Only:true
Maximum Length:80
Meaning of the In Use Code attribute that Indicates whether the questionnaire template is used by any questionnaire. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the questionnaire template was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the questionnaire template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumPossibleScore: integer
(int64)
Title:
Maximum Possible Score
Read Only:true
Sum of the maximum possible scores of all questions that are included in the questionnaire template. -
MultipleChoicesListFlag: boolean
Title:
Multiple Choices from List
Indicates whether questions with multiple choice list response type can be added to the questionnaire. -
NoResponseFlag: boolean
Title:
No Response
Indicates whether questions with no response type can be added to the questionnaire. The default value is true. -
PrivacyFlag: boolean
Title:
Privacy Code
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether the questionnaire template is private. If a template is marked private, only the person specified by the owner attribute can edit the template. The default value is false. -
PrivacyMeaning: string
Title:
Privacy
Read Only:true
Maximum Length:80
Meaning of the privacy code indicating if the questionnaire template is marked private. -
QuestionnaireTemplateId: integer
(int64)
Title:
Questionnaire Template Id
Read Only:true
Surrogate identifier for the questionnaire template. -
QuestionnaireTemplateName: string
Title:
Questionnaire Template Name
Maximum Length:240
Name of the questionnaire template. -
RadioButtonListFlag: boolean
Title:
Radio Button List
Indicates whether questions with single choice radio button response type can be added to the questionnaire. The default value is true. -
RadioButtonWithImageFlag: boolean
Title:
Radio Button With Image
Indicates whether questions with radio button with image response type can be added to the questionnaire. The default value is true. -
ScoreQuestionnaireFlag: boolean
Title:
Score Questionnaire
Read Only:true
Maximum Length:30
Indicates whether the questionnaire is scored. The default value is false. -
SectionOrderCode: string
Title:
Section Order Code
Read Only:true
Maximum Length:30
Default Value:S
Code that shows the ordering sequence of the questionnaire sections. -
SectionOrderMeaning: string
Title:
Section Order
Read Only:true
Maximum Length:80
Meaning of the section order code indicating the sequencing order of the questionnaire sections. -
SectionPresentationCode: string
Title:
Section Presentation Code
Read Only:true
Maximum Length:30
Default Value:S
Code that shows if the questionnaire is presented as stacked regions or without sections. -
SectionPresentationMeaning: string
Title:
Section Presentation
Read Only:true
Maximum Length:80
Meaning of the section presentation code indicating the presentation of sections of the questionnaire. -
sections: array
Sections
Title:
Sections
The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template. -
SingleChoiceListFlag: boolean
Title:
Single Choice from List
Indicates whether questions with single choice list response type can be added to the questionnaire. The default value is true. -
Status: string
Title:
Status Code
Read Only:true
Maximum Length:30
Default Value:D
Status of the questionnaire template. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Meaning of the status code for the questionnaire template. -
SubscriberCode: string
Title:
Subscriber Code
Read Only:true
Maximum Length:30
Code for the subscriber using the questionnaire template. Valid values are defined in the list questionnaireSubscribersLOV. -
SubscriberId: integer
(int64)
Title:
Subscriber Id
Read Only:true
Surrogate identifier for the subscriber. -
SubscriberName: string
Title:
Subscriber Name
Read Only:true
Maximum Length:240
Name of the subscriber using the questionnaire template. -
VersionDescription: string
Title:
Version Description
Read Only:true
Maximum Length:2000
Description provided when a new version of a questionnaire template is created. -
VersionNumber: integer
(int64)
Title:
Version Number
Read Only:true
Default Value:1
Version number of the questionnaire template.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sections
Type:
array
Title:
Sections
The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.
Show Source
Nested Schema : questionnaireTemplates-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : questionnaireTemplates-sections-item-response
Type:
Show Source
object
-
AllowAdditionalQuestionsFlag: boolean
Title:
Allow Additional Questions
Maximum Length:30
Default Value:false
Indicates whether additional questions can be added to the questionnaire section when a response is requested. The default value is false. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the section. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the section was created. -
Description: string
Title:
Description
Maximum Length:2000
Description of the questionnaire section. -
IntroText: string
Title:
Introduction
Maximum Length:2000
Introduction text for the questionnaire section. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the section was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the section. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Required
Maximum Length:30
Default Value:false
Indicates whether the questionnaire section is mandatory. The default value is false. -
QuestionOrder: string
Title:
Question Order Code
Maximum Length:30
Default Value:V
Indicates the ordering sequence for the questions in a questionnaire section. -
QuestionOrderMeaning: string
Title:
Question Order
Read Only:true
Maximum Length:80
Meaning of the question order code indicating the ordering sequence for the questions in a questionnaire section. -
questions: array
Questions
Title:
Questions
The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template. -
ResponseOrder: string
Title:
Response Order Code
Maximum Length:30
Default Value:V
Indicates the ordering sequence for the answer choices in questions included in a questionnaire section. -
ResponseOrderMeaning: string
Title:
Response Order
Read Only:true
Maximum Length:80
Meaning of the response order code indicating the ordering sequence for the answer choices in questions. -
SectionId: integer
(int64)
Title:
Section Id
Read Only:true
Surrogate identifier for the section in a questionnaire template. -
SectionName: string
Title:
Section Name
Maximum Length:240
Name of the questionnaire section. -
SectionSequenceNumber: integer
(int64)
Title:
Section Sequence Number
Sequence number for a section in a questionnaire template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Questions
Type:
array
Title:
Questions
The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.
Show Source
Nested Schema : questionnaireTemplates-sections-questions-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireTemplates-sections-questions-answers-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SubscriberLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: SubscriberCode; Target Attribute: SubscriberCode
- Display Attribute: SubscriberCode
- attachments
-
Parameters:
- questionnaireTemplatesUniqID:
$request.path.questionnaireTemplatesUniqID
The attachments resource is used to view, create, and update attachments. - questionnaireTemplatesUniqID:
- sections
-
Parameters:
- questionnaireTemplatesUniqID:
$request.path.questionnaireTemplatesUniqID
The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template. - questionnaireTemplatesUniqID: