Get all recruiting events

get

/hcmRestApi/resources/11.13.18.05/recruitingCEEvents

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 all recruiting events using a unique ID.
      Finder Variables
      • SearchId; integer; Not supported bind variable.
    • findEvents Finds all recruiting events.
      Finder Variables
      • facetsList; string; List of filter facets supported on recruiting events.
      • keyword; string; Keyword used to find recruiting events.
      • lastSelectedFacet; string; Name of last selected facet for filtering recruiting events.
      • latitude; number; Latitude of the location of job requisition.
      • limit; integer; Limit indicates the total number of events that can be retrieved on a single API call.
      • locationId; integer; Location entered on search bar.
      • longitude; number; Longitude of the location of the job requisition
      • offset; integer; Offset position of the set of events being retrieved.
      • radius; integer; Radius of the job requisition.
      • radiusUnit; string; Unit of the radius; integer; of the job requisition.
      • selectedEventCategoriesFacet; string; Event categories facet value selected for filtering recruiting events.
      • selectedEventFormatsFacet; string; Event format facet value selected for filtering recruiting events.
      • selectedLocationsFacet; string; Location facet value selected for filtering recruiting events.
      • selectedStartDatesFacet; string; Start date facet value selected for filtering recruiting events.
      • siteNumber; string; Site number used to find recruiting events.
      • sortBy; string; Sort parameters that are used to order recruiting events.
      • userTargetFacetInputTerm; string; Keyword used to refine the target facet filter.
      • userTargetFacetName; string; Filter upon which a keyword; string; is entered to refine the set of filter values.
  • 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:
    • Facets; string; Facets of the events list.
    • LastSelectedFacetAttr; string; Last selected facet of the events list.
    • LatitudeAttr; integer; Latitude of the location of the event.
    • LimitAttr; integer; Limit of the events list.
    • LongitudeAttr; integer; Longitude of the location of the event.
    • OffsetAttr; integer; Offset of the events list.
    • RadiusAttr; integer; Radius of the event.
    • RadiusUnitAttr; string; Unit of the radius of the event.
    • SearchId; integer; Search ID of the recruiting event.
    • SelectedEventCategoriesFacetAttr; string; Selected values of the event category facet.
    • SelectedEventFormatsFacetAttr; string; Selected values of the event format facet.
    • SelectedLocationsFacetAttr; string; Selected values of the location facet.
    • SelectedStartDatesFacetAttr; string; Selected values of the start date facet.
    • SiteNumber; string; Site number of the recruiting event.
    • SortByAttr; string; Sort by attribute of the events list.
    • TotalEventsCount; integer; Total events count of the recruiting event.
    • UserTargetFacetInputTermAttr; string; User entered term for refining facets further.
    • UserTargetFacetNameAttr; string; The facet that's being refined further.
    • keyword; string; Keyword of the recruiting event.
    • locationIdAttr; integer; Location identifier used to filter events.
  • 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 : recruitingCEEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCEEvents-item-response
Type: object
Show Source
Nested Schema : Event Category Facets
Type: array
Title: Event Category Facets
The eventCategoriesFacet resource is a child of recruitingCEEvents. It includes the details of the event categories facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Event Format Facets
Type: array
Title: Event Format Facets
The eventFormatsFacet resource is a child of recruitingCEEvents. It includes the details of the event formats facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Recruiting Events List of Values
Type: array
Title: Recruiting Events List of Values
The eventList is the child of the recruitingCEEvents resource and provides the list of values for recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Location Facets
Type: array
Title: Location Facets
The locationsFacet resource is a child of recruitingCEEvents. It includes the details of the event location facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Start Date Range Facets
Type: array
Title: Start Date Range Facets
The startDatesFacet resource is a child of recruitingCEEvents. It includes the details of the event start date facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCEEvents-eventCategoriesFacet-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Identifier of the event category facet item.
  • Links
  • Read Only: true
    Maximum Length: 255
    Name of the event category facet item.
  • Read Only: true
    Count of events matching the event category facet item.
Nested Schema : recruitingCEEvents-eventFormatsFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEEvents-eventList-item-response
Type: object
Show Source
Nested Schema : recruitingCEEvents-locationsFacet-item-response
Type: object
Show Source
Nested Schema : recruitingCEEvents-startDatesFacet-item-response
Type: object
Show Source
  • Read Only: true
    Identifier of the event start date range facet item.
  • Links
  • Read Only: true
    Maximum Length: 255
    Name of the event start date range facet item.
  • Read Only: true
    Count of events matching the event start date range facet item.
Back to Top