Get all questions

get

/hcmRestApi/resources/11.13.18.05/questions

Request

Query Parameters
  • 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
  • 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).
  • 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
  • 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 the question that matches the primary key criteria specified.
      Finder Variables
      • QuestionId; integer; Surrogate identifier for the question.
      • VersionNumber; integer; Version number of the question. New questions must have version number 1.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AllJobFamiliesFlag; boolean; Indicates whether the question is applicable to all job families. This flag is only used for the questions defined for the recruiting subscriber.
    • AllJobFunctionsFlag; boolean; Indicates whether the question is applicable to all job functions. This flag is only used for the questions defined for the recruiting subscriber.
    • AllLocationsFlag; boolean; Indicates whether the question is applicable to all locations. This flag is only used for the questions defined for the recruiting subscriber.
    • AllOrganizationsFlag; boolean; Indicates whether the question is applicable to all organizations. This flag is only used for the questions defined for the recruiting subscriber.
    • AllowAdditionalCommentsFlag; boolean; Indicates whether a participant can provide additional comments while responding to a question. Valid values are Y and N. The default value is N.
    • AllowAttachmentsFlag; boolean; Indicates whether an attachment is allowed as a response to the question.
    • CandidateCode; string; Code identifying the candidate type to whom the question applies to. Only the recruiting subscriber uses this question.
    • CandidateCodeMeaning; string; Meaning of the candidate code. Valid values are Internal, External and Both.
    • ClassificationCode; string; Code classifying the use of the question defined for Recruiting subscribers, like prescreening, and disqualification. Valid values are in the common lookups list of values.
    • ClassificationMeaning; string; Meaning of the classification code.
    • ConditionalDisplayFlag; boolean; Indicates whether a question is conditionally displayed. When this is set to Y, controlling question code and controlling response are mandatory.
    • CreatedBy; string; Name of the user who created the question.
    • CreationDate; string; Date when the question was created.
    • Editor; string; Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.
    • EditorPersonName; string; Name of the person with privileges to edit the question marked as private. Required if question is marked as private.
    • EditorPersonNumber; string; Person number of the person with privileges to edit the question marked private. Required if question is marked as private.
    • FolderId; integer; Surrogate identifier of the folder where the question is stored.
    • FolderName; string; Name of the folder where the question is stored. Valid values are defined in the questionnaire folders list of values and include Active, Draft and Inactive.
    • InstructionsText; string; Instructions or additional information for the question.
    • LastUpdateDate; string; Date when the question was last updated.
    • LastUpdatedBy; string; Name of the user who last updated the question.
    • LatestVersion; string; Setting that indicates if this is the latest version of the question. This is a read-only attribute.
    • PrivacyFlag; boolean; Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.
    • PrivacyMeaning; string; Meaning of the privacy code. A value of Yes indicates the question is private and only the specified owner can edit. A value of No indicates the question isn't restricted for edits.
    • QuestionCode; string; Alphanumeric value that uniquely identifies a question defined for a subscriber.
    • QuestionId; integer; Surrogate identifier for the question.
    • QuestionText; string; Text of the question being asked.
    • QuestionType; string; Code identifying the type of question. Valid values are in the list commonLookupsLOV.
    • QuestionTypeMeaning; string; Meaning of the question type code.
    • RatingModelCode; string; Code identifying the rating model used to define the answer choices for the question.
    • RatingModelId; integer; Surrogate identifier of the rating model used to define the answer choices for the question.
    • RatingModelName; string; Name of the rating model used to define the answer choices for the question.
    • ResponseOrder; string; Code that shows whether the answer choices are presented in random sequence or in the defined sequence. Valid values include R to randomize the answer choices defined and V (vertical) to present the answer choices in the defined order.
    • ResponseOrderMeaning; string; Meaning of the response order code.
    • ResponseTypeId; integer; Surrogate identifier of the response type for the question.
    • ScoredFlag; boolean; Indicates the question is used in the score calculation.
    • Status; string; Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
    • StatusMeaning; string; Meaning of the status code.
    • SubscriberCode; string; Code for the subscriber using the question. The list questionnaireSubscribersLOV includes the valid values.
    • SubscriberId; integer; Surrogate identifier for the subscriber.
    • SubscriberName; string; Name of the subscriber that the question is used for. Valid values are defined in the list questionnaireSubscribersLOV.
    • VersionNumber; integer; Version number of the question. New questions must have a version number of 1.
  • 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
  • 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.
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : questions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : questions-item-response
Type: object
Show Source
  • Title: Casual Question
    Read Only: true
    Maximum Length: 30
    Default Value: false
    Indicates whether the question is an ad hoc question. You can't create, modify, or delete ad hoc questions as these are casual questions and aren't maintained as setup data. The default value is false.
  • Title: All Job Families
    Read Only: true
    Maximum Length: 30
    Indicates whether the question is applicable to all job families. This flag is only used for the questions defined for the recruiting subscriber.
  • Title: All Job Functions
    Read Only: true
    Maximum Length: 30
    Indicates whether the question is applicable to all job functions. This flag is only used for the questions defined for the recruiting subscriber.
  • Title: All Locations
    Read Only: true
    Maximum Length: 30
    Indicates whether the question is applicable to all locations. This flag is only used for the questions defined for the recruiting subscriber.
  • Title: All Organizations
    Read Only: true
    Maximum Length: 30
    Indicates whether the question is applicable to all organizations. This flag is only used for the questions defined for the recruiting subscriber.
  • Title: Allow Additional Comments
    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.
  • Title: Allow Attachments
    Maximum Length: 30
    Default Value: false
    Indicates whether an attachment is allowed as a response to the question.
  • Answers
    Title: Answers
    The answers resource is a child of the questions resource. It provides a list of choices that a user can select from when answering single or multiple choice questions.
  • Attachments
    Title: Attachments
    The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
  • Title: Candidate Code
    Maximum Length: 30
    Code identifying the candidate type to whom the question applies to. Only the recruiting subscriber uses this question.
  • Title: Candidate Type
    Read Only: true
    Maximum Length: 80
    Meaning of the candidate code. Valid values are Internal, External and Both.
  • Title: Classification Code
    Maximum Length: 30
    Code classifying the use of the question defined for Recruiting subscribers, like prescreening, and disqualification. Valid values are in the common lookups list of values.
  • Title: Question Classification
    Read Only: true
    Maximum Length: 80
    Meaning of the classification code.
  • Title: Conditional Display
    Maximum Length: 30
    Indicates whether a question is conditionally displayed. When this is set to Y, controlling question code and controlling response are mandatory.
  • Title: Controlling Response
    Maximum Length: 240
    Answer to the controlling question that determines whether the application displays the question or not.
  • Title: Controlling Answer Id
    Surrogate identifier of the controlling answer. Required if the conditional display is set to Y.
  • Title: Controlling Question Code
    Maximum Length: 240
    Question code for the controlling question, response to which determines whether the application displays the question or not.
  • Title: Controlling Question Id
    Surrogate identifier of the controlling question. Required if the conditional display is set to Y.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Name of the user who created the question.
  • Title: Creation Date
    Read Only: true
    Date when the question was created.
  • Title: Owner
    Maximum Length: 64
    Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.
  • Title: Person Name
    Read Only: true
    Maximum Length: 240
    Name of the person with privileges to edit the question marked as private. Required if question is marked as private.
  • Title: Person Number
    Maximum Length: 30
    Person number of the person with privileges to edit the question marked private. Required if question is marked as private.
  • Title: Folder Id
    Surrogate identifier of the folder where the question is stored.
  • Title: Folder
    Maximum Length: 240
    Name of the folder where the question is stored. Valid values are defined in the questionnaire folders list of values and include Active, Draft and Inactive.
  • Title: Instruction Text
    Maximum Length: 4000
    Instructions or additional information for the question.
  • Job Family Contexts
    Title: Job Family Contexts
    The jobFamilyContexts resource is a child of the questions resource. It provides the job family that the question applies to. This context is used only by the recruiting subscriber.
  • Job Function Contexts
    Title: Job Function Contexts
    The jobFunctionContexts resource is a child of the questions resource. It provides the job function that the question applies to. This context is used only by the recruiting subscriber.
  • Title: Last Update Date
    Read Only: true
    Date when the question was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the question.
  • Title: Latest Version
    Read Only: true
    Setting that indicates if this is the latest version of the question. This is a read-only attribute.
  • Links
  • Location Contexts
    Title: Location Contexts
    The locationContexts resource is a child of the questions resource. It provides the recruiting location that the question applies to. This context is used only by the recruiting subscriber.
  • Title: Maximum Value
    Latest date to be supported as the response when a participant responds to a question.
  • Title: Maximum Possible Score
    Read Only: true
    Sum of the positive scores of possible answer choices for the question. For multiple choice questions, it's the sum of positive scores of the maximum number of selections allowed by the question. If the answer choices have no positive score defined, then the sum is zero.
  • Title: Maximum Number of Selections
    Maximum number of answer choices that a participant can select when responding to a multiple choice question.
  • Title: Maximum Calculated Score
    Maximum score allowed for the question when answered.
  • Title: Minimum Value
    Earliest date supported as the response when a participant responds to a question.
  • Title: Minimum Number of Selections
    Minimum number of answer choices that a participant can select when responding to a multiple choice question.
  • Title: Minimum Calculated Score
    Minimum score allowed for the question when answered.
  • Organization Contexts
    Title: Organization Contexts
    The organizationContexts resource is a child of the questions resource. It provides the recruiting organization that the question applies to. This context is used only by the recruiting subscriber.
  • Title: Override Rating Level Description
    Maximum Length: 30
    Default Value: false
    Indicates whether the answer defined in a question came from a rating model level and if the description of the rating level was changed in the question.
  • Title: Privacy Code
    Maximum Length: 30
    Default Value: false
    Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.
  • Title: Privacy
    Read Only: true
    Maximum Length: 80
    Meaning of the privacy code. A value of Yes indicates the question is private and only the specified owner can edit. A value of No indicates the question isn't restricted for edits.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Question Text
    Maximum Length: 2000
    Text of the question being asked.
  • Title: Question Type Code
    Maximum Length: 30
    Default Value: TEXT
    Code identifying the type of question. Valid values are in the list commonLookupsLOV.
  • Title: Question Type
    Read Only: true
    Maximum Length: 80
    Meaning of the question type code.
  • Title: Rating Model Code
    Maximum Length: 30
    Code identifying the rating model used to define the answer choices for the question.
  • Title: Rating Model Id
    Surrogate identifier of the rating model used to define the answer choices for the question.
  • Title: Rating Model
    Read Only: true
    Maximum Length: 240
    Name of the rating model used to define the answer choices for the question.
  • Title: Response Maximum Length
    Maximum Length: 20
    Maximum allowed length of responses for a question of text response type.
  • Title: Response Minimum Length
    Minimum expected length of responses for a question of text response type.
  • Title: Response Order Code
    Maximum Length: 30
    Code that shows whether the answer choices are presented in random sequence or in the defined sequence. Valid values include R to randomize the answer choices defined and V (vertical) to present the answer choices in the defined order.
  • Title: Response Order
    Read Only: true
    Maximum Length: 80
    Meaning of the response order code.
  • Title: Response Type Code
    Maximum Length: 30
    Response type allowed for the question. The list questionnaireResponseTypesLOV includes the valid values.
  • Title: Response Type Id
    Default Value: 1
    Surrogate identifier of the response type for the question.
  • Title: Response Type
    Read Only: true
    Maximum Length: 240
    Meaning of the response type code.
  • Title: Sample Size
    Maximum number of answer choices presented to the participant when responding to the question.
  • Title: Score Question
    Maximum Length: 30
    Default Value: false
    Indicates the question is used in the score calculation.
  • Title: Status Code
    Maximum Length: 30
    Default Value: D
    Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Meaning of the status code.
  • Title: Subscriber Code
    Maximum Length: 30
    Code for the subscriber using the question. The list questionnaireSubscribersLOV includes the valid values.
  • Title: Subscriber Id
    Surrogate identifier for the subscriber.
  • Title: Subscriber Name
    Maximum Length: 240
    Name of the subscriber that the question is used for. Valid values are defined in the list questionnaireSubscribersLOV.
  • Title: Update Allowed
    Read Only: true
    Maximum Length: 30
    Default Value: true
    Indicates whether updates are allowed to this question.
  • Title: Version Description
    Maximum Length: 2000
    Description provided by the user when a new version of the question is created.
  • Title: Version Number
    Default Value: 1
    Version number of the question. New questions must have a version number of 1.
