Get all requisition lists

get

/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList

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=
    Default Value: 1
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

    • PrimaryKey Finds job requisitions list using a unique ID
      Finder Variables
      • findById Finds job requisitions list using findbyId
        Finder Variables
        • Id; string; Finds job requisitions list using findbyId and ID
    • 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:
      • BeFirstToApplyFlag; boolean; Indicates whether the job requisition has a low number of job applications and will invite candidates to be the first to apply.
      • BusinessUnit; string; Business unit name of the job requisition.
      • ContractType; string; Contract type of the job requisition.
      • Department; string; Department name of the job requisition.
      • Distance; number; Total distance from the center of a radius search.
      • DomesticTravelRequired; string; Indicates whether domestic travel is required for the job requisition.
      • ExternalQualificationsStr; string; Qualifications of the job requisition.
      • ExternalResponsibilitiesStr; string; Responsibilities of the job requisition.
      • GeographyId; integer; Geography ID of the job requisition list.
      • HotJobFlag; boolean; Indicates whether the job requisition is considered a hot job.
      • Id; string; ID assigned to the job requisition list.
      • InternationalTravelRequired; string; Indicates whether international travel is required for the job requisition.
      • JobFamily; string; Job family of the job requisition.
      • JobFunction; string; Job function of the job requisition.
      • JobSchedule; string; Job schedule of the job requisition.
      • JobShift; string; Job shift of the job requisition.
      • JobType; string; Job type of the job requisition.
      • Language; string; Language of the job requisition.
      • LegalEmployer; string; Legal employer of the job requisition.
      • ManagerLevel; string; Management level of the job requisition.
      • MediaThumbURL; string; Media thumb URL for the job requisition list.
      • Organization; string; Organization name of the job requisition.
      • PostedDate; string; Date of posting of the requisition list.
      • PostingEndDate; string; Posting end date of the job requisition.
      • PrimaryLocation; string; Primary location of the requisition list.
      • PrimaryLocationCountry; string; Country of the primary location of the requisition list.
      • Relevancy; number; Relevancy score of the job requisition.
      • ShortDescriptionStr; string; Short description string of the requisition list.
      • StudyLevel; string; Education level of the job requisition.
      • Title; string; Title of the requisition list.
      • TrendingFlag; boolean; Indicates whether the job requisition has a high number of job applications and should be displayed as trending in a job requisition details preview..
      • WorkDays; string; Work days of the job requisition.
      • WorkDurationMonths; integer; Work duration months of the job requisition.
      • WorkDurationYears; integer; Work duration years of the job requisition.
      • WorkHours; string; Work hours of the job requisition.
      • WorkerType; string; Worker type of the job requisition.
      • WorkplaceType; string; Workplace in a job requisition details preview.
      • WorkplaceTypeCode; string; Workplace type code in a job requisition details preview.
    • 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 : recruitingCEJobRequisitions-requisitionList
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : recruitingCEJobRequisitions-requisitionList-item-response
    Type: object
    Show Source
    Nested Schema : Other Work Locations
    Type: array
    Title: Other Work Locations
    The otherWorkLocations resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about other work locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
    Show Source
    Nested Schema : Primary Location Coordinates
    Type: array
    Title: Primary Location Coordinates
    The primaryLocationCoordinates resource is a child of recruitingCEJobRequisitionDetails. It includes details of primary location coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
    Show Source
    Nested Schema : Descriptive Flexfields
    Type: array
    Title: Descriptive Flexfields
    The requisitionFlexFields resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use.
    Show Source
    Nested Schema : Secondary Locations
    Type: array
    Title: Secondary Locations
    The secondaryLocations resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about the secondary locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
    Show Source
    Nested Schema : Work Locations
    Type: array
    Title: Work Locations
    The workLocation resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about work locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
    Show Source
    Nested Schema : recruitingCEJobRequisitions-requisitionList-otherWorkLocations-item-response
    Type: object
    Show Source
    • Title: Address Line 1
      Read Only: true
      Maximum Length: 240
      Address line 1 for other work locations in a job requisition details preview.
    • Title: Address Line 2
      Read Only: true
      Maximum Length: 240
      Address line 2 for other work locations in a job requisition details preview.
    • Title: Address Line 3
      Read Only: true
      Maximum Length: 240
      Address line 3 for other work locations in a job requisition details preview.
    • Title: Address Line 4
      Read Only: true
      Maximum Length: 240
      Address line 4 for other work locations in a job requisition details preview.
    • Title: Building
      Read Only: true
      Maximum Length: 240
      Building of other work locations in a job requisition details preview.
    • Title: Country
      Read Only: true
      Maximum Length: 60
      Country of other work locations in a job requisition details preview.
    • Latitude of other work locations in a job requisition details preview.
    • Links
    • Title: Other Work Locations
      Location ID of other work locations in a job requisition details preview.
    • Title: Display Name
      Read Only: true
      Maximum Length: 240
      Location name of other work locations in a job requisition details preview.
    • Longitude of other work locations in a job requisition details preview.
    • Title: Postal Code
      Read Only: true
      Maximum Length: 30
      Postal code of other work locations in a job requisition details preview.
    • Title: Region 1
      Read Only: true
      Maximum Length: 120
      Region 1 of other work locations in a job requisition details preview.
    • Title: Region 2
      Read Only: true
      Maximum Length: 120
      Region 2 of other work locations in a job requisition details preview.
    • Title: Region 3
      Read Only: true
      Maximum Length: 120
      Region 3 of other work locations in a job requisition details preview.
    • Location ID of the secondary locations in a job requisition details preview.
    • Title: Town or City
      Read Only: true
      Maximum Length: 30
      Town or city of other work locations in a job requisition details preview.
    Nested Schema : recruitingCEJobRequisitions-requisitionList-primaryLocationCoordinates-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobRequisitions-requisitionList-requisitionFlexFields-item-response
    Type: object
    Show Source
    • Read Only: true
      Maximum Length: 80
      Context code of the requisition flexfield of the requisition details.
    • Links
    • Read Only: true
      Maximum Length: 80
      Prompt of the requisition flexfield of the requisition details.
    • Read Only: true
      Maximum Length: 30
      Segment code of the requisition flexfield of the requisition details.
    • Read Only: true
      Maximum Length: 4000
      Value of the requisition flexfield of the requisition details.
    Nested Schema : recruitingCEJobRequisitions-requisitionList-secondaryLocations-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobRequisitions-requisitionList-workLocation-item-response
    Type: object
    Show Source
    • Title: Address Line 1
      Read Only: true
      Maximum Length: 240
      Address line 1 of work locations in a job requisition details preview.
    • Title: Address Line 2
      Read Only: true
      Maximum Length: 240
      Address line 2 of work locations in a job requisition details preview.
    • Title: Address Line 3
      Read Only: true
      Maximum Length: 240
      Address line 3 of work locations in a job requisition details preview.
    • Title: Address Line 4
      Read Only: true
      Maximum Length: 240
      Address line 4 of work locations in a job requisition details preview.
    • Title: Building
      Read Only: true
      Maximum Length: 240
      Building of work locations in a job requisition details preview.
    • Title: Country
      Read Only: true
      Maximum Length: 60
      Country of work locations in a job requisition details preview.
    • Latitude of work locations in a job requisition details preview.
    • Links
    • Read Only: true
      Location ID of work locations in a job requisition details preview.
    • Title: Display Name
      Read Only: true
      Maximum Length: 240
      Location name of work locations in a job requisition details preview.
    • Longitude of work locations in a job requisition details preview.
    • Title: Postal Code
      Read Only: true
      Maximum Length: 30
      Postal code of work locations in a job requisition details preview.
    • Title: Region 1
      Read Only: true
      Maximum Length: 120
      Region 1 of work locations in a job requisition details preview.
    • Title: Region 2
      Read Only: true
      Maximum Length: 120
      Region 2 of work locations in a job requisition details preview.
    • Title: Region 3
      Read Only: true
      Maximum Length: 120
      Region 3 of work locations in a job requisition details preview.
    • Title: Town or City
      Read Only: true
      Maximum Length: 30
      Town or city of work locations in a job requisition details preview.
    Back to Top