1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Recruiting CE Questions

Get details of all questions

get

/hcmRestApi/resources/11.13.18.05/recruitingICEQuestions

Request

Query Parameters
  • 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 details of the questionnaire row by a unique ID
      Finder Variables
      • RowFinder Finds details of the questionnaire row
        Finder Variables
        • QstnrVersionNumber; integer; Finds details of the questionnaire row by Questionnaire Version Number
        • QuestionnaireId; integer; Finds details of the questionnaire row by Questionnaire ID
        • RequisitionNumber; string; Finds details of the questionnaire row by RequisitionNumber; string;
      • RowFinderICE Finds details about the internal questionnaire row.
        Finder Variables
        • RequisitionNumber; string; Requisition number used to find details about the internal questionnaire row.
      • findByEvents Finds details of the questionnaire by event
        Finder Variables
        • EventNumber; string; Event number used to find details of the questionnaire
    • 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:
      • AttributeName; integer; Attribute Name in questions.
      • ConditionAnswerId; integer; ID assigned to the answer which entails an additional questionnaire.
      • ConditionDisplay; string; Indicates if an additional questionnaire is associated with the answer.
      • ConditionQstnVersionNumber; integer; Version number assigned to the additional questionnaire associated with the answer.
      • ConditionQuestionId; integer; ID assigned to the question which entails an additional questionnaire.
      • EventNumber; string; Event number associated with the question.
      • InstructionsText; string; Additional instructions for the question.
      • MaximumDate; string; Maximum date in questions.
      • MaximumLength; string; Maximum Length in questions.
      • MaximumSelections; integer; Maximum Selections in questions.
      • MinimumDate; string; Minimum date in questions.
      • MinimumLength; integer; Minimum Length in questions.
      • MinimumSelections; integer; Minimum Selections in questions.
      • Prompt; string; Prompt in questions.
      • QstnrVersionNumber; integer; Questionnaire version number.
      • QuestionnaireId; integer; Questionnaire ID.
      • RequiredFlag; boolean; Indicates if the question is required to be answered.
      • RequisitionNumber; string; Requisition number in questions.
      • Type; string; Type in questions.
      • UIDisplayType; string; UI display type in questions.
    • 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 : recruitingICEQuestions
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : recruitingICEQuestions-item-response
    Type: object
    Show Source
    Nested Schema : Answers to the Questions
    Type: array
    Title: Answers to the Questions
    The answers resource is a child of the recruitingJobSiteApplicationQuestions resource and provides details about the answers provided by the candidate to the prescreening questions being asked when they apply for a job. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
    Show Source
    Nested Schema : recruitingICEQuestions-answers-item-response
    Type: object
    Show Source
    Back to Top