August 2022 Release Changelog

Stay up to date with all Eightfold API releases in August!

17 -August -2022

New API introduced in V2

New. A new endpoint Organization Info has been added to Eightfold’ s API list. We have added an endpoint Organization Info to capture pipeline diversity data of the organization. This records gender diversity, ethnic diversity, pipelines with leaders, pipelines with women, pipelines with diverse ethnicity, superstar, and roles with successors ready in the form of percentage.

Feature Details

Refer to the table below for the schemas:

Sr NoEndpoint /SchemaChangePrevious ValueNew value
1BinaryDistributionNew SchemaNA"BinaryDistribution": {
"type": "object",
"properties": {
"yesCount": {
"type": "integer",
"format": "int32",
"readOnly": true,
"nullable": true,
"description": "True/Positive value of metric"
},
"noCount": {
"type": "integer",
"format": "int32",
"readOnly": true,
"nullable": true,
"description": "False/Negative value of metric"
}
}
},
2OrganizationInfoSchemaNew SchemaNASr. No.
Endpoint / Schema
Change
Previous Value
New Value
1
BinaryDistribution
New Schema
NA
"BinaryDistribution": {
"type": "object",
"properties": {
"yesCount": {
"type": "integer",
"format": "int32",
"readOnly": true,
"nullable": true,
"description": "True/Positive value of metric"
},
"noCount": {
"type": "integer",
"format": "int32",
"readOnly": true,
"nullable": true,
"description": "False/Negative value of metric"
}
}
},
2
OrganizationInfoSchema
New Schema
NA
"OrganizationInfoSchema": {
"type": "object",
"properties": {
"pipelinesWithLeaders": {
"readOnly": true,
"nullable": true,
"description": "Metrics of Pipeline with leaders",
"allOf": [
{
"$ref": "#/components/schemas/BinaryDistribution"
}
]
},
"pipelinesWithWomen": {
"readOnly": true,
"nullable": true,
"description": "Metrics of Pipeline with women",
"allOf": [
{
"$ref": "#/components/schemas/BinaryDistribution"
}
]
},
"superstar": {
"readOnly": true,
"nullable": true,
"description": "Metrics of superstars",
"allOf": [
{
"$ref": "#/components/schemas/BinaryDistribution"
}
]
},
"pipelinesWithDiverseEthnicity": {
"readOnly": true,
"nullable": true,
"description": "Metrics of Pipeline with diverse ethnicity",
"allOf": [
{
"$ref": "#/components/schemas/BinaryDistribution"
}
]
},
"rolesWithSuccessorsReady": {
"readOnly": true,
"nullable": true,
"description": "Metrics of roles ready with successors",
"allOf": [
{
"$ref": "#/components/schemas/BinaryDistribution"
}
]
}
}
},

Updated Profile API

Enhancement. Profile endpoint has been updated. The following schemas have been removed from the Profile API as they are no longer required:

ProfileFeedback > properties > application
ProfileFeedback > properties > candidateProfile
ProfileFeedback > properties > candidateProfileRequester
ProfileFeedback > properties > candidateProfileReviewer

Feature Details

Refer to the table below to understand the schema changes done on the endpoints:

Sr No.Endpoint/SchemaChangePrevious ValueNew Value
1ProfileFeedback >> properties >> applicationRemoved"application": {
"readOnly": true,
"nullable": true,
"description": "Application of the candidate",
"allOf": [
{
"$ref": "#/components/schemas/ProfileApplication"
}
]
},
NA
2ProfileFeedback >> properties >> candidateProfileRemoved"candidateProfile": {
"readOnly": true,
"nullable": true,
"description": "Non-masked candidate profile for the feedback",
"allOf": [
{
"$ref": "#/components/schemas/ProfileSchema"
}
]
},
NA
3ProfileFeedback >> properties >> candidateProfileRequesterRemoved"candidateProfileRequester": {
"readOnly": true,
"nullable": true,
"description": "Candidate profile for the feedback as visible to Feedback Requester (generally non-masked)",
"allOf": [
{
"$ref": "#/components/schemas/ProfileSchema"
}
]
},
NA
4ProfileFeedback >> properties >> candidateProfileReviewerRemoved"candidateProfileReviewer": {
"readOnly": true,
"nullable": true,
"description": "Candidate profile for the feedback as visible to Feedback Reviewer (generally masked)",
"allOf": [
{
"$ref": "#/components/schemas/ProfileSchema"
}
]
},
NA

4-August-2022

Updated ATS Candidate API

Enhancement. ATS Candidate endpoints have been updated. We updated the ATS Candidate endpoints to include minor data type changes. Multiple schemas have been updated for the APIs to be more comprehensive.

Feature details

Refer below table to understand the schema changes done on the endpoints:

📘

Note about the table below

Fields highlighted in bold are removed
Fields highlighted in italics are updated
Fields highlighted in bold italics are newly added

Sr. No.Endpoint/SchemaChangePrevious ValueNew Value
1.ATS CandidateData type change"items": {
"type": "string"
}
"items": {
"$ref": "#/components/schemas/Jobs"
}
2.ATS CandidateData type change"resumeContent": {
"type": "string",
"nullable": true,
"description": "Resume content for candidate. Valid input format as string: content, extension, is_base64"
}
"resumeContent": {
"nullable": true,
"description": "Resume content for candidate.",
"allOf": [
{
"$ref": "#/components/schemas/AtsContent"
}
]

}
3.ATS CandidateData type change"customInfo": {
"type": "array",
"nullable": true,
"description": "custom info of candidate",
"items": {
"type": "object"
}

}
"customInfo": {
"type": "object",
"nullable": true,
"description": "custom info of candidate"
}
4.ATS CandidateData type change"photoContent": {
"type": "string",
"nullable": true,
"description": "Photo content. Valid input format as string: content, extension, is_base64"
}
"photoContent": {
"nullable": true,
"description": "Photo content.",
"allOf": [
{
"$ref": "#/components/schemas/AtsContent"
}
]

}
5.ATS Candidate > Application SchemaData type change"jobs": {
"type": "array",
"nullable": true,
"description": "Jobs related to an application. Give input in the format: <job_id>, ",
"items": {
"type": "string"
}
}
"jobs": {
"nullable": true,
"description": "Jobs related to an application.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Jobs"
}
}
6.ATS CandidateNew schemaNA"Jobs": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true,
"description": "Name"
},
"atsJobId": {
"type": "string",
"nullable": true,
"description": "ATS Job id"
}
}
}