Get all questionnaires
get
/hcmRestApi/resources/11.13.18.05/questionnairesLOV
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 all the questionnaires that match the specified primary key criteria.
Finder Variables- QstnrVersionNumber; integer; Version of the questionnaire.
- QuestionnaireId; integer; Application generated primary key of the questionnaire.
- findByWord Finds all the questionnaires that match the specified criteria.
Finder Variables- FilterAttributes; string; Attributes for the search parameters.
- Include; string; Indicates whether to include or exclude questionnaires in the list of category IDs.
- ListOfCategoryIDs; string; List of folder identifiers where questionnaires are stored.
- ListOfQstnrIDs; string; List of identifiers for the questionnaires.
- ListOfQstnrTmpltIDs; string; List of unique identifiers for the questionnaire templates.
- SearchTerms; string; Search terms used to retrieve questionnaire data.
- StartsWithFlag; boolean; Option to start with the specified criteria for searching the questionnaires.
- SubscriberCode; string; Unique code of the subscribing application where the questionnaire is used.
- SysEffectiveDate; object;
- PrimaryKey Finds all the questionnaires that match 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:- CalculationRuleCode; string; Code for the calculation rule for scored questionnaires.
- CategoryId; integer; Unique identifier of the folder where the questionnaire is stored.
- CategoryName; string; Name of the folder where the questionnaire is stored.
- CreationDate; string; Who column for creation date
- Description; string; Description of the questionnaire.
- InUse; string; Indicates whether the questionnaire has at least one response.
- InUseMeaning; string; Meaning of the In Use code.
- IntroText; string; Introduction of the questionnaire displayed to a respondent.
- LatestVersion; string; Indicates whether the version of the questionnaire is the latest. The default value is Y. The latest version is used in new questionnaire responses.
- MaximumPossibleScore; integer; Maximum score that you can achieve in the questionnaire.
- Name; string; Name of the questionnaire.
- Owner; string; Owner of the questionnaire. Indicates the person ID who can edit the questionnaire, when private.
- PageLayout; string; Layout of the questionnaire on a page. This isn't applicable to mobile responsive pages.
- PrivacyFlag; boolean; Indicates whether the questionnaire is private. Y indicates that the questionnaire is private and only the owner can edit. N indicates that the questionnaire is public and anyone can edit it with the required privileges.
- QstnrTemplateId; integer; Unique identifier of the template used to create the questionnaire.
- QstnrVersionNumber; integer; Version of the questionnaire. When the definition of a questionnaire changes, you can version the change and retain the original definition of the questionnaire.
- QstnsPERPage; integer; Number of questions displayed on a page. This isn't applicable to mobile responsive pages.
- QuestionnaireCode; string; User-defined identifier of the questionnaire.
- QuestionnaireId; integer; Application generated primary key of the questionnaire.
- ScoredFlag; boolean; Indicates whether a score is calculated for the questionnaire.
- SectionOrder; string; Section order when responding to the questionnaire. Valid options are Sequential and Random.
- SectionPresentation; string; Presentation of sections when responding to the questionnaire. Valid options are Stack Regions and No Sections.
- Status; string; Status of the questionnaire. Valid values are Active, Draft, and Inactive.
- SubscriberCode; string; Unique code of the subscribing application where the questionnaire is used.
- SubscriberId; integer; Identifier of the subscribing application where the questionnaire is used.
- TemplateFlag; boolean; Indicates whether the questionnaire is a template.
- VersionDescription; string; Description of the version of the questionnaire.
-
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
-
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 : questionnairesLOV
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 : questionnairesLOV-item-response
Type:
Show Source
object
-
CalculationRuleCode: string
Title:
Overall Score Calculation Rule
Read Only:true
Maximum Length:30
Code for the calculation rule for scored questionnaires. -
CategoryId: integer
(int64)
Title:
Folder
Read Only:true
Unique identifier of the folder where the questionnaire is stored. -
CategoryName: string
Title:
Folder
Read Only:true
Maximum Length:240
Name of the folder where the questionnaire is stored. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column for creation date -
Description: string
Title:
Description
Read Only:true
Maximum Length:2000
Description of the questionnaire. -
IntroText: string
Title:
Introduction
Read Only:true
Maximum Length:4000
Introduction of the questionnaire displayed to a respondent. -
InUse: string
Title:
In Use
Read Only:true
Maximum Length:30
Default Value:N
Indicates whether the questionnaire has at least one response. -
InUseMeaning: string
Title:
In Use
Read Only:true
Maximum Length:80
Meaning of the In Use code. -
LatestVersion: string
Title:
Latest Version
Read Only:true
Maximum Length:30
Default Value:N
Indicates whether the version of the questionnaire is the latest. The default value is Y. The latest version is used in new questionnaire responses. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumPossibleScore: integer
(int64)
Title:
Maximum Possible Score
Read Only:true
Maximum score that you can achieve in the questionnaire. -
Name: string
Title:
Questionnaire Name
Read Only:true
Maximum Length:240
Name of the questionnaire. -
Owner: string
Title:
Owner
Read Only:true
Maximum Length:240
Owner of the questionnaire. Indicates the person ID who can edit the questionnaire, when private. -
PageLayout: string
Title:
Page Layout
Read Only:true
Maximum Length:30
Default Value:1
Layout of the questionnaire on a page. This isn't applicable to mobile responsive pages. -
PrivacyFlag: boolean
Title:
Privacy
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether the questionnaire is private. Y indicates that the questionnaire is private and only the owner can edit. N indicates that the questionnaire is public and anyone can edit it with the required privileges. -
QstnrTemplateId: integer
(int64)
Title:
Questionnaire Template ID
Read Only:true
Unique identifier of the template used to create the questionnaire. -
QstnrVersionNumber: integer
(int64)
Title:
Questionnaire Version Number
Read Only:true
Default Value:1
Version of the questionnaire. When the definition of a questionnaire changes, you can version the change and retain the original definition of the questionnaire. -
QstnsPERPage: integer
(int64)
Title:
Maximum Number of Questions per Page
Read Only:true
Number of questions displayed on a page. This isn't applicable to mobile responsive pages. -
QuestionnaireCode: string
Title:
Questionnaire Code
Read Only:true
Maximum Length:240
User-defined identifier of the questionnaire. -
QuestionnaireId: integer
(int64)
Title:
Questionnaire ID
Read Only:true
Application generated primary key of the questionnaire. -
ScoredFlag: boolean
Title:
Score Questionnaire
Read Only:true
Maximum Length:30
Indicates whether a score is calculated for the questionnaire. -
SectionOrder: string
Title:
Section Order
Read Only:true
Maximum Length:30
Default Value:S
Section order when responding to the questionnaire. Valid options are Sequential and Random. -
SectionPresentation: string
Title:
Section Presentation
Read Only:true
Maximum Length:30
Default Value:S
Presentation of sections when responding to the questionnaire. Valid options are Stack Regions and No Sections. -
Status: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:D
Status of the questionnaire. Valid values are Active, Draft, and Inactive. -
SubscriberCode: string
Title:
Subscriber
Read Only:true
Maximum Length:30
Unique code of the subscribing application where the questionnaire is used. -
SubscriberId: integer
(int64)
Title:
Subscriber
Read Only:true
Identifier of the subscribing application where the questionnaire is used. -
TemplateFlag: boolean
Title:
Template
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether the questionnaire is a template. -
VersionDescription: string
Title:
Version Description
Read Only:true
Maximum Length:2000
Description of the version of the questionnaire.
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.