Get a site

get

/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}

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=
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : recruitingCESites-item-response
Type: object
Show Source
  • Cookie Consent
    Title: Cookie Consent
    The cookieConsent resource is a child of recruitingCESites. It includes the details of the accepted cookies. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Custom action defined on the recruitingCESites.
  • Site Custom Fonts
    Title: Site Custom Fonts
    The customFonts resource is a child of recruitingCESites. It includes the details for the custom fonts. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Site Custom Icons
    Title: Site Custom Icons
    The customIcons resource is a child of recruitingCESites. It includes the details for the custom icons. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Maximum Length: 4
    Default Language of the recruitingCESites.
  • ID assigned to each HTML email template for the career site.
  • Indicates whether events are enabled for a career site. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Filters
    Title: Filters
    The filters resource is a child of recruitingCESites. It includes all the filters of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Foot Links
  • Header Links
  • Job Category Links
  • Read Only: true
    Maximum Length: 255
    Language opted on the recruitingCESites.
  • Languages
    Title: Languages
    The languages resource is a child of recruitingCESites. It includes the details of languages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Links
  • Maximum Length: 1000
    Image source used as Open Graph Image when sharing the page on social platforms.
  • Pages
    Title: Pages
    The pages resource is a child of recruitingCESites. It includes the details of the pages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Replacement site number for the recruitingCESites.
  • Maximum Length: 1000
    Get SEO description
  • Maximum Length: 4000
    Get SEO keywords
  • Maximum Length: 1000
    Get SEO organization logo
  • Maximum Length: 300
    Get SEO organization name
  • Maximum Length: 4000
    Get SEO organization url
  • Sequence number for the recruitingCESites.
  • Settings
    Title: Settings
    The settings resource is a child of recruitingCESites. It includes all the settings of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Maximum Length: 200
    Code assigned to the recruitingCESites.
  • Site Favicon
    Title: Site Favicon
    The siteFavicon is the child resource of recruitingCESites. It includes three sizes of favorite icons for each site. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Unique ID assigned to each site.
  • Maximum Length: 240
    Name assigned to the recruitingCESites.
  • Maximum Length: 240
    Number assigned to the recruitingCESites.
  • Maximum Length: 240
    Site display name for URL.
  • Maximum Length: 20
    Status code assigned to the recruitingCESites.
  • Talent Community Sign Up
    Title: Talent Community Sign Up
    The resource gives talent community sign up in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Maximum Length: 240
    Number assigned to the template of the recruitingCESites.
  • Unique ID assigned to each site theme.
  • Maximum Length: 240
    Number assigned to the theme of the recruitingCESites.
  • Header Link Translations
    Title: Header Link Translations
    The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Nested Schema : Cookie Consent
Type: array
Title: Cookie Consent
The cookieConsent resource is a child of recruitingCESites. It includes the details of the accepted cookies. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Site Custom Fonts
Type: array
Title: Site Custom Fonts
The customFonts resource is a child of recruitingCESites. It includes the details for the custom fonts. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Site Custom Icons
Type: array
Title: Site Custom Icons
The customIcons resource is a child of recruitingCESites. It includes the details for the custom icons. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Filters
Type: array
Title: Filters
The filters resource is a child of recruitingCESites. It includes all the filters of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Languages
Type: array
Title: Languages
The languages resource is a child of recruitingCESites. It includes the details of languages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Pages
Type: array
Title: Pages
The pages resource is a child of recruitingCESites. It includes the details of the pages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Settings
Type: array
Title: Settings
The settings resource is a child of recruitingCESites. It includes all the settings of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Site Favicon
Type: array
Title: Site Favicon
The siteFavicon is the child resource of recruitingCESites. It includes three sizes of favorite icons for each site. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Talent Community Sign Up
Type: array
Title: Talent Community Sign Up
The resource gives talent community sign up in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Header Link Translations
Type: array
Title: Header Link Translations
The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-cookieConsent-item-response
Type: object
Show Source
Nested Schema : Header Link Translations
Type: array
Title: Header Link Translations
The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-cookieConsent-translations-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-customFonts-item-response
Type: object
Show Source
Nested Schema : Site Custom Font Settings
Type: array
Title: Site Custom Font Settings
The customFontsSettings resource is a child of customFonts. It includes the details for the custom font settings. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-customFonts-customFontsSettings-item-response
Type: object
Show Source
Nested Schema : Site Custom Font Setting Files
Type: array
Title: Site Custom Font Setting Files
The customFontsFiles resource is a child of customFontsSettings. It includes the details for the custom font files. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-customFonts-customFontsSettings-customFontsFiles-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-customIcons-item-response
Type: object
Show Source
Nested Schema : Site Custom Icon Settings
Type: array
Title: Site Custom Icon Settings
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-customIcons-customIconSettings-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-filters-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-languages-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-pages-item-response
Type: object
Show Source
Nested Schema : Section Parameters
Type: array
Title: Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Sections
Type: array
Title: Sections
The sections resource is a child of pages. It includes the details of the sections in each page in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Header Link Translations
Type: array
Title: Header Link Translations
The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-pages-pageParams-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-pages-sections-item-response
Type: object
Show Source
  • Components
    Title: Components
    The components resource is a child of sections. It includes the details of components in the sections of each page in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Custom action that can be done on sections defined on the recruitingCESites.
  • Element ID in page sections.
  • Maximum Length: 240
    Element number of the sections on the pages in the recruitingCESites
  • Default Value: 0
    Element order of the sections on the pages in the recruitingCESites
  • Links
  • Section Parameters
    Title: Section Parameters
    The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Nested Schema : Components
Type: array
Title: Components
The components resource is a child of sections. It includes the details of components in the sections of each page in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Section Parameters
Type: array
Title: Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-pages-sections-components-item-response
Type: object
Show Source
Nested Schema : Section Parameters
Type: array
Title: Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Component Translations
Type: array
Title: Component Translations
The componentTranslations resource is a child of the recruitingCESites resource. It includes the details of the translations of the components in the sections of each page in the career site. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-pages-sections-components-componentParams-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-pages-sections-components-componentTranslations-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-pages-sections-sectionParams-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-pages-translations-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-settings-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-siteFavicon-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-talentCommunitySignUp-item-response
Type: object
Show Source
Nested Schema : Header Link Translations
Type: array
Title: Header Link Translations
The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESites-talentCommunitySignUp-translations-item-response
Type: object
Show Source
Nested Schema : recruitingCESites-translations-item-response
Type: object
Show Source
Back to Top