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 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 Sr. 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/Schema Change Previous Value New Value
1 ProfileFeedback >> properties >> application Removed "application": {\ "readOnly": true,\ "nullable": true,\ "description": "Application of the candidate",\ "allOf": [ { "$ref": `#/components/schemas/ProfileApplication` } ]\ }, NA
2 ProfileFeedback >> properties >> candidateProfile Removed "candidateProfile": {\ "readOnly": true,\ "nullable": true,\ "description": "Non-masked candidate profile for the feedback",\ "allOf": [ { "$ref": `#/components/schemas/ProfileSchema` } ]\ }, NA
3 ProfileFeedback >> properties >> candidateProfileRequester Removed "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
4 ProfileFeedback >> properties >> candidateProfileReviewer Removed "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/Schema Change Previous Value New Value
1. ATS Candidate Data type change "items": {\ **"type": "string"**\ } "items": {\ ***"$ref": `#/components/schemas/Jobs`***\ }
2. ATS Candidate Data 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 Candidate Data 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 Candidate Data 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 Schema Data type change "jobs": { _*"type": "array"**,_ "nullable": true,\ "description": "Jobs related to an application. **Give input in the format: <job\_id>, <name>"**_\ "items": { **"type": "string"**_\ }\ } "jobs": {\ "nullable": true,\ "description": "Jobs related to an application.", _**"type": "array"**_,\ "items": {\ ***"$ref": `#/components/schemas/Jobs`***\ }\ }
6. ATS Candidate New schema NA _**"Jobs": {\ "type": "object",\ "properties": {\ "name": {\ "type": "string",\ "nullable": true,\ "description": "Name"\ },\ "atsJobId": {\ "type": "string",\ "nullable": true,\ "description": "ATS Job id"\ }\ }\ }**_*