Create an action on the list of job applications
post
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveOnAnotherRequisitionFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
AgentFirstName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
AgentLastName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
AttachmentEntityName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
Attachments: array
Candidate Attachments
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. -
AverageFeedbackRating: number
Action returning a message indicating if the job application was created.
-
AverageRating: number
Action returning a message indicating if the job application was created.
-
CandidateNumber: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
ConfirmedFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
CreationDate: string
(date-time)
Action returning a message indicating if the job application was created.
-
CurrentPhaseName: string
Action returning a message indicating if the job application was created.
-
CurrentStateName: string
Action returning a message indicating if the job application was created.
-
DisqualifiedFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
EmployeeDisplayName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
FeedbackRatingCount: integer
Action returning a message indicating if the job application was created.
-
FlowVersionId: integer
Action returning a message indicating if the job application was created.
-
InternalAttachments: array
Candidate Attachments
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. -
InternalFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
isReferredByAgentFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
isReferredByEmployeeFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
LastContacted: integer
Action returning a message indicating if the job application was created.
-
PersonId: integer
Action returning a message indicating if the job application was created.
-
PreferredLocations: array
Candidate Attachments
Title:
Candidate Attachments
Get job application details -
ProcessId: integer
Action returning a message indicating if the job application was created.
-
ProfileId: integer
Action returning a message indicating if the job application was created.
-
ProspectTypeCode: string
Action returning a message indicating if the job application was created.
-
RequisitionId: integer
Action returning a message indicating if the job application was created.
-
RequisitionNumber: string
Action returning a message indicating if the job application was created.
-
RequisitionTitle: string
Action returning a message indicating if the job application was created.
-
SubmissionConfirmedDate: string
(date)
Action returning a message indicating if the job application was created.
-
SubmissionDate: string
(date)
Action returning a message indicating if the job application was created.
-
SubmissionId: integer
Unique identifier of the job application.
-
SystemPersonType: string
Action returning a message indicating if the job application was created.
-
SystemPersonTypeName: string
Action returning a message indicating if the job application was created.
-
Total: number
Action returning a message indicating if the job application was created.
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
Show Source
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
Show Source
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
Get job application details
Show Source
Nested Schema : recruitingUIJobApplications-Attachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment.
Nested Schema : recruitingUIJobApplications-InternalAttachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment.
Nested Schema : recruitingUIJobApplications-PreferredLocations-item-post-request
Type:
Show Source
object
-
LocationId: integer
(int64)
Create a proxy job application
-
LocationName: string
Create a proxy job application
-
LocationType: string
Maximum Length:
1
Create a proxy job application -
SubmissionId: integer
(int64)
Create a proxy job application
Response
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 : recruitingUIJobApplications-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Read Only:
true
Action returning a message indicating if the job application was created. -
ActiveOnAnotherRequisitionFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
AgentFirstName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
AgentLastName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
AttachmentEntityName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
Attachments: array
Candidate Attachments
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. -
AverageFeedbackRating: number
Action returning a message indicating if the job application was created.
-
AverageRating: number
Action returning a message indicating if the job application was created.
-
CandidateNumber: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
ConfirmedFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
CreationDate: string
(date-time)
Action returning a message indicating if the job application was created.
-
CurrentPhaseId: integer
Read Only:
true
Action returning a message indicating if the job application was created. -
CurrentPhaseName: string
Action returning a message indicating if the job application was created.
-
CurrentStateId: integer
Read Only:
true
Action returning a message indicating if the job application was created. -
CurrentStateName: string
Action returning a message indicating if the job application was created.
-
DisqualifiedFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
EmployeeDisplayName: string
Maximum Length:
255
Action returning a message indicating if the job application was created. -
EmployerName: string
Read Only:
true
Maximum Length:255
Action returning a message indicating if the job application was created. -
EndingPosition: string
Read Only:
true
Maximum Length:255
Action returning a message indicating if the job application was created. -
FeedbackRatingCount: integer
Action returning a message indicating if the job application was created.
-
FlowVersionId: integer
Action returning a message indicating if the job application was created.
-
InteractionType: string
Read Only:
true
Maximum Length:255
Action returning a message indicating if the job application was created. -
InternalAttachments: array
Candidate Attachments
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. -
InternalFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
isReferredByAgentFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
isReferredByEmployeeFlag: boolean
Maximum Length:
255
Action returning a message indicating if the job application was created. -
LastContacted: integer
Action returning a message indicating if the job application was created.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferId: integer
Read Only:
true
Action returning a message indicating if the job application was created. -
PersonId: integer
Action returning a message indicating if the job application was created.
-
PreferredLocations: array
Candidate Attachments
Title:
Candidate Attachments
Get job application details -
ProcessId: integer
Action returning a message indicating if the job application was created.
-
ProfileId: integer
Action returning a message indicating if the job application was created.
-
ProspectId: integer
Read Only:
true
Action returning a message indicating if the job application was created. -
ProspectTypeCode: string
Action returning a message indicating if the job application was created.
-
QstnrScore: number
Read Only:
true
Action returning a message indicating if the job application was created. -
ReferralId: integer
Read Only:
true
Action returning a message indicating if the job application was created. -
ReferralResumeDatatypeCode: string
Read Only:
true
Maximum Length:255
Value that indicates data type code of attachment. -
ReferralResumeFileName: string
Read Only:
true
Maximum Length:255
File name of the attachment. -
ReferralResumePreviewURL: string
Read Only:
true
Maximum Length:255
URL of the attachment. -
RequisitionId: integer
Action returning a message indicating if the job application was created.
-
RequisitionNumber: string
Action returning a message indicating if the job application was created.
-
RequisitionTitle: string
Action returning a message indicating if the job application was created.
-
StartingPosition: string
Read Only:
true
Maximum Length:255
Action returning a message indicating if the job application was created. -
SubmissionConfirmedDate: string
(date)
Action returning a message indicating if the job application was created.
-
SubmissionDate: string
(date)
Action returning a message indicating if the job application was created.
-
SubmissionId: integer
Unique identifier of the job application.
-
SystemPersonType: string
Action returning a message indicating if the job application was created.
-
SystemPersonTypeName: string
Action returning a message indicating if the job application was created.
-
Total: number
Action returning a message indicating if the job application was created.
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
Show Source
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
Get job application details
Show Source
Nested Schema : recruitingUIJobApplications-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DocumentPreviewURL: string
Read Only:
true
Maximum Length:255
Attachment context. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name associated with the attachment.
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.
Nested Schema : recruitingUIJobApplications-InternalAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DocumentPreviewURL: string
Read Only:
true
Maximum Length:255
Attachment context. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIJobApplications-PreferredLocations-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Create a proxy job application
-
LocationName: string
Create a proxy job application
-
LocationType: string
Maximum Length:
1
Create a proxy job application -
PreferredLocationId: integer
(int64)
Read Only:
true
Create a proxy job application -
SubmissionId: integer
(int64)
Create a proxy job application
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/AttachmentsParameters:
- SubmissionId:
$request.path.SubmissionId
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. - SubmissionId:
- InternalAttachments
-
Parameters:
- SubmissionId:
$request.path.SubmissionId
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. - SubmissionId:
- PreferredLocations
-
Parameters:
- SubmissionId:
$request.path.SubmissionId
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate. - SubmissionId: