Get all questions
get
/hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds a question in a questionnaire that matches the specified primary key criteria.
Finder Variables- QuestionnaireQuestionId; integer; System-generated primary key of the question in a questionnaire.
- PrimaryKey Finds a question in a questionnaire that matches the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdhocQuestion; string; Indicates whether the question is an additional question added by a person requesting a response to the questionnaire. If the value is Y, the question is displayed only to specific participants as part of specific requests. If the value is N, the question is displayed to all participants for all requests.
- AttachmentAllowed; string; Indicates whether the question is supported by attachments from the respondent. Valid values are Y and N.
- CreatedBy; string; User who added the question to the questionnaire definition.
- CreationDate; string; Date and time of addition of the question to the questionnaire definition.
- LastUpdateDate; string; Date and time of update of the question in the questionnaire definition.
- LastUpdatedBy; string; User who last updated the question in the questionnaire definition.
- Mandatory; string; Indicates whether the respondent needs to answer a question in a questionnaire. Valid values are Y and N.
- MaximumLength; string; Minimum number of characters that the respondent must provide when answering a text type of question.
- MaximumSelections; integer; Minimum number of choices that the respondent must select when answering a multiple choice type of question.
- MinimumLength; integer; Maximum number of characters that the respondent can provide when answering a text type of question.
- MinimumSelections; integer; Maximum number of choices that the respondent can select when answering a multiple choice type of question.
- QuestionCode; string; User-defined identifier of the question definition.
- QuestionId; integer; System-generated primary key for the question definition.
- QuestionSequenceNumber; integer; Sequence number of a question in the questionnaire and section definitions.
- QuestionText; string; Text displayed as the question in the questionnaire.
- QuestionType; string; Type of the question such as Single Choice, Multiple Choice, Text, or No Response.
- QuestionVersionNumber; integer; Version number of the question.
- QuestionnaireCode; string; Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
- QuestionnaireId; integer; Surrogate identifier of the questionnaire.
- QuestionnaireQuestionId; integer; System-generated primary key for the question in a questionnaire definition.
- SectionSequenceNumber; integer; Sequence number of the sections in a questionnaire definition.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
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 : questionnaireQuestionsLOV
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questionnaireQuestionsLOV-item-response
Type:
Show Source
object
-
AdhocQuestion: string
Title:
Additional Question
Read Only:true
Maximum Length:30
Default Value:N
Indicates whether the question is an additional question added by a person requesting a response to the questionnaire. If the value is Y, the question is displayed only to specific participants as part of specific requests. If the value is N, the question is displayed to all participants for all requests. -
AttachmentAllowed: string
Title:
Allow attachments
Read Only:true
Maximum Length:30
Default Value:N
Indicates whether the question is supported by attachments from the respondent. Valid values are Y and N. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the question to the questionnaire definition. -
CreationDate: string
(date-time)
Read Only:
true
Date and time of addition of the question to the questionnaire definition. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time of update of the question in the questionnaire definition. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the question in the questionnaire definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Mandatory: string
Title:
Required
Read Only:true
Maximum Length:30
Default Value:N
Indicates whether the respondent needs to answer a question in a questionnaire. Valid values are Y and N. -
MaximumLength: string
Title:
Maximum Characters
Read Only:true
Maximum Length:20
Minimum number of characters that the respondent must provide when answering a text type of question. -
MaximumSelections: integer
(int64)
Title:
Maximum Number of Selections
Read Only:true
Minimum number of choices that the respondent must select when answering a multiple choice type of question. -
MinimumLength: integer
(int64)
Title:
Minimum Length
Read Only:true
Maximum number of characters that the respondent can provide when answering a text type of question. -
MinimumSelections: integer
(int64)
Title:
Minimum Number of Selections
Read Only:true
Maximum number of choices that the respondent can select when answering a multiple choice type of question. -
QuestionCode: string
Title:
Question Code
Read Only:true
Maximum Length:240
User-defined identifier of the question definition. -
QuestionId: integer
(int64)
Title:
Question ID
Read Only:true
System-generated primary key for the question definition. -
QuestionnaireCode: string
Title:
Questionnaire Code
Read Only:true
Maximum Length:240
Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber. -
QuestionnaireId: integer
(int64)
Title:
Questionnaire ID
Read Only:true
Surrogate identifier of the questionnaire. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question ID
Read Only:true
System-generated primary key for the question in a questionnaire definition. -
QuestionSequenceNumber: integer
(int64)
Title:
Sequence Number
Read Only:true
Sequence number of a question in the questionnaire and section definitions. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text displayed as the question in the questionnaire. -
QuestionType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of the question such as Single Choice, Multiple Choice, Text, or No Response. -
QuestionVersionNumber: integer
(int64)
Title:
Question Version Number
Read Only:true
Version number of the question. -
SectionSequenceNumber: integer
(int64)
Title:
Section Sequence Number
Read Only:true
Sequence number of the sections in a questionnaire definition.
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.
Examples
The following example shows how to get all questions associated with questionnaire by submitting a collection GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV?q=QuestionnaireCode=<qstnrcode>
Note:
This GET operation retrieves information about all questions associated with the Questionnaire.Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "QuestionnaireQuestionId": 300100208279514, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100012608279", "QuestionText": "ZHRQ-Is the Reviewee a Team Player?", "QuestionId": 300100012608279, "QuestionVersionNumber": 1, "QuestionType": "Single Choice", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "N", "Mandatory": "N", "MaximumLength": null, "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:19:32.173+00:00", "LastUpdateDate": "2019-03-06T15:24:34.477+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] }, { "QuestionnaireQuestionId": 300100208279515, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100014533037", "QuestionText": "How is the behavior of the person as a team player?", "QuestionId": 300100014533037, "QuestionVersionNumber": 1, "QuestionType": "Text", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "Y", "Mandatory": "Y", "MaximumLength": null, "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:19:34.231+00:00", "LastUpdateDate": "2019-03-06T15:24:34.758+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] }, { "QuestionnaireQuestionId": 300100208279517, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100012608302", "QuestionText": "ZHRQ-Do you feel that talent is utilised effectively by the company?", "QuestionId": 300100012608302, "QuestionVersionNumber": 1, "QuestionType": "Single Choice", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "N", "Mandatory": "N", "MaximumLength": null, "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:19:34.307+00:00", "LastUpdateDate": "2019-03-06T15:24:34.759+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] }, { "QuestionnaireQuestionId": 300100208279519, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100010224093", "QuestionText": "How is the behavior of the person as a team player.", "QuestionId": 300100010224093, "QuestionVersionNumber": 1, "QuestionType": "Text", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "Y", "Mandatory": "N", "MaximumLength": "500", "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:19:34.364+00:00", "LastUpdateDate": "2019-03-06T15:24:34.773+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] }, { "QuestionnaireQuestionId": 300100208279520, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100010224167", "QuestionText": "Can/Did the appraisee handle complex situations during this particular focal period?", "QuestionId": 300100010224167, "QuestionVersionNumber": 1, "QuestionType": "Text", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "Y", "Mandatory": "N", "MaximumLength": "500", "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:19:34.414+00:00", "LastUpdateDate": "2019-03-06T15:24:34.777+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] }, { "QuestionnaireQuestionId": 300100208279551, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100010360866", "QuestionText": "zhrq-How well do you believe this person performs under pressure?", "QuestionId": 300100010360866, "QuestionVersionNumber": 1, "QuestionType": "Single Choice", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "N", "Mandatory": "N", "MaximumLength": null, "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:22:13.510+00:00", "LastUpdateDate": "2019-03-06T15:24:34.762+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] }, { "QuestionnaireQuestionId": 300100208279568, "QuestionnaireCode": "300100208279512", "QuestionCode": "300100012608317", "QuestionText": "ZHRQ-What do you believe are the persons strongest strengths? Please select a max of three options.", "QuestionId": 300100012608317, "QuestionVersionNumber": 1, "QuestionType": "Multiple Choice", "AdhocQuestion": "N", "StartDateActive": "2001-01-01", "EndDateActive": "4712-12-31", "AttachmentAllowed": "N", "Mandatory": "N", "MaximumLength": null, "MinimumLength": null, "MaximumSelections": null, "MinimumSelections": null, "CreatedBy": "ZHRA-HRSPC10", "CreationDate": "2019-03-06T15:23:48.766+00:00", "LastUpdateDate": "2019-03-06T15:24:34.763+00:00", "LastUpdatedBy": "ZHRA-HRSPC10", "links": [ {...} ] } ], "count": 7, "hasMore": false, "limit": 25, "offset": 0, "links": [ {...} ]}