REST Resource: projects.tenants.profiles.applications

Resource: Application

Resource that represents a job application record of a candidate.

JSON representation
{
  "name": string,
  "externalId": string,
  "profile": string,
  "job": string,
  "company": string,
  "applicationDate": {
    object (Date)
  },
  "stage": enum (ApplicationStage),
  "state": enum (ApplicationState),
  "interviews": [
    {
      object (Interview)
    }
  ],
  "referral": boolean,
  "createTime": string,
  "updateTime": string,
  "outcomeNotes": string,
  "outcome": enum (Outcome),
  "isMatch": boolean,
  "jobTitleSnippet": string
}
Fields
name

string

Required during application update.

Resource name assigned to an application by the API.

The format is "projects/{project_id}/tenants/{tenantId}/profiles/{profile_id}/applications/{application_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar/applications/baz".

externalId

string

Required. Client side application identifier, used to uniquely identify the application.

The maximum number of allowed characters is 255.

profile

string

Output only. Resource name of the candidate of this application.

The format is "projects/{project_id}/tenants/{tenantId}/profiles/{profile_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar".

job

string

One of either a job or a company is required.

Resource name of the job which the candidate applied for.

The format is "projects/{project_id}/tenants/{tenantId}/jobs/{job_id}", for example, "projects/api-test-project/tenants/foo/jobs/bar".

company

string

One of either a job or a company is required.

Resource name of the company which the candidate applied for.

The format is "projects/{project_id}/tenants/{tenantId}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar".

applicationDate

object (Date)

Optional. The application date.

stage

enum (ApplicationStage)

Required. What is the most recent stage of the application (that is, new, screen, send cv, hired, finished work)? This field is intentionally not comprehensive of every possible status, but instead, represents statuses that would be used to indicate to the ML models good / bad matches.

state

enum (ApplicationState)

Optional. The application state.

interviews[]

object (Interview)

Optional. All interviews (screen, onsite, and so on) conducted as part of this application (includes details such as user conducting the interview, timestamp, feedback, and so on).

referral

boolean

Optional. If the candidate is referred by a employee.

createTime

string (Timestamp format)

Required. Reflects the time that the application was created.

updateTime

string (Timestamp format)

Optional. The last update timestamp.

outcomeNotes

string

Optional. Free text reason behind the recruitement outcome (for example, reason for withdraw / reject, reason for an unsuccessful finish, and so on).

Number of characters allowed is 100.

outcome

enum (Outcome)

Optional. Outcome positiveness shows how positive the outcome is.

isMatch

boolean

Output only. Indicates whether this job application is a match to application related filters. This value is only applicable in profile search response.

jobTitleSnippet

string

Output only. Job title snippet shows how the job title is related to a search query. It's empty if the job title isn't related to the search query.

ApplicationStage

The stage of the application.

Enums
APPLICATION_STAGE_UNSPECIFIED Default value.
NEW Candidate has applied or a recruiter put candidate into consideration but candidate is not yet screened / no decision has been made to move or not move the candidate to the next stage.
SCREEN A recruiter decided to screen the candidate for this role.
HIRING_MANAGER_REVIEW Candidate is being / was sent to the customer / hiring manager for detailed review.
INTERVIEW Candidate was approved by the client / hiring manager and is being / was interviewed for the role.
OFFER_EXTENDED Candidate will be / has been given an offer of employment.
OFFER_ACCEPTED Candidate has accepted their offer of employment.
STARTED Candidate has begun (or completed) their employment or assignment with the employer.

ApplicationState

Enum that represents the application status.

Enums
APPLICATION_STATE_UNSPECIFIED Default value.
IN_PROGRESS The current stage is in progress or pending, for example, interviews in progress.
CANDIDATE_WITHDREW The current stage was terminated by a candidate decision.
EMPLOYER_WITHDREW The current stage was terminated by an employer or agency decision.
COMPLETED The current stage is successfully completed, but the next stage (if applicable) has not begun.
CLOSED The current stage was closed without an exception, or terminated for reasons unrealated to the candidate.

Interview

Details of an interview.

JSON representation
{
  "rating": {
    object (Rating)
  },
  "outcome": enum (Outcome)
}
Fields
rating

object (Rating)

Optional. The rating on this interview.

outcome

enum (Outcome)

Required. The overall decision resulting from this interview (positive, negative, nuetral).

Rating

The details of the score received for an assessment or interview.

JSON representation
{
  "overall": number,
  "min": number,
  "max": number,
  "interval": number
}
Fields
overall

number

Overall score.

min

number

The minimum value for the score.

max

number

The maximum value for the score.

interval

number

The steps within the score (for example, interval = 1 max = 5 min = 1 indicates that the score can be 1, 2, 3, 4, or 5)

Outcome

The overall outcome /decision / result indicator.

Enums
OUTCOME_UNSPECIFIED Default value.
POSITIVE A positive outcome / passing indicator (for example, candidate was recommended for hiring or to be moved forward in the hiring process, candidate passed a test).
NEUTRAL A neutral outcome / no clear indicator (for example, no strong reccommendation either to move forward / not move forward, neutral score).
NEGATIVE A negative outcome / failing indicator (for example, candidate was recommended to NOT move forward in the hiring process, failed a test).
OUTCOME_NOT_AVAILABLE The assessment outcome is not available or otherwise unknown (for example, candidate did not complete assessment).

Methods

create

Creates a new application entity.

delete

Deletes specified application.

get

Retrieves specified application.

list

Lists all applications associated with the profile.

patch

Updates specified application.
Czy ta strona była pomocna? Podziel się z nami swoją opinią:

Wyślij opinię na temat...

Job search documentation
Potrzebujesz pomocy? Odwiedź naszą stronę wsparcia.