Update a question
patch
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
Request
Path Parameters
-
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AllowAdditionalCommentsFlag: boolean
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. -
AllowAttachmentsFlag: boolean
Title:
Allow Attachments
Maximum Length:30
Default Value:false
Indicates whether an attachment is allowed as a response to the question. -
answers: array
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: array
Attachments
Title:
Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question. -
CandidateCode: string
Title:
Candidate Code
Maximum Length:30
Code identifying the candidate type to whom the question applies to. Only the recruiting subscriber uses this question. -
ClassificationCode: string
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. -
ConditionalDisplayFlag: boolean
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. -
ControllingAnswerCode: string
Title:
Controlling Response
Maximum Length:240
Answer to the controlling question that determines whether the application displays the question or not. -
ControllingAnswerId: integer
(int64)
Title:
Controlling Answer Id
Surrogate identifier of the controlling answer. Required if the conditional display is set to Y. -
ControllingQuestionCode: string
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. -
ControllingQuestionId: integer
(int64)
Title:
Controlling Question Id
Surrogate identifier of the controlling question. Required if the conditional display is set to Y. -
Editor: string
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. -
EditorPersonNumber: string
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. -
InstructionsText: string
Title:
Instruction Text
Maximum Length:4000
Instructions or additional information for the question. -
jobFamilyContexts: array
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. -
jobFunctionContexts: array
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. -
locationContexts: array
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. -
MaximumDate: string
(date)
Title:
Maximum Value
Latest date to be supported as the response when a participant responds to a question. -
MaximumResponses: integer
(int64)
Title:
Maximum Number of Selections
Maximum number of answer choices that a participant can select when responding to a multiple choice question. -
MaximumThresholdScore: integer
(int64)
Title:
Maximum Calculated Score
Maximum score allowed for the question when answered. -
MinimumDate: string
(date)
Title:
Minimum Value
Earliest date supported as the response when a participant responds to a question. -
MinimumResponses: integer
(int64)
Title:
Minimum Number of Selections
Minimum number of answer choices that a participant can select when responding to a multiple choice question. -
MinimumThresholdScore: integer
(int64)
Title:
Minimum Calculated Score
Minimum score allowed for the question when answered. -
organizationContexts: array
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. -
OverrideDescriptionFlag: boolean
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. -
PrivacyFlag: boolean
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. -
QuestionText: string
Title:
Question Text
Maximum Length:2000
Text of the question being asked. -
QuestionType: string
Title:
Question Type Code
Maximum Length:30
Default Value:TEXT
Code identifying the type of question. Valid values are in the list commonLookupsLOV. -
RatingModelCode: string
Title:
Rating Model Code
Maximum Length:30
Code identifying the rating model used to define the answer choices for the question. -
RatingModelId: integer
(int64)
Title:
Rating Model Id
Surrogate identifier of the rating model used to define the answer choices for the question. -
ResponseMaximumLength: string
Title:
Response Maximum Length
Maximum Length:20
Maximum allowed length of responses for a question of text response type. -
ResponseMinimumLength: integer
(int64)
Title:
Response Minimum Length
Minimum expected length of responses for a question of text response type. -
ResponseOrder: string
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. -
ResponseType: string
Title:
Response Type Code
Maximum Length:30
Response type allowed for the question. The list questionnaireResponseTypesLOV includes the valid values. -
ResponseTypeId: integer
(int64)
Title:
Response Type Id
Default Value:1
Surrogate identifier of the response type for the question. -
SampleSize: integer
(int64)
Title:
Sample Size
Maximum number of answer choices presented to the participant when responding to the question. -
ScoredFlag: boolean
Title:
Score Question
Maximum Length:30
Default Value:false
Indicates the question is used in the score calculation. -
Status: string
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.
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 : schema
Type:
Show Source
object
-
AddlQuestionnaireId: integer
(int64)
Title:
Additional Questionnaire
Surrogate identifier of the questionnaire sent to candidates from whom additional information is requested. Used only for the recruiting subscriber. -
AddlQuestionnaireVersionNumber: integer
(int64)
Title:
Additional Questionnaire
Version number of the additional questionnaire sent to the participant. Used only for the recruiting subscriber. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question. -
CorrectFlag: boolean
Title:
Correct Answer Code
Maximum Length:30
Default Value:false
Indicates whether the answer choice is correct or incorrect for a question. -
LongAnswerText: string
Title:
Short Description
Maximum Length:2000
Answer text presented to the participant as a choice for a question when responding to a questionnaire. -
RatingLevelId: integer
(int64)
Title:
Rating Level Id
Surrogate identifier of the rating level from which the answer choice is created. -
ResponseFeedback: string
(byte)
Title:
Response Feedback
Feedback provided to the participant when the answer choice is chosen. -
Score: integer
(int64)
Title:
Score
Score for the answer choice. -
SequenceNumber: integer
(int64)
Title:
Sequence Number
Sequence in which the answer choice is presented during response by a participant. -
ShortAnswerText: string
Title:
Short Text
Maximum Length:240
Short text of the answer choice.
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-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only file attachment is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire template. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment.
Nested Schema : questions-attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only file attachment is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire template. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment.
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.
Root Schema : questions-item-response
Type:
Show Source
object
-
AdhocFlag: boolean
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. -
AllJobFamiliesFlag: boolean
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. -
AllJobFunctionsFlag: boolean
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. -
AllLocationsFlag: boolean
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. -
AllOrganizationsFlag: boolean
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. -
AllowAdditionalCommentsFlag: boolean
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. -
AllowAttachmentsFlag: boolean
Title:
Allow Attachments
Maximum Length:30
Default Value:false
Indicates whether an attachment is allowed as a response to the question. -
answers: array
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: array
Attachments
Title:
Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question. -
CandidateCode: string
Title:
Candidate Code
Maximum Length:30
Code identifying the candidate type to whom the question applies to. Only the recruiting subscriber uses this question. -
CandidateCodeMeaning: string
Title:
Candidate Type
Read Only:true
Maximum Length:80
Meaning of the candidate code. Valid values are Internal, External and Both. -
ClassificationCode: string
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. -
ClassificationMeaning: string
Title:
Question Classification
Read Only:true
Maximum Length:80
Meaning of the classification code. -
ConditionalDisplayFlag: boolean
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. -
ControllingAnswerCode: string
Title:
Controlling Response
Maximum Length:240
Answer to the controlling question that determines whether the application displays the question or not. -
ControllingAnswerId: integer
(int64)
Title:
Controlling Answer Id
Surrogate identifier of the controlling answer. Required if the conditional display is set to Y. -
ControllingQuestionCode: string
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. -
ControllingQuestionId: integer
(int64)
Title:
Controlling Question Id
Surrogate identifier of the controlling question. Required if the conditional display is set to Y. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the question was created. -
Editor: string
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. -
EditorPersonName: string
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. -
EditorPersonNumber: string
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. -
FolderId: integer
(int64)
Title:
Folder Id
Surrogate identifier of the folder where the question is stored. -
FolderName: string
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. -
InstructionsText: string
Title:
Instruction Text
Maximum Length:4000
Instructions or additional information for the question. -
jobFamilyContexts: array
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. -
jobFunctionContexts: array
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. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the question was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the question. -
LatestVersion: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationContexts: array
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. -
MaximumDate: string
(date)
Title:
Maximum Value
Latest date to be supported as the response when a participant responds to a question. -
MaximumPossibleScore: integer
(int64)
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. -
MaximumResponses: integer
(int64)
Title:
Maximum Number of Selections
Maximum number of answer choices that a participant can select when responding to a multiple choice question. -
MaximumThresholdScore: integer
(int64)
Title:
Maximum Calculated Score
Maximum score allowed for the question when answered. -
MinimumDate: string
(date)
Title:
Minimum Value
Earliest date supported as the response when a participant responds to a question. -
MinimumResponses: integer
(int64)
Title:
Minimum Number of Selections
Minimum number of answer choices that a participant can select when responding to a multiple choice question. -
MinimumThresholdScore: integer
(int64)
Title:
Minimum Calculated Score
Minimum score allowed for the question when answered. -
organizationContexts: array
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. -
OverrideDescriptionFlag: boolean
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. -
PrivacyFlag: boolean
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. -
PrivacyMeaning: string
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. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionText: string
Title:
Question Text
Maximum Length:2000
Text of the question being asked. -
QuestionType: string
Title:
Question Type Code
Maximum Length:30
Default Value:TEXT
Code identifying the type of question. Valid values are in the list commonLookupsLOV. -
QuestionTypeMeaning: string
Title:
Question Type
Read Only:true
Maximum Length:80
Meaning of the question type code. -
RatingModelCode: string
Title:
Rating Model Code
Maximum Length:30
Code identifying the rating model used to define the answer choices for the question. -
RatingModelId: integer
(int64)
Title:
Rating Model Id
Surrogate identifier of the rating model used to define the answer choices for the question. -
RatingModelName: string
Title:
Rating Model
Read Only:true
Maximum Length:240
Name of the rating model used to define the answer choices for the question. -
ResponseMaximumLength: string
Title:
Response Maximum Length
Maximum Length:20
Maximum allowed length of responses for a question of text response type. -
ResponseMinimumLength: integer
(int64)
Title:
Response Minimum Length
Minimum expected length of responses for a question of text response type. -
ResponseOrder: string
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. -
ResponseOrderMeaning: string
Title:
Response Order
Read Only:true
Maximum Length:80
Meaning of the response order code. -
ResponseType: string
Title:
Response Type Code
Maximum Length:30
Response type allowed for the question. The list questionnaireResponseTypesLOV includes the valid values. -
ResponseTypeId: integer
(int64)
Title:
Response Type Id
Default Value:1
Surrogate identifier of the response type for the question. -
ResponseTypeMeaning: string
Title:
Response Type
Read Only:true
Maximum Length:240
Meaning of the response type code. -
SampleSize: integer
(int64)
Title:
Sample Size
Maximum number of answer choices presented to the participant when responding to the question. -
ScoredFlag: boolean
Title:
Score Question
Maximum Length:30
Default Value:false
Indicates the question is used in the score calculation. -
Status: string
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. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Meaning of the status code. -
SubscriberCode: string
Title:
Subscriber Code
Maximum Length:30
Code for the subscriber using the question. The list questionnaireSubscribersLOV includes the valid values. -
SubscriberId: integer
(int64)
Title:
Subscriber Id
Surrogate identifier for the subscriber. -
SubscriberName: string
Title:
Subscriber Name
Maximum Length:240
Name of the subscriber that the question is used for. Valid values are defined in the list questionnaireSubscribersLOV. -
UpdateAllowedFlag: boolean
Title:
Update Allowed
Read Only:true
Maximum Length:30
Default Value:true
Indicates whether updates are allowed to this question. -
VersionDescription: string
Title:
Version Description
Maximum Length:2000
Description provided by the user when a new version of the question is created. -
VersionNumber: integer
(int64)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AddlQuestionnaireId: integer
(int64)
Title:
Additional Questionnaire
Surrogate identifier of the questionnaire sent to candidates from whom additional information is requested. Used only for the recruiting subscriber. -
AddlQuestionnaireVersionNumber: integer
(int64)
Title:
Additional Questionnaire
Version number of the additional questionnaire sent to the participant. Used only for the recruiting subscriber. -
AnswerCode: string
Title:
Answer Code
Maximum Length:240
Alphanumeric value that uniquely identifies the answer choice for a subscriber. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question. -
CorrectFlag: boolean
Title:
Correct Answer Code
Maximum Length:30
Default Value:false
Indicates whether the answer choice is correct or incorrect for a question. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the answer choice. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the answer choice was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the answer choice was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the answer choice. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongAnswerText: string
Title:
Short Description
Maximum Length:2000
Answer text presented to the participant as a choice for a question when responding to a questionnaire. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Read Only:true
Surrogate identifier of the answer choice for a question. -
RatingLevelId: integer
(int64)
Title:
Rating Level Id
Surrogate identifier of the rating level from which the answer choice is created. -
RatingLevelName: string
Title:
Rating Level
Read Only:true
Maximum Length:2000
Rating level from which the answer was created. -
ResponseFeedback: string
(byte)
Title:
Response Feedback
Feedback provided to the participant when the answer choice is chosen. -
Score: integer
(int64)
Title:
Score
Score for the answer choice. -
SequenceNumber: integer
(int64)
Title:
Sequence Number
Sequence in which the answer choice is presented during response by a participant. -
ShortAnswerText: string
Title:
Short Text
Maximum Length:240
Short text of the answer choice.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questions-answers-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
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only file attachment is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire template. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image of the file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who last updated the attachment. -
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
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded 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 : questions-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
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only file attachment is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire template. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image of the file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who last updated the attachment. -
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
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questions-jobFamilyContexts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the job family context for the question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the job family context for the question was created. -
JobFamilyId: integer
(int64)
Title:
Job Family Id
Surrogate identifier of the job family defined as a context to the question. -
JobFamilyName: string
Title:
Job Family Name
Maximum Length:240
Name of the job family context defined for the question. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the job family context for the question was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the job family context for the question. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionContextId: integer
(int64)
Title:
Question Context Id
Read Only:true
Surrogate identifier for the job family context for a question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questions-jobFunctionContexts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the job function context for the question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the job function context for the question was created. -
JobFunction: string
Title:
Job Function
Read Only:true
Maximum Length:80
Name of the job function context defined for the question. -
JobFunctionCode: string
Title:
Job Function Code
Maximum Length:30
Code of the job function context defined for the question. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the job function context for the question was last updated. -
LastUpdatedBy: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionContextId: integer
(int64)
Title:
Question Context Id
Read Only:true
Surrogate identifier for the job function context for a question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questions-locationContexts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the location context for the question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the location context for the question was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the location context for the question was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the location context for the question. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location Id
Surrogate identifier of the recruiting location defined as a context to the question. -
LocationName: string
Title:
Location Name
Maximum Length:4000
Name of the recruiting location context defined for the question. -
QuestionContextId: integer
(int64)
Title:
Question Context Id
Read Only:true
Surrogate identifier for the location context for a question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questions-organizationContexts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Date when the recruiting organization context for the question was last updated. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Name of the user who created the recruiting organization context for the question. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the recruiting organization context for the question was created. -
LastUpdatedBy: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Title:
Organization Id
Surrogate identifier of the recruiting organization defined as a context for the question. -
OrganizationName: string
Title:
Organization Name
Maximum Length:240
Name of the recruiting organization defined as a context for the question. -
QuestionContextId: integer
(int64)
Title:
Question Context Id
Read Only:true
Surrogate identifier for the organization context for a question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CandidateTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HRQ_CANDIDATE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: CandidateCode; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- CategoriesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: FolderName; Target Attribute: Name
- Display Attribute: Name
- ClassificationCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HRQ_QSTN_CLASSIFICATION
The following properties are defined on the LOV link relation:- Source Attribute: ClassificationCode; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- CtrlQuestionLovVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: ControllingQuestionCode; Target Attribute: QuestionCode
- Display Attribute: QuestionCode
- PrivaciesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRQ_PRIVACY
The following properties are defined on the LOV link relation:- Source Attribute: PrivacyFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- QuestionAnswersLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ControllingAnswerCode; Target Attribute: AnswerCode
- Display Attribute: AnswerCode
- QuestionTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRQ_QUESTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: QuestionType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatingModelVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: RatingModelCode; Target Attribute: RatingModelCode
- Display Attribute: RatingModelCode
- ResponseOrdersLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRQ_QUESTION_ORDER
The following properties are defined on the LOV link relation:- Source Attribute: ResponseOrder; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- ResponseTypeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ResponseType; Target Attribute: ResponseTypeCode
- Display Attribute: ResponseTypeCode
- StatusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRQ_QUESTIONNAIRE_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SubscribersLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: SubscriberName; Target Attribute: SubscriberName
- Display Attribute: SubscriberName
- answers
-
Parameters:
- questionsUniqID:
$request.path.questionsUniqID
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. - questionsUniqID:
- attachments
-
Parameters:
- questionsUniqID:
$request.path.questionsUniqID
The attachments resource is a child of the questions resource. It includes details of the attachments in a question. - questionsUniqID:
- jobFamilyContexts
-
Parameters:
- questionsUniqID:
$request.path.questionsUniqID
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. - questionsUniqID:
- jobFunctionContexts
-
Parameters:
- questionsUniqID:
$request.path.questionsUniqID
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. - questionsUniqID:
- locationContexts
-
Parameters:
- questionsUniqID:
$request.path.questionsUniqID
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. - questionsUniqID:
- organizationContexts
-
Parameters:
- questionsUniqID:
$request.path.questionsUniqID
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. - questionsUniqID: