Get all pages in recruitingCESites

get

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

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
  • 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

    • PageByCodeAndStatusFinder Find pages in recruitingCESites by PageByCodeAndStatusFinder
      Finder Variables
      • PageCode; string; Find pages in recruitingCESites by PageByCodeAndStatusFinder and PageCode; string;
      • StatusCode; string; Find pages in recruitingCESites by PageByCodeAndStatusFinder and StatusCode; string;
    • PageByCodeFinder Find pages in recruitingCESites by PageByCodeFinder
      Finder Variables
      • PageCode; string; Find pages in recruitingCESites by PageByCodeFinder and PageCode; string;
    • PageByElementNumber Find pages in recruitingCESites by PageByElementNumber
      Finder Variables
      • ElementNumber; string; Find pages in recruitingCESites by PageByElementNumber and ElementNumber; string;
    • PageByTitle Find pages in recruitingCESites by PageTitle finder
      Finder Variables
      • Title; string; Find pages in recruitingCESites by PageTitle
    • PrimaryKey Find pages in recruitingCESites by a unique ID
      Finder Variables
      • ElementId; integer; Finds the recruitingCESites page by primary key and the ElementID variable
      • PageId; integer; Finds the recruitingCESites page by primary key and the PageID variable
  • 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:
    • CreationDate; string; Date of creation of the pages in the recruitingCESites.
    • CustomAction; string; Custom action that can be done on pages defined on the recruitingCESites.
    • ElementId; integer; Unique ID assigned to each element in the page.
    • ElementNumber; string; Element number assigned to the pages in the recruitingCESites.
    • Language; string; Language used in the pages on the recruitingCESites.
    • OgDescription; string; Organization description.
    • OgImageSrc; string; Organization image source.
    • PageCode; string; Code assigned to the pages in the recruitingCESites.
    • PageId; integer; Unique ID assigned to each page.
    • PublishedDate; string; Date of publishing of the pages in the recruitingCESites.
    • SeoDescription; string; Description of the search engine optimization used on the pages.
    • SiteCode; string; Code assigned to the recruitingCESites on which the pages are published.
    • SiteNumber; string; Number of the parent resource for page assigned to the recruitingCESites.
    • StatusCode; string; Code assigned to the status of the pages.
    • Title; string; Title assigned to the pages in the recruitingCESites.
  • 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 : recruitingCESites-pages
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
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
Back to Top