1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Check-In Documents
  4. Questionnaire Responses
  5. Question Responses

Get all question responses

get

/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key for the Check-In Documents resource and used to uniquely identify an instance of Check-In Documents. The client should not generate the hash key value. Instead, the client should query on the Check-In Documents collection resource in order to navigate to a specific instance of Check-In Documents to get the hash key.
Query Parameters
  • 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>
  • 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 all question responses that match the primary key specified.
      Finder Variables
      • QuestionResponseId; integer; Surrogate identifier for the question response.
  • 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:
    • AnswerList; string; Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.
    • CreatedBy; string; Name of the user who created the question response.
    • CreationDate; string; Date and time when the question response was created.
    • LastUpdateDate; string; Date and time when the question response was last updated.
    • LastUpdatedBy; string; Name of the user who last updated the question response.
    • QuestionAnswerId; integer; Surrogate identifier of the answer that a participant chose when responding to a single choice question.
    • QuestionCode; string; Alphanumeric value that uniquely identifies a question defined for a subscriber.
    • QuestionResponseId; integer; Surrogate identifier for the question response.
    • QuestionnaireQuestionId; integer; Surrogate identifier for the question in a questionnaire.
  • 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
  • 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 : checkInDocuments-questionnaireResponses-questionResponses
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all question responses by submitting a collection GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/checkInDocuments/<checkInDocumentIdHash>/child/questionnaireResponses/<questionnaireResponseId>/child/questionResponses

Note:

Get all the question responses in context of the checkIn document under a particular questionnaire response.

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
        "items" : [
         {
           "QuestionResponseId" : "33232344343",
           "QuestionId" : "323233434",
           "QuestionVersionNumber" : "3",
           "QuestionCode" : "Plain Text Question Code",
           "AnswerText" : "Sample Response 1",
           "QuestionAnswerId" : "null",
           "AnswerList" : "null",
           "Links" : [
                           {....},
                         ]
         },
        {
           "QuestionResponseId" : "33232344348",
           "QuestionId" : "323233437",
           "QuestionVersionNumber" : "2",
           "QuestionCode" : "Single Choice Question Code",
           "AnswerText" : "null",
           "QuestionAnswerId" : "213234332",
           "AnswerList" : "null",
           "CreatedBy" : "Meg",
           "CreationDate" : "20-Oct-2018",
           "LastUpdatedBy" : "Meg",
           "LastUpdateDate" : "20-Oct-2018",
           "Links" : [
                           {....},
                       ]
        },
        {
           "QuestionResponseId" : "33232344340",
           "QuestionId" : "323233432",
           "QuestionVersionNumber" : "3",
           "QuestionCode" : "Multiple Choice Question Code",
           "AnswerText" : "null",
           "QuestionAnswerId" : "null",
           "AnswerList" : "3002323, 23234443, 3223434343",
           "CreatedBy" : "Meg",
           "CreationDate" : "20-Oct-2018",
           "LastUpdatedBy" : "Meg",
           "LastUpdateDate" : "20-Oct-2018",
           "Links" : [
                           {.....},
                         ]
        }
     ],
    "rel" : "self",
    "href" : "{url}: {port}/<context>/checkInDocuments/<checkInDocumentId>/child/questionnaireResponses/child/3203232212121/questionResponses",
    "kind" : "collection",
    "name" : "questionResponses"
 }
Back to Top