Nested Schema : Answers
Type: array
Title: Answers
The answers resource is a child of the questions resource. It provides a list of choices that a user can select from when answering single or multiple choice questions.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
Show Source
Nested Schema : Job Family Contexts
Type: array
Title: Job Family Contexts
The jobFamilyContexts resource is a child of the questions resource. It provides the job family that the question applies to. This context is used only by the recruiting subscriber.
Show Source
Nested Schema : Job Function Contexts
Type: array
Title: Job Function Contexts
The jobFunctionContexts resource is a child of the questions resource. It provides the job function that the question applies to. This context is used only by the recruiting subscriber.
Show Source
Nested Schema : Location Contexts
Type: array
Title: Location Contexts
The locationContexts resource is a child of the questions resource. It provides the recruiting location that the question applies to. This context is used only by the recruiting subscriber.
Show Source
Nested Schema : Organization Contexts
Type: array
Title: Organization Contexts
The organizationContexts resource is a child of the questions resource. It provides the recruiting organization that the question applies to. This context is used only by the recruiting subscriber.
Show Source
Nested Schema : questions-answers-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
Show Source
Nested Schema : questions-answers-attachments-item-response
Type: object
Show Source
Nested Schema : questions-attachments-item-response
Type: object
Show Source
Nested Schema : questions-jobFamilyContexts-item-response
Type: object
Show Source
Nested Schema : questions-jobFunctionContexts-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Name of the user who created the job function context for the question.
  • Title: Creation Date
    Read Only: true
    Date when the job function context for the question was created.
  • Title: Job Function
    Read Only: true
    Maximum Length: 80
    Name of the job function context defined for the question.
  • Title: Job Function Code
    Maximum Length: 30
    Code of the job function context defined for the question.
  • Title: Last Update Date
    Read Only: true
    Date when the job function context for the question was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the job function context for the question.
  • Links
  • Title: Question Context Id
    Read Only: true
    Surrogate identifier for the job function context for a question.
Nested Schema : questions-locationContexts-item-response
Type: object
Show Source
Nested Schema : questions-organizationContexts-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Date when the recruiting organization context for the question was last updated.
  • Title: Creation Date
    Read Only: true
    Name of the user who created the recruiting organization context for the question.
  • Title: Last Update Date
    Read Only: true
    Date when the recruiting organization context for the question was created.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Name of the user who last updated the recruiting organization context for the question.
  • Links
  • Title: Organization Id
    Surrogate identifier of the recruiting organization defined as a context for the question.
  • Title: Organization Name
    Maximum Length: 240
    Name of the recruiting organization defined as a context for the question.
  • Title: Question Context Id
    Read Only: true
    Surrogate identifier for the organization context for a question.
Back to Top