Jump to

• Request
• Response

Create a job application

post

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplicationLanguage: string
  Maximum Length: 255

  Application language of the job application.
• CandidateNumber: string
  Maximum Length: 255

  Candidate number in the job application.
• ConfirmedFlag: boolean
  Maximum Length: 255

  Indicates whether the job application is confirmed or not.
• FlowVersionId: integer
  Application flow version ID of the job application.
• preferredLocations: array Preferred Job Locations
  Title: Preferred Job Locations

  The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.
• questionnaireResponses: array Candidate Responses to Questions
  Title: Candidate Responses to Questions

  The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
• regulatoryResponses: array Regulatory Responses
  Title: Regulatory Responses

  The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• RequisitionNumber: string
  Maximum Length: 255

  Requisition number of the job application.
• Status: string
  Status of the job application.
• SubmissionDate: string (date-time)
  Job application date.
• SubmissionId: integer
  Submission ID of the job application.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status of the job application.",
            "nullable":true
        },
        "questionnaireResponses":{
            "title":"Candidate Responses to Questions",
            "type":"array",
            "description":"The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteJobApplications-questionnaireResponses-item-post-request"
            }
        },
        "regulatoryResponses":{
            "title":"Regulatory Responses",
            "type":"array",
            "description":"The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteJobApplications-regulatoryResponses-item-post-request"
            }
        },
        "CandidateNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Candidate number in the job application.",
            "nullable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"Application flow version ID of the job application.",
            "nullable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID of the job application.",
            "nullable":true
        },
        "ApplicationLanguage":{
            "maxLength":255,
            "type":"string",
            "description":"Application language of the job application.",
            "nullable":true
        },
        "preferredLocations":{
            "title":"Preferred Job Locations",
            "type":"array",
            "description":"The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteJobApplications-preferredLocations-item-post-request"
            }
        },
        "SubmissionDate":{
            "type":"string",
            "description":"Job application date.",
            "format":"date-time",
            "nullable":true
        },
        "RequisitionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Requisition number of the job application.",
            "nullable":true
        },
        "ConfirmedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the job application is confirmed or not.",
            "nullable":true
        }
    }
}

Nested Schema : Preferred Job Locations

Type: array

Title: Preferred Job Locations

The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingJobSiteJobApplications-preferredLocations-item-post-request

{
    "title":"Preferred Job Locations",
    "type":"array",
    "description":"The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteJobApplications-preferredLocations-item-post-request"
    }
}

Nested Schema : Candidate Responses to Questions

Type: array

Title: Candidate Responses to Questions

The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.

Show Source

• Array of: object recruitingJobSiteJobApplications-questionnaireResponses-item-post-request

{
    "title":"Candidate Responses to Questions",
    "type":"array",
    "description":"The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteJobApplications-questionnaireResponses-item-post-request"
    }
}

Nested Schema : Regulatory Responses

Type: array

Title: Regulatory Responses

The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

• Array of: object schema

{
    "title":"Regulatory Responses",
    "type":"array",
    "description":"The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteJobApplications-regulatoryResponses-item-post-request"
    }
}

Nested Schema : recruitingJobSiteJobApplications-preferredLocations-item-post-request

Type: object

Show Source

• JaPreferredLocationId: integer (int64)
  ID assigned to the preferred location mentioned in the job application.
• LocationId: integer (int64)
  ID assigned to the preferred location.
• LocationType: string
  Maximum Length: 1

  Type of preferred location.
• SubmissionId: integer (int64)
  ID assigned to each submission of the preferred location.

