Get all recruiting secondary application flows

get

/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows

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; integer; Finds all recruiting secondary application flows based on a unique ID.
      Finder Variables
      • PrimaryKey; integer; Primary key and primary key variable to find recruiting secondary application flows.
    • findBySubmission Finds all recruiting secondary application flows based on the submission ID.
      Finder Variables
      • FlowId; integer; Flow ID in the job application of the recruiting secondary application flow.
      • SubmissionId; integer; Submission ID in the job application of the recruiting secondary application flow.
  • 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:
    • EsignDescriptionVersionId; integer; E-Signature version of the recruiting secondary application flow.
    • EsignEnabledFlag; boolean; Indicates whether the electronic signature is enabled or disabled for the recruiting secondary application flow.
    • FlowCode; string; Code assigned to the recruiting secondary application flow.
    • FlowId; integer; ID assigned to the recruiting secondary application flow.
    • FlowName; string; Name assigned to the recruiting secondary application flow.
    • FlowTypeCode; string; Code assigned to the type of recruiting secondary application flow.
    • FlowVersionId; integer; ID assigned to the version of recruiting secondary application flow.
    • FlowVersionName; string; Name assigned to the version of recruiting secondary application flow.
    • OptinDescriptionVersionId; integer; Campaign opt in version of the recruiting secondary application flow.
    • OptinEnabledFlag; boolean; Indicates whether campaign opt in is enabled or disabled for the recruiting secondary application flow.
    • PrimaryKey; integer; Primary key of the recruiting secondary application flow.
    • ProfileVersion; string; Profile version of the recruiting secondary application flow.
    • SingleClickApplyFlag; boolean; Indicates whether the one page application flow is enabled or disabled for the recruiting secondary application flow.
    • SubmissionId; integer; ID assigned when the recruiting secondary application is submitted.
    • TCOptinEnabledFlag; boolean; Indicates whether Talent Community opt in is enabled or disabled for the recruiting secondary application flows.
  • 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 : recruitingCESecondaryApplyFlows
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingCESecondaryApplyFlows-item-response
Type: object
Show Source
  • Read Only: true
    E-Signature option of the recruiting secondary application flow.
  • Read Only: true
    E-Signature version of the recruiting secondary application flow.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the electronic signature is enabled or disabled for the recruiting secondary application flow.
  • Read Only: true
    Maximum Length: 30
    Code assigned to the recruiting secondary application flow.
  • Read Only: true
    ID assigned to the recruiting secondary application flow.
  • Read Only: true
    Maximum Length: 240
    Name assigned to the recruiting secondary application flow.
  • Read Only: true
    Maximum Length: 30
    Code assigned to the type of recruiting secondary application flow.
  • Read Only: true
    ID assigned to the version of recruiting secondary application flow.
  • Read Only: true
    Maximum Length: 240
    Name assigned to the version of recruiting secondary application flow.
  • Links
  • Read Only: true
    Campaign opt in option of the recruiting secondary application flow.
  • Read Only: true
    Campaign opt in version of the recruiting secondary application flow.
  • Read Only: true
    Maximum Length: 1
    Indicates whether campaign opt in is enabled or disabled for the recruiting secondary application flow.
  • Read Only: true
    Primary key of the recruiting secondary application flow.
  • Read Only: true
    Profile version of the recruiting secondary application flow.
  • Requisition Flexfields
    Title: Requisition Flexfields
    The requisitionFlexFields resource is a child of the recruitingCEApplyFlows resource. It includes all the job requisition flexfields configured for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Sections
    Title: Sections
    The sections resource is a child of the recruitingCESecondaryApplyFlows resource. It provides details about the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the one page application flow is enabled or disabled for the recruiting secondary application flow.
  • Read Only: true
    ID assigned when the recruiting secondary application is submitted.
  • Read Only: true
    Maximum Length: 1
    Indicates whether Talent Community opt in is enabled or disabled for the recruiting secondary application flows.
Nested Schema : Requisition Flexfields
Type: array
Title: Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEApplyFlows resource. It includes all the job requisition flexfields configured for the job application flow. 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 the recruitingCESecondaryApplyFlows resource. It provides details about the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESecondaryApplyFlows-requisitionFlexFields-item-response
Type: object
Show Source
Nested Schema : recruitingCESecondaryApplyFlows-sections-item-response
Type: object
Show Source
  • Links
  • Pages
    Title: Pages
    The pages resource is the child of the sections resource. It provides details about the pages of the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Title: Section Name
    Read Only: true
    Maximum Length: 240
    Section name of the recruiting secondary application flow.
  • Read Only: true
    Section sequence of the recruiting secondary application flow.
Nested Schema : Pages
Type: array
Title: Pages
The pages resource is the child of the sections resource. It provides details about the pages of the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESecondaryApplyFlows-sections-pages-item-response
Type: object
Show Source
  • Blocks
    Title: Blocks
    The blocks resource is the child of the pages resources. It provides details about the blocks of the pages contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
  • Links
  • Read Only: true
    Maximum Length: 240
    Page name of the recruiting secondary application flow.
  • Read Only: true
    Page sequence of the recruiting secondary application flow.
Nested Schema : Blocks
Type: array
Title: Blocks
The blocks resource is the child of the pages resources. It provides details about the blocks of the pages contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCESecondaryApplyFlows-sections-pages-blocks-item-response
Type: object
Show Source
Back to Top