1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Event Registrations

Get all recruiting event registrations

get

/hcmRestApi/resources/11.13.18.05/recruitingICEEventRegistrations

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 event registrations based on primary key criteria.
      Finder Variables
      • EventPoolMemberId; integer; Unique identifier for the event pool member.
    • findActiveRegistrations Finds active event registrations for a candidate.
      Finder Variables
      • findEventRegistrations Finds event registrations for a candidate.
        Finder Variables
        • findHistoryRegistrations Finds the history of event registrations for a candidate.
          Finder Variables
        • 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:
          • Action; string; Action attribute used in the post call.
          • ConfirmedFlag; boolean; Indicates whether the event registration is confirmed.
          • DisqualifiedFlag; boolean; Indicates whether the candidate is disqualified.
          • EventEndDateString; string; End date of the event.
          • EventFormat; string; Specifies the format of the event.
          • EventFormatCode; string; Code for the format of the event.
          • EventId; integer; Unique identifier for the event.
          • EventLocation; string; Location of the recruiting event.
          • EventName; string; Name of the event that the registration is made for.
          • EventNumber; string; Number of the event.
          • EventOwnerName; string; Name of the event owner.
          • EventOwnerPersonId; integer; Person identifier of the event owner.
          • EventPhaseCode; string; Phase code of the event.
          • EventPoolMemberId; integer; Unique identifier for the event pool member.
          • EventStartDateString; string; Start date of the event.
          • MeetingURL; string; The event meeting URL.
          • PersonId; integer; Unique identifier of the person associated with the event registration.
          • QrCodeCheckinFlag; boolean; Indicates whether QR code check-in is enabled for this event.
          • QstnrVersionNumber; integer; Questionnaire version number associated with the event.
          • QuestionnaireId; integer; Unique identifier for the questionnaire associated with the event.
          • RegistrationOnDateString; string; Date when a candidate registered for the event.
          • RegistrationStateCode; string; Code for the current state of the event registration.
          • Status; string; Indicates whether the event registration is active or not.
        • 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 : recruitingICEEventRegistrations
        Type: object
        Show Source
        Nested Schema : Items
        Type: array
        Title: Items
        The items in the collection.
        Show Source
        Nested Schema : recruitingICEEventRegistrations-item-response
        Type: object
        Show Source
        Nested Schema : Candidate Attachments
        Type: array
        Title: Candidate Attachments
        The attachments resource provides information about files attached to the interview.
        Show Source
        Nested Schema : Questionnaire Responses
        Type: array
        Title: Questionnaire Responses
        The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
        Show Source
        Nested Schema : recruitingICEEventRegistrations-attachments-item-response
        Type: object
        Show Source
        Nested Schema : recruitingICEEventRegistrations-questionnaireResponses-item-response
        Type: object
        Show Source
        Nested Schema : Question Responses
        Type: array
        Title: Question Responses
        The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
        Show Source
        Nested Schema : recruitingICEEventRegistrations-questionnaireResponses-questionResponses-item-response
        Type: object
        Show Source
        • Title: Answer Code
          Read Only: true
          Maximum Length: 240
          The answer code that a participant chose when responding to a single choice question.
        • Title: Answer Code List
          Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
        • Title: Comments
          Maximum Length: 4000
          Additional comments provided by the participant when responding to a question.
        • Title: Answer
          Attachment provided by the participant when responding to a question.
        • Title: Answer List
          Maximum Length: 2000
          Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
        • Title: Answer Short Description
          Read Only: true
          Maximum Length: 2000
          Text of the answer chosen by a participant when responding to a single choice question.
        • Title: Answer Short Description
          Read Only: true
          Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
        • Title: Choice List Code
          Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
        • Title: Choice List
          Maximum Length: 2000
          Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
        • Title: Choice Short Description
          Read Only: true
          Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          User who created the question response.
        • Title: Creation Date
          Read Only: true
          Date on which the question response was created.
        • Title: Last Update Date
          Read Only: true
          Date on which the question response was updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          User who last updated the question response.
        • Links
        • Title: Question Answer Id
          Surrogate identifier of the answer that a participant chose when responding to a single choice question.
        • 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: Questionnaire Question Id
          Surrogate identifier for the question in a questionnaire.
        • Title: Question Response Id
          Surrogate identifier for the question response.
        • Title: Question Text
          Read Only: true
          Maximum Length: 2000
          Text of the question that a participant responds to.
        • Title: Answer Score
          Read Only: true
          Calculated score for the responses provided for a question by a participant.
        Back to Top