{
    "type":"object",
    "properties":{
        "SubmissionId":{
            "type":"integer",
            "description":"ID assigned to each submission of the preferred location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"ID assigned to the preferred location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "JaPreferredLocationId":{
            "type":"integer",
            "description":"ID assigned to the preferred location mentioned in the job application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationType":{
            "maxLength":1,
            "type":"string",
            "description":"Type of preferred location.",
            "nullable":false
        }
    }
}

Nested Schema : recruitingJobSiteJobApplications-questionnaireResponses-item-post-request

Type: object

Show Source

• QstnrVersionNumber: integer
  Version number of the questionnaire for which the responses are provided.
• QuestionnaireId: integer
  ID of the questionnaire for which the responses are provided
• QuestionResponses: string
  Responses provided by the candidate for the questionnaire.
• Type: string
  Type of the questionnaire for which the responses are provided.

{
    "type":"object",
    "properties":{
        "QuestionnaireId":{
            "type":"integer",
            "description":"ID of the questionnaire for which the responses are provided",
            "nullable":true
        },
        "QstnrVersionNumber":{
            "type":"integer",
            "description":"Version number of the questionnaire for which the responses are provided.",
            "nullable":true
        },
        "QuestionResponses":{
            "type":"string",
            "description":"Responses provided by the candidate for the questionnaire.",
            "nullable":true
        },
        "Type":{
            "type":"string",
            "description":"Type of the questionnaire for which the responses are provided.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• RegulatoryResponses: string
  Regulatory responses of the job application.
• RequisitionNumber: string
  Maximum Length: 255

  Requisition number of the job application.

{
    "type":"object",
    "properties":{
        "RegulatoryResponses":{
            "type":"string",
            "description":"Regulatory responses of the job application.",
            "nullable":true
        },
        "RequisitionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Requisition number of the job application.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : recruitingJobSiteJobApplications-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Read Only: true

  Indicates whether the job application is active or not.
• ApplicationLanguage: string
  Maximum Length: 255

  Application language of the job application.
• CandidateNumber: string
  Maximum Length: 255

  Candidate number in the job application.
• ConfirmedFlag: boolean
  Maximum Length: 255

  Indicates whether the job application is confirmed or not.
• CurrentPhase: string
  Read Only: true

  Current phase of the job application.
• CurrentState: string
  Read Only: true

  Current state of the job application.
• FlowVersionId: integer
  Application flow version ID of the job application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PipelineRequisitionFlag: boolean
  Read Only: true

  Pipeline requisition attribute of the job application.
• PipelineSubmissionId: integer
  Read Only: true

  Pipeline job application ID of the job application.
• preferredLocations: array Preferred Job Locations
  Title: Preferred Job Locations

  The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.
• questionnaireResponses: array Candidate Responses to Questions
  Title: Candidate Responses to Questions

  The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
• regulatoryResponses: array Regulatory Responses
  Title: Regulatory Responses

  The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• RequisitionNumber: string
  Maximum Length: 255

  Requisition number of the job application.
• Status: string
  Status of the job application.
• SubmissionDate: string (date-time)
  Job application date.
• SubmissionId: integer
  Submission ID of the job application.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status of the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "regulatoryResponses":{
            "title":"Regulatory Responses",
            "type":"array",
            "description":"The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteJobApplications-regulatoryResponses-item-response"
            }
        },
        "CurrentPhase":{
            "type":"string",
            "description":"Current phase of the job application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Candidate number in the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"Application flow version ID of the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionDate":{
            "type":"string",
            "description":"Job application date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the job application is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Requisition number of the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "questionnaireResponses":{
            "title":"Candidate Responses to Questions",
            "type":"array",
            "description":"The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteJobApplications-questionnaireResponses-item-response"
            }
        },
        "CurrentState":{
            "type":"string",
            "description":"Current state of the job application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID of the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplicationLanguage":{
            "maxLength":255,
            "type":"string",
            "description":"Application language of the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "PipelineSubmissionId":{
            "type":"integer",
            "description":"Pipeline job application ID of the job application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "preferredLocations":{
            "title":"Preferred Job Locations",
            "type":"array",
            "description":"The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteJobApplications-preferredLocations-item-response"
            }
        },
        "PipelineRequisitionFlag":{
            "type":"boolean",
            "description":"Pipeline requisition attribute of the job application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfirmedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the job application is confirmed or not.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Preferred Job Locations

Type: array

Title: Preferred Job Locations

The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingJobSiteJobApplications-preferredLocations-item-response

{
    "title":"Preferred Job Locations",
    "type":"array",
    "description":"The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteJobApplications-preferredLocations-item-response"
    }
}

Nested Schema : Candidate Responses to Questions

Type: array

Title: Candidate Responses to Questions

The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.

Show Source

• Array of: object recruitingJobSiteJobApplications-questionnaireResponses-item-response

{
    "title":"Candidate Responses to Questions",
    "type":"array",
    "description":"The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteJobApplications-questionnaireResponses-item-response"
    }
}

Nested Schema : Regulatory Responses

Type: array

Title: Regulatory Responses

The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

• Array of: object recruitingJobSiteJobApplications-regulatoryResponses-item-response

{
    "title":"Regulatory Responses",
    "type":"array",
    "description":"The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteJobApplications-regulatoryResponses-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingJobSiteJobApplications-preferredLocations-item-response

Type: object

Show Source

• JaPreferredLocationId: integer (int64)
  ID assigned to the preferred location mentioned in the job application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  ID assigned to the preferred location.
• LocationType: string
  Maximum Length: 1

  Type of preferred location.
• SubmissionId: integer (int64)
  ID assigned to each submission of the preferred location.

{
    "type":"object",
    "properties":{
        "SubmissionId":{
            "type":"integer",
            "description":"ID assigned to each submission of the preferred location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"ID assigned to the preferred location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JaPreferredLocationId":{
            "type":"integer",
            "description":"ID assigned to the preferred location mentioned in the job application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LocationType":{
            "maxLength":1,
            "type":"string",
            "description":"Type of preferred location.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingJobSiteJobApplications-questionnaireResponses-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QstnrVersionNumber: integer
  Version number of the questionnaire for which the responses are provided.
• QuestionnaireId: integer
  ID of the questionnaire for which the responses are provided
• QuestionResponses: string
  Responses provided by the candidate for the questionnaire.
• Type: string
  Type of the questionnaire for which the responses are provided.

{
    "type":"object",
    "properties":{
        "QuestionnaireId":{
            "type":"integer",
            "description":"ID of the questionnaire for which the responses are provided",
            "nullable":true,
            "x-queryable":true
        },
        "QstnrVersionNumber":{
            "type":"integer",
            "description":"Version number of the questionnaire for which the responses are provided.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionResponses":{
            "type":"string",
            "description":"Responses provided by the candidate for the questionnaire.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Type":{
            "type":"string",
            "description":"Type of the questionnaire for which the responses are provided.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingJobSiteJobApplications-regulatoryResponses-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RegulatoryResponses: string
  Regulatory responses of the job application.
• RequisitionNumber: string
  Maximum Length: 255

  Requisition number of the job application.

{
    "type":"object",
    "properties":{
        "RegulatoryResponses":{
            "type":"string",
            "description":"Regulatory responses of the job application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Requisition number of the job application.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

preferredLocations

Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/preferredLocations

Parameters:

• recruitingJobSiteJobApplicationsUniqID: $request.path.recruitingJobSiteJobApplicationsUniqID

The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.

questionnaireResponses

Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/questionnaireResponses

Parameters:

• recruitingJobSiteJobApplicationsUniqID: $request.path.recruitingJobSiteJobApplicationsUniqID

The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.

regulatoryResponses

Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/regulatoryResponses

Parameters:

• recruitingJobSiteJobApplicationsUniqID: $request.path.recruitingJobSiteJobApplicationsUniqID

The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Back to Top