Get a job application flow
get
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}
Request
Path Parameters
-
PrimaryKey(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=
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 : recruitingCEApplyFlows-item-response
Type:
Show Source
object
-
EsignDescriptionStr: string
Read Only:
true
Description of the specific version of the electronic signature. -
EsignDescriptionVersionId: integer
(int64)
Read Only:
true
ID for the version of the electronic signature. -
EsignEnabledFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if electronic signature is enabled. -
EventNumber: string
Read Only:
true
Maximum Length:64
Event number for the event registration flow. -
FlowCode: string
Read Only:
true
Maximum Length:30
Flow code in the job application flows. -
FlowId: integer
(int64)
Read Only:
true
Unique identifier for the job application flows. -
FlowName: string
Read Only:
true
Maximum Length:240
Flow name for the job application flows. -
FlowTypeCode: string
Read Only:
true
Maximum Length:30
Flow type code in the job application flows. -
FlowVersionId: integer
(int64)
Read Only:
true
Flow version ID in the job application flows. -
FlowVersionName: string
Read Only:
true
Maximum Length:240
Flow version name for the job application flows. -
LegalDescriptionStr: string
Read Only:
true
Description of the specific legal disclaimer version. -
LegalDescriptionVersionId: integer
(int64)
Read Only:
true
ID for the legal disclaimer version. -
LegalEnabledFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the legal disclaimer is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptinDescriptionStr: string
Read Only:
true
Description of the specific opt in. -
OptinDescriptionVersionId: integer
(int64)
Read Only:
true
ID for OptinDescriptionVersion. -
OptinEnabledFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if TC opt in is enabled. -
PrimaryKey: integer
Read Only:
true
Primary key for the job application flow. -
ProfileVersion: string
Read Only:
true
Specific version for profile. -
requisitionFlexFields: array
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. -
RequisitionNumber: string
Default Value:
_DEFAULT_PLACE_HOLDER
Requisition number for the job application flow. -
sections: array
Sections
Title:
Sections
The sections resource is a child of recruitingCEApplyFlows. It includes all the corresponding sections for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use. -
SingleClickApplyFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if single click apply is enabled. -
TCOptinEnabledFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the talent community opt-in is enabled.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 recruitingCEApplyFlows. It includes all the corresponding sections for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
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 : recruitingCEApplyFlows-requisitionFlexFields-item-response
Type:
Show Source
object
-
ColumnName: string
Read Only:
true
Column name of a flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Prompt: string
Read Only:
true
Display label of a flexfield. -
SequenceNumber: integer
Read Only:
true
Sequence number of a flexfield. -
Value: string
Read Only:
true
Value of a flexfield.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEApplyFlows-sections-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
pages: array
Pages
Title:
Pages
The pages resource is a child of the recruitingCErecruitingCEApplyFlows resource. It includes all the corresponding pages for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use. -
SectionName: string
Title:
Section Name
Read Only:true
Maximum Length:240
Name of a section in job application flow. -
SectionSequence: integer
(int32)
Read Only:
true
Unique ID for section.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pages
Type:
array
Title:
Pages
The pages resource is a child of the recruitingCErecruitingCEApplyFlows resource. It includes all the corresponding pages for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCEApplyFlows-sections-pages-item-response
Type:
Show Source
object
-
blocks: array
Blocks
Title:
Blocks
The blocks resource is a child of the pages resources. It includes all the corresponding blocks for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageName: string
Read Only:
true
Maximum Length:240
Name of pages in the job application flow. -
PageSequence: integer
(int32)
Read Only:
true
Unique ID for pages in the job application flow.
Nested Schema : Blocks
Type:
array
Title:
Blocks
The blocks resource is a child of the pages resources. It includes all the corresponding blocks for the job application flow. 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 : recruitingCEApplyFlows-sections-pages-blocks-item-response
Type:
Show Source
object
-
BlockCode: string
Read Only:
true
Maximum Length:30
Unique code for blocks. -
BlockInstructions: string
Title:
Instructions
Read Only:true
Maximum Length:1000
Instructions for the block. -
BlockName: string
Read Only:
true
Maximum Length:240
Name of the block. -
BlockProperties: string
Read Only:
true
Get all blocks of a recruiting secondary application flow -
BlockSequence: integer
(int32)
Read Only:
true
Unique ID for blocks. -
BlockTitle: string
Title:
Block Title
Read Only:true
Maximum Length:240
Title of the block. -
HideInMobileFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the hide in mobile is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetadataService: string
Read Only:
true
MetadataService in blocks. -
PageBlockId: integer
(int64)
Read Only:
true
MetadataService in blocks. -
ReadWriteService: string
Read Only:
true
ReadWriteService in blocks.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- requisitionFlexFields
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/requisitionFlexFieldsParameters:
- PrimaryKey:
$request.path.PrimaryKey
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. - PrimaryKey:
- sections
-
Parameters:
- PrimaryKey:
$request.path.PrimaryKey
The sections resource is a child of recruitingCEApplyFlows. It includes all the corresponding sections for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use. - PrimaryKey: