Get a recruiting event
get
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}
Request
Path Parameters
-
SearchId(required): integer
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=Default Value:
1
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 : recruitingCEEvents-item-response
Type:
Show Source
object
-
eventCategoriesFacet: array
Event Category Facets
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. -
eventFormatsFacet: array
Event Format Facets
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. -
eventList: array
Recruiting Events List of Values
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. -
Facets: string
Read Only:
true
Maximum Length:255
Facets of the events list. -
keyword: string
Maximum Length:
255
Keyword of the recruiting event. -
LastSelectedFacetAttr: string
Read Only:
true
Maximum Length:255
Last selected facet of the events list. -
LatitudeAttr: integer
(int64)
Read Only:
true
Latitude of the location of the event. -
LimitAttr: integer
(int64)
Read Only:
true
Limit of the events list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationIdAttr: integer
Read Only:
true
Location identifier used to filter events. -
locationsFacet: array
Location Facets
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. -
LongitudeAttr: integer
(int64)
Read Only:
true
Longitude of the location of the event. -
OffsetAttr: integer
Read Only:
true
Offset of the events list. -
RadiusAttr: integer
Read Only:
true
Radius of the event. -
RadiusUnitAttr: string
Read Only:
true
Maximum Length:255
Unit of the radius of the event. -
SearchId: integer
Default Value:
1
Search ID of the recruiting event. -
SelectedEventCategoriesFacetAttr: string
Read Only:
true
Maximum Length:255
Selected values of the event category facet. -
SelectedEventFormatsFacetAttr: string
Read Only:
true
Maximum Length:255
Selected values of the event format facet. -
SelectedLocationsFacetAttr: string
Read Only:
true
Maximum Length:255
Selected values of the location facet. -
SelectedStartDatesFacetAttr: string
Read Only:
true
Maximum Length:255
Selected values of the start date facet. -
SiteNumber: string
Maximum Length:
255
Site number of the recruiting event. -
SortByAttr: string
Read Only:
true
Maximum Length:255
Sort by attribute of the events list. -
startDatesFacet: array
Start Date Range Facets
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. -
TotalEventsCount: integer
Total events count of the recruiting event.
-
UserTargetFacetInputTermAttr: string
Read Only:
true
Maximum Length:255
User entered term for refining facets further. -
UserTargetFacetNameAttr: string
Read Only:
true
Maximum Length:255
The facet that's being refined further.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
Id: string
Read Only:
true
Maximum Length:255
Identifier of the event category facet item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:255
Name of the event category facet item. -
TotalCount: integer
Read Only:
true
Count of events matching the event category facet item.
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.
Nested Schema : recruitingCEEvents-eventFormatsFacet-item-response
Type:
Show Source
object
-
Id: integer
Read Only:
true
Identifier of the event format facet item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:255
Name of the event format facet item. -
TotalCount: integer
Read Only:
true
Count of events matching the event format facet item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEEvents-eventList-item-response
Type:
Show Source
object
-
BannerImageURL: string
Read Only:
true
Maximum Length:255
Banner image URL of the recruiting event list of values. -
Distance: number
Read Only:
true
Total distance from the center of a radius search. -
EndDate: string
(date-time)
Read Only:
true
End date of the recruiting event list of values. -
EventFormat: string
Read Only:
true
Maximum Length:255
Event format of the recruiting event list of values. -
EventNumber: string
Read Only:
true
Maximum Length:255
Event number of the recruiting event list of values. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:255
Event location of the recruiting event list of values. -
RegistrationClosedFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the event registration is closed or not. -
ShortDescriptionStr: string
Read Only:
true
Maximum Length:255
Short description of the recruiting event list of values. -
StartDate: string
(date-time)
Read Only:
true
Start date of the recruiting event list of values. -
Title: string
Read Only:
true
Maximum Length:255
Title of the recruiting event list of values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEEvents-locationsFacet-item-response
Type:
Show Source
object
-
Id: integer
Read Only:
true
Identifier of the location facet item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:255
Name of the location facet item. -
TotalCount: integer
Read Only:
true
Count of events matching the location facet.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEEvents-startDatesFacet-item-response
Type:
Show Source
object
-
Id: integer
Read Only:
true
Identifier of the event start date range facet item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:255
Name of the event start date range facet item. -
TotalCount: integer
Read Only:
true
Count of events matching the event start date range facet item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- eventCategoriesFacet
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventCategoriesFacetParameters:
- SearchId:
$request.path.SearchId
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. - SearchId:
- eventFormatsFacet
-
Parameters:
- SearchId:
$request.path.SearchId
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. - SearchId:
- eventList
-
Parameters:
- SearchId:
$request.path.SearchId
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. - SearchId:
- locationsFacet
-
Parameters:
- SearchId:
$request.path.SearchId
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. - SearchId:
- startDatesFacet
-
Parameters:
- SearchId:
$request.path.SearchId
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. - SearchId: