Jump to

• Request
• Response

Get one of my job application in opportunity marketplace

get

/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}

Request

Path Parameters

• SubmissionId(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: string
  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: string
  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

• 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 : recruitingMyJobApplications-item-response

Type: object

Show Source

• Action: string
  Title: Action List

  Action performed on the job application in opportunity marketplace.
• ActionResponseMessage: string
  Title: Action Response

  Response message for a job application in opportunity marketplace.
• ActiveFlag: boolean
  Title: Job Active Flag

  Indicates whether the job application is active in opportunity marketplace. Default value is 1.
• ConfirmedFlag: boolean
  Title: Job Confirmed Flag

  Indicates whether the job application is confirmed in opportunity marketplace. No default value.
• HiringManager: string
  Title: Hiring Manager

  Hiring manager in opportunity marketplace.
• HiringManagerPersonId: string
  Title: Hiring Manager ID

  Hiring manager person ID in opportunity marketplace.
• JobFunction: string
  Title: Job Function

  Maximum Length: 255

  Job function of the employee in Opportunity Marketplace.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferId: integer
  Title: Offer ID

  Job offer ID in opportunity marketplace.
• Organization: string
  Title: Organization Name

  Organization name in opportunity marketplace.
• OtherJobLocationCount: integer
  Title: Number of Locations

  Count of the other job locations in opportunity marketplace.
• PipelineRequisitionFlag: boolean
  Title: Pipeline Requisition Flag

  Indicates whether the job application is a pipeline job application. Default value in 0.
• PipelineSubmissionId: integer
  Title: Pipeline Job Submission ID

  Pipeline job application ID in opportunity marketplace.
• PreferredLanguage: string
  Title: Job Preferred Language

  Preferred language of the job application in opportunity marketplace.
• PrimaryJobLocation: string
  Title: Primary Job Location

  Primary job location in opportunity marketplace.
• PrimaryWorkLocation: string
  Title: Primary Work Location

  Maximum Length: 255

  Primary work location in Opportunity Marketplace.
• ProposedStartDateLabelFlag: boolean
  Title: Proposed Start Date

  Indicates whether the proposed start date is displayed in opportunity marketplace. No default value
• RemoteOpportunity: string
  Title: Remote Opportunity

  Maximum Length: 255

  Remote opportunity indicator in Opportunity Marketplace.
• RequisitionNumber: string
  Title: Requisition Number

  Job requisition number in opportunity marketplace.
• ShowJobActionFlag: boolean
  Title: Job Action Flag

  Indicates whether the view job details action is displayed in opportunity marketplace. Default value is 1.
• ShowOfferActionFlag: boolean
  Title: Offer Action Flag

  Indicates whether the view offer action is displayed in opportunity marketplace. Default value is 0.
• ShowWithdrawActionFlag: boolean
  Title: Withdraw Flag

  Indicates whether the withdraw job application action is displayed in opportunity marketplace. Default value is 1.
• StartDate: string (date)
  Title: Start Date

  Candidate start date in opportunity marketplace.
• Status: string
  Title: Application Status

  Maximum Length: 255

  Job application status in opportunity marketplace.
• SubmissionDate: string (date)
  Title: Application Date

  Job application submission date in opportunity marketplace.
• SubmissionId: integer
  Title: Job Application ID

  Job application ID in opportunity marketplace.
• SubmissionScheduledInterviews: array Scheduled Interviews
  Title: Scheduled Interviews

  The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.
• Title: string
  Title: Requisition Title

  Job title in opportunity marketplace.
• UnscheduledInterviewRequests: array Unscheduled Job Interviews
  Title: Unscheduled Job Interviews

  The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Action List",
            "type":"string",
            "description":"Action performed on the job application in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionResponseMessage":{
            "title":"Action Response",
            "type":"string",
            "description":"Response message for a job application in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Job Active Flag",
            "type":"boolean",
            "description":"Indicates whether the job application is active in opportunity marketplace. Default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmedFlag":{
            "title":"Job Confirmed Flag",
            "type":"boolean",
            "description":"Indicates whether the job application is confirmed in opportunity marketplace. No default value.",
            "nullable":true,
            "x-queryable":true
        },
        "HiringManager":{
            "title":"Hiring Manager",
            "type":"string",
            "description":"Hiring manager in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "HiringManagerPersonId":{
            "title":"Hiring Manager ID",
            "type":"string",
            "description":"Hiring manager person ID in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFunction":{
            "title":"Job Function",
            "maxLength":255,
            "type":"string",
            "description":"Job function of the employee in Opportunity Marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "OfferId":{
            "title":"Offer ID",
            "type":"integer",
            "description":"Job offer ID in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization Name",
            "type":"string",
            "description":"Organization name in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherJobLocationCount":{
            "title":"Number of Locations",
            "type":"integer",
            "description":"Count of the other job locations in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "PipelineRequisitionFlag":{
            "title":"Pipeline Requisition Flag",
            "type":"boolean",
            "description":"Indicates whether the job application is a pipeline job application. Default value in 0.",
            "nullable":true,
            "x-queryable":true
        },
        "PipelineSubmissionId":{
            "title":"Pipeline Job Submission ID",
            "type":"integer",
            "description":"Pipeline job application ID in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredLanguage":{
            "title":"Job Preferred Language",
            "type":"string",
            "description":"Preferred language of the job application in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryJobLocation":{
            "title":"Primary Job Location",
            "type":"string",
            "description":"Primary job location in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryWorkLocation":{
            "title":"Primary Work Location",
            "maxLength":255,
            "type":"string",
            "description":"Primary work location in Opportunity Marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "ProposedStartDateLabelFlag":{
            "title":"Proposed Start Date",
            "type":"boolean",
            "description":"Indicates whether the proposed start date is displayed in opportunity marketplace. No default value",
            "nullable":true,
            "x-queryable":true
        },
        "RemoteOpportunity":{
            "title":"Remote Opportunity",
            "maxLength":255,
            "type":"string",
            "description":"Remote opportunity indicator in Opportunity Marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "type":"string",
            "description":"Job requisition number in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowJobActionFlag":{
            "title":"Job Action Flag",
            "type":"boolean",
            "description":"Indicates whether the view job details action is displayed in opportunity marketplace. Default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowOfferActionFlag":{
            "title":"Offer Action Flag",
            "type":"boolean",
            "description":"Indicates whether the view offer action is displayed in opportunity marketplace. Default value is 0.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowWithdrawActionFlag":{
            "title":"Withdraw Flag",
            "type":"boolean",
            "description":"Indicates whether the withdraw job application action is displayed in opportunity marketplace. Default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Candidate start date in opportunity marketplace.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Application Status",
            "maxLength":255,
            "type":"string",
            "description":"Job application status in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionDate":{
            "title":"Application Date",
            "type":"string",
            "description":"Job application submission date in opportunity marketplace.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "title":"Job Application ID",
            "type":"integer",
            "description":"Job application ID in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionScheduledInterviews":{
            "title":"Scheduled Interviews",
            "type":"array",
            "description":"The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.",
            "items":{
                "$ref":"#/components/schemas/recruitingMyJobApplications-SubmissionScheduledInterviews-item-response"
            }
        },
        "Title":{
            "title":"Requisition Title",
            "type":"string",
            "description":"Job title in opportunity marketplace.",
            "nullable":true,
            "x-queryable":true
        },
        "UnscheduledInterviewRequests":{
            "title":"Unscheduled Job Interviews",
            "type":"array",
            "description":"The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.",
            "items":{
                "$ref":"#/components/schemas/recruitingMyJobApplications-UnscheduledInterviewRequests-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Scheduled Interviews

Type: array

Title: Scheduled Interviews

The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.

Show Source

• Array of: object recruitingMyJobApplications-SubmissionScheduledInterviews-item-response

{
    "title":"Scheduled Interviews",
    "type":"array",
    "description":"The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.",
    "items":{
        "$ref":"#/components/schemas/recruitingMyJobApplications-SubmissionScheduledInterviews-item-response"
    }
}

Nested Schema : Unscheduled Job Interviews

Type: array

Title: Unscheduled Job Interviews

The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.

Show Source

• Array of: object recruitingMyJobApplications-UnscheduledInterviewRequests-item-response

{
    "title":"Unscheduled Job Interviews",
    "type":"array",
    "description":"The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.",
    "items":{
        "$ref":"#/components/schemas/recruitingMyJobApplications-UnscheduledInterviewRequests-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 : recruitingMyJobApplications-SubmissionScheduledInterviews-item-response

Type: object

Show Source

• EndDate: string (date-time)
  Title: Interview End Date

  Read Only: true

  End date of the scheduled interview in opportunity marketplace.
• InterviewId: integer (int64)
  Title: Interview ID

  Interview ID in opportunity marketplace.
• IntrvwRequestsId: integer (int64)
  Title: Interview Request ID

  Interview request ID in opportunity marketplace.
• IsScheduled: string
  Title: Interview Scheduled

  Read Only: true

  Maximum Length: 1

  Interview scheduled in opportunity marketplace.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScheduleInterviewId: integer (int64)
  Title: Scheduled Interview ID

  Read Only: true

  Scheduled interview ID in opportunity marketplace.
• StartDate: string (date-time)
  Title: Interview Start Date

  Read Only: true

  Start date of the interview in opportunity marketplace.
• SubmissionId: integer (int64)
  Title: Interview Submission ID

  Job application ID for the scheduled interview in opportunity marketplace.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"Interview End Date",
            "type":"string",
            "description":"End date of the scheduled interview in opportunity marketplace.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InterviewId":{
            "title":"Interview ID",
            "type":"integer",
            "description":"Interview ID in opportunity marketplace.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntrvwRequestsId":{
            "title":"Interview Request ID",
            "type":"integer",
            "description":"Interview request ID in opportunity marketplace.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IsScheduled":{
            "title":"Interview Scheduled",
            "maxLength":1,
            "type":"string",
            "description":"Interview scheduled in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleInterviewId":{
            "title":"Scheduled Interview ID",
            "type":"integer",
            "description":"Scheduled interview ID in opportunity marketplace.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Interview Start Date",
            "type":"string",
            "description":"Start date of the interview in opportunity marketplace.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "title":"Interview Submission ID",
            "type":"integer",
            "description":"Job application ID for the scheduled interview in opportunity marketplace.",
            "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"
            }
        }
    }
}

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 : recruitingMyJobApplications-UnscheduledInterviewRequests-item-response

Type: object

Show Source

• InterviewId: integer (int64)
  Title: Interview ID

  Read Only: true

  ID assigned to each unscheduled interview.
• IntrvwRequestsId: integer (int64)
  Title: Interview Request ID

  Read Only: true

  ID assigned to each unscheduled interview request.
• IntrvwRschldCount: integer (int32)
  Title: Number of Interview Reschedules

  Read Only: true

  Count of rescheduled interviews.
• IsRschldRqsted: string
  Title: Reschedule Requested Flag

  Read Only: true

  Maximum Length: 1

  Indicates if a reschedule of the interview is requested.
• IsSchedulable: string
  Title: Can Schedule

  Read Only: true

  Maximum Length: 255

  Indicates if the unscheduled interview can be scheduled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScheduleId: integer (int64)
  Title: Interview Schedule ID

  Read Only: true

  Schedule ID assigned to each unscheduled interview request.
• SubmissionId: integer (int64)
  Title: Interview Submission ID

  Read Only: true

  Job application ID assigned to each unscheduled interview request.

{
    "type":"object",
    "properties":{
        "InterviewId":{
            "title":"Interview ID",
            "type":"integer",
            "description":"ID assigned to each unscheduled interview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntrvwRequestsId":{
            "title":"Interview Request ID",
            "type":"integer",
            "description":"ID assigned to each unscheduled interview request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntrvwRschldCount":{
            "title":"Number of Interview Reschedules",
            "type":"integer",
            "description":"Count of rescheduled interviews.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "IsRschldRqsted":{
            "title":"Reschedule Requested Flag",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a reschedule of the interview is requested.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSchedulable":{
            "title":"Can Schedule",
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the unscheduled interview can be scheduled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Interview Schedule ID",
            "type":"integer",
            "description":"Schedule ID assigned to each unscheduled interview request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmissionId":{
            "title":"Interview Submission ID",
            "type":"integer",
            "description":"Job application ID assigned to each unscheduled interview request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        }
    }
}

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

SubmissionScheduledInterviews

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews

Parameters:

• SubmissionId: $request.path.SubmissionId

The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.

UnscheduledInterviewRequests

Operation: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests

Parameters:

• SubmissionId: $request.path.SubmissionId

The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.

Back to Top