Get an answer
get
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}
Request
Path Parameters
-
answersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Answers resource and used to uniquely identify an instance of Answers. The client should not generate the hash key value. Instead, the client should query on the Answers collection resource in order to navigate to a specific instance of Answers to get the hash key.
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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 : 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.
Links
- RatingLevelVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: ShortAnswerText; Target Attribute: RatingLevelCode
- Display Attribute: RatingLevelCode
- attachments
-
Parameters:
- answersUniqID:
$request.path.answersUniqID
- questionsUniqID:
$request.path.questionsUniqID
The attachments resource is a child of the questions resource. It includes details of the attachments in a question. - answersUniqID: