Get a draft
get
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
Request
Path Parameters
-
APPDraftId(required): integer(int64)
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 : recruitingCEJobApplicationDrafts-item-response
Type:
Show Source
object
-
APPDraftId: integer
(int64)
Unique identifier for each job application draft.
-
AreaCode: string
Maximum Length:
30
Area code for the candidate phone number of the job application draft. -
attachments: array
Attachments of the Job Application Drafts
Title:
Attachments of the Job Application Drafts
The attachments resource is the child of the recruitingCEJobApplicationDrafts resource and includes all the attachments of a draft job application. Note that the service endpoints in this resource category are only for Oracle internal use. -
CandidateNumber: string
Maximum Length:
240
Candidate number of the job application draft. -
CandLastModifiedDate: string
(date-time)
Read Only:
true
Candidate last modification date of the job application draft. -
Content: string
(byte)
Content of the job application draft.
-
ContentLanguage: string
Maximum Length:
30
Language for the job application draft. -
CountryCode: string
Maximum Length:
30
Country code for candidate phone number of the job application draft. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Login of user who created the job application draft. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the job application draft was created. -
CustomAction: string
Custom action used to update the job application draft.
-
DraftId: integer
Unique identifier for each job application draft.
-
DraftSource: string
Maximum Length:
240
Source of the draft data that indicates whether the profile has been imported or manually fed. -
Email: string
Maximum Length:
255
Email address of the candidate who created the job application draft. -
EmailAddress: string
Maximum Length:
240
Email address of the candidate who created the job application draft. -
FlowId: integer
(int64)
Identifier of the request information flow.
-
LastAccessedOn: string
Maximum Length:
1000
Last agent used to access the draft application. -
LastJobExecutionDate: string
(date-time)
Read Only:
true
Date and time when notification for job was sent for the job application draft. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the job application draft was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of user who updated the job application draft. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
User login who updated the job application draft. -
LegalDescriptionVersionId: integer
(int64)
Description version ID of the job application draft.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModificationDate: string
(date-time)
Last modification date of the draft job application submitted by the candidate.
-
ObjectStatus: string
Maximum Length:
40
Default Value:ORA_ACTIVE
Status of the job application draft. -
ObjectVersionNumber: integer
(int32)
Version number of the job application draft.
-
PhoneNumber: string
Maximum Length:
60
Phone number of candidate related to the job application draft. -
PreferredChannel: string
Maximum Length:
30
Preferred channel of communication with the candidate. -
ProposedCandidateNumber: string
Maximum Length:
30
Proposed candidate number for a new candidate. -
RequisitionNumber: string
Maximum Length:
512
Job requisition number of the job application draft. -
SiteNumber: string
Maximum Length:
240
Site Number of the job application draft. -
StepActionUsageId: integer
(int64)
Identifier of the step of the draft job application.
-
SubmissionId: integer
(int64)
Identifier of the job application of the draft job application.
Nested Schema : Attachments of the Job Application Drafts
Type:
array
Title:
Attachments of the Job Application Drafts
The attachments resource is the child of the recruitingCEJobApplicationDrafts resource and includes all the attachments of a draft job application. 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 : recruitingCEJobApplicationDrafts-attachments-item-response
Type:
Show Source
object
-
Action: string
Action for attachment of the job application draft.
-
APPDraftId: integer
Identifier of attachment of the job application draft.
-
Attachment: string
Attachment of the job application draft.
-
CandidateNumber: string
Maximum Length:
255
Candidate number associated with the attachment of the job application draft. -
Category: string
Category of attachment of the job application draft.
-
Description: string
Description of attachment of the job application draft.
-
FileContents: string
File content of attachment of the job application draft.
-
Id: string
Unique identifier for the attachment of the job application draft.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MimeType: string
Mime type of attachment of the job application draft.
-
SourceAttachmentId: string
Source attachment ID of the attachment of the job application draft.
-
Title: string
Title of attachment of the job application draft.
-
Type: string
Type of attachment of the job application draft.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachmentsParameters:
- APPDraftId:
$request.path.APPDraftId
The attachments resource is the child of the recruitingCEJobApplicationDrafts resource and includes all the attachments of a draft job application. Note that the service endpoints in this resource category are only for Oracle internal use. - APPDraftId: