The Talent Management public service contains resources that expose Workday Talent Management Business Services data. This service can be used for integration with other talent management systems.
Operations
GET /talentManagement/v2/successionPlans
Get succession plans.
Returns succession plans viewable by authenticated user.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlans"
],
"summary": "Get succession plans.",
"description": "Returns succession plans viewable by authenticated user.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "position",
"in": "query",
"description": "Postion Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/successionPlanDetails_7e3bb9fc9368100020f4312542580000"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "7e3bb9fc9368100020e63f4bc4f60000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
POST /talentManagement/v2/successionPlans
<b>Secured By Domain:</b> Search: Find Succession Plans, Set Up: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlans"
],
"description": "\n\n<b>Secured By Domain:</b> Search: Find Succession Plans, Set Up: Succession\n\n<b>Scope:</b> Talent Pipeline",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanDetails_7e3bb9fc9368100020f4312542580000"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanDetails_7e3bb9fc9368100020f4312542580000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A161 | Specify a valid Position ID. The position you specified has an active succession plan. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "6e24a91f47cf10001cb5fd1f934d0000",
"x-workday-secured-by-domains": [
"Search: Find Succession Plans",
"Set Up: Succession"
]
}
GET /talentManagement/v2/successionPlans/{ID}
Get succession plans
Returns succession plan for the given succession plan ID viewable by authenticated user.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlans"
],
"summary": "Get succession plans",
"description": "Returns succession plan for the given succession plan ID viewable by authenticated user.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanDetails_7e3bb9fc9368100020f4312542580000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "7e3bb9fc9368100020e63f4bc4f60000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
GET /talentManagement/v2/mentorships
Get all mentorships
Returns mentorships viewable by authenticated user.
<b>Secured By Domain:</b> Self-Service: Mentoring, Worker Data: Mentoring
<b>Scope:</b> Career and Development Planning, Worker Profile and Skills
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"mentorships"
],
"summary": "Get all mentorships",
"description": "Returns mentorships viewable by authenticated user.\n\n<b>Secured By Domain:</b> Self-Service: Mentoring, Worker Data: Mentoring\n\n<b>Scope:</b> Career and Development Planning, Worker Profile and Skills",
"parameters": [
{
"name": "closeMentorshipReason",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "closed",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "inProgress",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "mentee",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "mentor",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "mentorType",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mentorshipDetail_ff0d12e68ab310001383c6eeeee0001d"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "true",
"x-workday-operation-id": "96e7ee2167ea1000074ac1d67d180828",
"x-workday-secured-by-domains": [
"Self-Service: Mentoring",
"Worker Data: Mentoring"
]
}
POST /talentManagement/v2/mentorships/{ID}/close
Closes the mentorship.
Functional Description
---
The Close Mentorship endpoint will be used to Close mentorships.
Example Use Cases
---
ESS: Worker or Mentor wants to close the mentorship.
Additional Information
---
* Security for ESS and MSS follows the security policy of the Manage Mentorship business process policy.
** Close \~Mentorship\~ with
* If the business policy for Manage \~Mentorship\~ has an approval step, then the mentorship will not be closed until the mentorship event is approved.
<b>Secured By Business Process Type:</b> Manage Mentorship
<b>Scope:</b> Career and Development Planning, Worker Profile and Skills
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"mentorships"
],
"summary": "Closes the mentorship.",
"description": "Functional Description\n---\nThe Close Mentorship endpoint will be used to Close mentorships.\n\nExample Use Cases\n---\nESS: Worker or Mentor wants to close the mentorship.\n\nAdditional Information\n---\n* Security for ESS and MSS follows the security policy of the Manage Mentorship business process policy.\n** Close \\~Mentorship\\~ with\n* If the business policy for Manage \\~Mentorship\\~ has an approval step, then the mentorship will not be closed until the mentorship event is approved.\n\n<b>Secured By Business Process Type:</b> Manage Mentorship\n\n<b>Scope:</b> Career and Development Planning, Worker Profile and Skills",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/closeMentorshipInput_96e7ee2167ea10001dd469373766088b"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/closeMentorshipInput_96e7ee2167ea10001dd469373766088b"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A119 | End Date can't be before the Start Date. |\n| Critical | A974 | You cannot edit this \\~mentorship\\~ again since your previous \\~mentorship\\~ edit has not been approved. |\n| Critical | A978 | You can't close a closed \\~mentorship\\~. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "96e7ee2167ea10001dd51060069e088f",
"x-workday-secured-by-business-process-types": [
"Manage Mentorship"
]
}
GET /talentManagement/v2/mentorships/{ID}
Get all mentorships
Returns mentorships viewable by authenticated user.
<b>Secured By Domain:</b> Self-Service: Mentoring, Worker Data: Mentoring
<b>Scope:</b> Career and Development Planning, Worker Profile and Skills
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"mentorships"
],
"summary": "Get all mentorships",
"description": "Returns mentorships viewable by authenticated user.\n\n<b>Secured By Domain:</b> Self-Service: Mentoring, Worker Data: Mentoring\n\n<b>Scope:</b> Career and Development Planning, Worker Profile and Skills",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/mentorshipDetail_ff0d12e68ab310001383c6eeeee0001d"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "true",
"x-workday-operation-id": "96e7ee2167ea1000074ac1d67d180828",
"x-workday-secured-by-domains": [
"Self-Service: Mentoring",
"Worker Data: Mentoring"
]
}
POST /talentManagement/v2/mentorships/{ID}/edit
Edit the mentorship.
Functional Description
---
The Edit Mentorship endpoint will be used to Edit the mentorships.
Example Use Cases
---
ESS: Worker or Mentor wants to edit the mentorship to update additional informations.
Additional Information
---
* Security for ESS and MSS follows the security policy of the Manage Mentorship business process policy.
Edit \~Mentorship\~ with
* If the business policy for Manage \~Mentorship\~ has an approval step, then the mentorship will not be updated until the mentorship event is approved.
<b>Secured By Business Process Type:</b> Manage Mentorship
<b>Scope:</b> Career and Development Planning, Worker Profile and Skills
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"mentorships"
],
"summary": "Edit the mentorship.",
"description": "Functional Description\n---\nThe Edit Mentorship endpoint will be used to Edit the mentorships.\n\nExample Use Cases\n---\nESS: Worker or Mentor wants to edit the mentorship to update additional informations.\n\nAdditional Information\n---\n* Security for ESS and MSS follows the security policy of the Manage Mentorship business process policy.\nEdit \\~Mentorship\\~ with\n* If the business policy for Manage \\~Mentorship\\~ has an approval step, then the mentorship will not be updated until the mentorship event is approved.\n\n<b>Secured By Business Process Type:</b> Manage Mentorship\n\n<b>Scope:</b> Career and Development Planning, Worker Profile and Skills",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/editMentorshipInput_d8a7d527cba210002b7fb16a7a42082a"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/editMentorshipInput_d8a7d527cba210002b7fb16a7a42082a"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A119 | End Date can't be before the Start Date. |\n| Critical | A974 | You cannot edit this \\~mentorship\\~ again since your previous \\~mentorship\\~ edit has not been approved. |\n| Critical | A977 | You can't edit a closed \\~mentorship\\~. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "d8a7d527cba210002bf03817fa8d0834",
"x-workday-secured-by-business-process-types": [
"Manage Mentorship"
]
}
POST /talentManagement/v2/createMentorshipForWorker
Creates a mentorship between two workers.
Functional Description
---
The Create Mentorship For Worker endpoint is used to create new mentorships for between two workers.
Example Use Cases
---
A manager can create a mentorship for their direct report, and have the ability to choose a mentor, mentor type, and provide a purpose.
An Admin can create a mentorship between a worker and a mentor.
Additional Information
---
The security follows the security policy of the Manage Mentorship business process.
The mentee, mentor, mentor type, purpose, and comment are specified in the body of the request.
If the business definition for Manage \~Mentorship\~ has an approval step, then the mentorship is not created until the mentorship event is approved in Workday.
<b>Secured By Business Process Type:</b> Manage Mentorship
<b>Scope:</b> Career and Development Planning, Worker Profile and Skills
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"createMentorshipForWorker"
],
"summary": "Creates a mentorship between two workers.",
"description": "Functional Description\n---\nThe Create Mentorship For Worker endpoint is used to create new mentorships for between two workers.\n\nExample Use Cases\n---\nA manager can create a mentorship for their direct report, and have the ability to choose a mentor, mentor type, and provide a purpose.\nAn Admin can create a mentorship between a worker and a mentor.\n\nAdditional Information\n---\nThe security follows the security policy of the Manage Mentorship business process.\nThe mentee, mentor, mentor type, purpose, and comment are specified in the body of the request.\nIf the business definition for Manage \\~Mentorship\\~ has an approval step, then the mentorship is not created until the mentorship event is approved in Workday.\n\n<b>Secured By Business Process Type:</b> Manage Mentorship\n\n<b>Scope:</b> Career and Development Planning, Worker Profile and Skills",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createMentorshipForWorkerInput_9250dd1b917610001f4b181b79d90320"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createMentorshipForWorkerInput_9250dd1b917610001f4b181b79d90320"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A119 | End Date can't be before the Start Date. |\n| Critical | A971 | This worker is terminated. Select another worker. |\n| Critical | A972 | An active \\~mentorship\\~ for this \\~mentor\\~ type already exists. |\n| Critical | A973 | You can't create a \\~mentorship\\~ when there is an event in progress with the same \\~mentor\\~ and \\~mentor\\~ type. |\n| Critical | A975 | This worker is not available to mentor. Select another worker. |\n| Critical | A976 | You can't select yourself as a \\~mentee\\~. |\n| Critical | A979 | Enter a different \\~mentor\\~. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "9250dd1b917610001d929b470f6a02e5",
"x-workday-secured-by-business-process-types": [
"Manage Mentorship"
]
}
POST /talentManagement/v2/createMentorshipForMe
Creates a mentorship for the current processing worker where the user is also the mentee.
Functional Description
---
The Create Mentorship For Me endpoint is used by a user to create new mentorships for themself.
Example Use Cases
---
ESS: An employee wants to create a mentorship for themselves and choose a mentor, mentor type, and provide a purpose.
Additional Information
---
* The security for the employee follows the security policy of the Manage Mentorship business process.
* The mentee will default to current processing worker, and the mentor is specified in the body of the request.
* If the business definition for Manage Mentorship has an approval step, then the mentorship is not created until the mentorship event is approved in Workday.
<b>Secured By Business Process Type:</b> Manage Mentorship
<b>Scope:</b> Career and Development Planning, Worker Profile and Skills
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"createMentorshipForMe"
],
"summary": "Creates a mentorship for the current processing worker where the user is also the mentee.",
"description": "Functional Description\n---\nThe Create Mentorship For Me endpoint is used by a user to create new mentorships for themself.\n\nExample Use Cases\n---\nESS: An employee wants to create a mentorship for themselves and choose a mentor, mentor type, and provide a purpose.\n\nAdditional Information\n---\n* The security for the employee follows the security policy of the Manage Mentorship business process.\n* The mentee will default to current processing worker, and the mentor is specified in the body of the request.\n* If the business definition for Manage Mentorship has an approval step, then the mentorship is not created until the mentorship event is approved in Workday.\n\n<b>Secured By Business Process Type:</b> Manage Mentorship\n\n<b>Scope:</b> Career and Development Planning, Worker Profile and Skills",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createMentorshipForMeInput_9250dd1b917610001d2a9f52b53f02d2"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createMentorshipForMeInput_9250dd1b917610001d2a9f52b53f02d2"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A119 | End Date can't be before the Start Date. |\n| Critical | A971 | This worker is terminated. Select another worker. |\n| Critical | A972 | An active \\~mentorship\\~ for this \\~mentor\\~ type already exists. |\n| Critical | A973 | You can't create a \\~mentorship\\~ when there is an event in progress with the same \\~mentor\\~ and \\~mentor\\~ type. |\n| Critical | A975 | This worker is not available to mentor. Select another worker. |\n| Critical | A979 | Enter a different \\~mentor\\~. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "9250dd1b917610001cb89734400a02c6",
"x-workday-secured-by-business-process-types": [
"Manage Mentorship"
]
}
GET /talentManagement/v2/successionPlanEvents
Get Succession Plan Events
Retrieves all the information for succession plan events. You must specify a succession plan ID to retrieve all related succession plan events. If a succession plan ID is not specified, returns a blank response.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Get Succession Plan Events",
"description": "Retrieves all the information for succession plan events. You must specify a succession plan ID to retrieve all related succession plan events. If a succession plan ID is not specified, returns a blank response.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "successionPlan",
"in": "query",
"description": "The succession plan instance.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/successionPlanEventDetails_e1e8533ee9081000121e9843ab8a0000"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "e1e8533ee9081000121fa7d375b00000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
POST /talentManagement/v2/successionPlanEvents
Creates a succession plan event instance for a succession plan. This roughly corresponds to submissions through the Manage Succession Plan task.
Creates a single succession plan event instance associated to an active succession plan with the specified data. In the request body, specify this required field: Succession Plan ID.
<b>Secured By Business Process Type:</b> Manage Succession Plan
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Creates a succession plan event instance for a succession plan. This roughly corresponds to submissions through the Manage Succession Plan task.",
"description": "Creates a single succession plan event instance associated to an active succession plan with the specified data. In the request body, specify this required field: Succession Plan ID.\n\n<b>Secured By Business Process Type:</b> Manage Succession Plan\n\n<b>Scope:</b> Talent Pipeline",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/successionPlanEventDetails_e1e8533ee9081000121e9843ab8a0000"
},
"x-workday-multipart-root-part-name": "jsonData"
}
},
"x-workday-multipart-root-part-name": "jsonData"
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanEventDetails_e1e8533ee9081000121e9843ab8a0000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A165 | The attachment category is invalid for this business process. |\n| Critical | A175 | The file is required. |\n| Critical | A178 | The business process has already been initiated. |\n| Critical | A178 | The succession plan has an in progress succession plan event. Complete the in progress event before creating a new event. Workday only supports 1 in progress event for an active succession plan. |\n| Critical | A200 | You can't comment on this business process type. |\n| Critical | A205 | You don't have the security permission on this business process to add attachments. |\n| Critical | A206 | Attachments are not enabled for this business process. |\n| Critical | A207 | You've exceeded the attachment file size limit of [tenant setup attachment limit]KB. |\n| Critical | A211 | The attachment category is required. |\n| Critical | A219 | The business process action isn't valid. |\n| Critical | A221 | The attachment category isn't enabled for this business process. |\n| Critical | A228 | [customer event validation message] |\n| Critical | A2785 | Specify an active succession plan or activate the inactive plan. The succession plan you submitted is inactive. |\n| Critical | A3291 | You must have the delegation permission to initiate this event. Ensure that you have all the required permissions and configuration for this action. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "86ac95d243841000150a8116a04d0000",
"x-workday-secured-by-business-process-types": [
"Manage Succession Plan"
]
}
GET /talentManagement/v2/successionPlanEvents/{ID}/candidates
Retrieves a collection of information for succession plan candidates for a succession plan event.
Retrieves all information for the succession plan candidates for the specified single succession plan Event ID. You can only specify a WID. When you don't specify the WID for the succession plant Event ID in the URL, Workday returns an error and the operation will fail.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Retrieves a collection of information for succession plan candidates for a succession plan event.",
"description": "Retrieves all information for the succession plan candidates for the specified single succession plan Event ID. You can only specify a WID. When you don't specify the WID for the succession plant Event ID in the URL, Workday returns an error and the operation will fail.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/successionPlanCandidateDetails_7e3bb9fc9368100028e52fe266950000"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A210 | This succession plan event has a pending action that conflicts with this one. Workday only supports 1 in progress event for an active succession plan. The initiating user must complete the in progress event before you can update the succession plan. |\n| Critical | A2777 | Specify an in progress succession plan event. The event you have specified is completed or cannot be changed unless it's in progress. |\n| Critical | A2785 | Specify an active succession plan or activate the inactive plan. The succession plan you submitted is inactive. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "1cfdaf8784fb10002824820310d50000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
POST /talentManagement/v2/successionPlanEvents/{ID}/candidates
Creates a single succession plan candidate instance with the specified data.
Creates a single succession plan candidate instance with the specified data. An in progress succession plan event is required. This roughly corresponds to a user adding a candidate on the Manage Succession Plan task.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Creates a single succession plan candidate instance with the specified data.",
"description": "Creates a single succession plan candidate instance with the specified data. An in progress succession plan event is required. This roughly corresponds to a user adding a candidate on the Manage Succession Plan task.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanCandidateDetails_7e3bb9fc9368100028e52fe266950000"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanCandidateDetails_7e3bb9fc9368100028e52fe266950000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A210 | This succession plan event has a pending action that conflicts with this one. Workday only supports 1 in progress event for an active succession plan. The initiating user must complete the in progress event before you can update the succession plan. |\n| Critical | A2777 | Specify an in progress succession plan event. The event you have specified is completed or cannot be changed unless it's in progress. |\n| Critical | A2785 | Specify an active succession plan or activate the inactive plan. The succession plan you submitted is inactive. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "0567d730fbb910001fdf232744080000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
GET /talentManagement/v2/successionPlanEvents/{ID}/candidates/{subresourceID}
Retrieves succession plan candidates for the specified succession plan Event ID.
Retrieves all information for the succession plan candidates for the specified single succession plan Event ID. You can only specify a WID. When you don't specify the WID for the succession plant Event ID in the URL, Workday returns an error and the operation will fail.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Retrieves succession plan candidates for the specified succession plan Event ID.",
"description": "Retrieves all information for the succession plan candidates for the specified single succession plan Event ID. You can only specify a WID. When you don't specify the WID for the succession plant Event ID in the URL, Workday returns an error and the operation will fail.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subresourceID",
"in": "path",
"description": "The Workday ID of the subresource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanCandidateDetails_7e3bb9fc9368100028e52fe266950000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A210 | This succession plan event has a pending action that conflicts with this one. Workday only supports 1 in progress event for an active succession plan. The initiating user must complete the in progress event before you can update the succession plan. |\n| Critical | A2777 | Specify an in progress succession plan event. The event you have specified is completed or cannot be changed unless it's in progress. |\n| Critical | A2785 | Specify an active succession plan or activate the inactive plan. The succession plan you submitted is inactive. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "1cfdaf8784fb10002824820310d50000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
DELETE /talentManagement/v2/successionPlanEvents/{ID}/candidates/{subresourceID}
Removes a succession plan candidate instance associated to the succession plan event.
Deletes a succession plan candidate with the specified succession plan candidate ID. This operation is equivalent to removing a candidate in the Manage Succession Plan task. Removing a candidate requires: an in-progress succession plan event, active succession plan, active position, and at least one candidate on the plan.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Removes a succession plan candidate instance associated to the succession plan event.",
"description": "Deletes a succession plan candidate with the specified succession plan candidate ID. This operation is equivalent to removing a candidate in the Manage Succession Plan task. Removing a candidate requires: an in-progress succession plan event, active succession plan, active position, and at least one candidate on the plan.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subresourceID",
"in": "path",
"description": "The Workday ID of the subresource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data. Deleting resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A12 | Specify a valid succession candidate. You can't remove workers from a succession plan event that are not currently on the event. |\n| Critical | A210 | This succession plan event has a pending action that conflicts with this one. Workday only supports 1 in progress event for an active succession plan. The initiating user must complete the in progress event before you can update the succession plan. |\n| Critical | A2777 | Specify an in progress succession plan event. The event you have specified is completed or cannot be changed unless it's in progress. |\n| Critical | A2785 | Specify an active succession plan or activate the inactive plan. The succession plan you submitted is inactive. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "f50b3affc9e6100016f3e8cf43180000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
PATCH /talentManagement/v2/successionPlanEvents/{ID}/candidates/{subresourceID}
Updates a new succession plan candidate instance associated to the succession plan event.
Updates a single succession plan candidate instance with the specified data. An in progress succession plan event is required. This roughly corresponds to a user adding a candidate on the Manage Succession Plan task.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Updates a new succession plan candidate instance associated to the succession plan event.",
"description": "Updates a single succession plan candidate instance with the specified data. An in progress succession plan event is required. This roughly corresponds to a user adding a candidate on the Manage Succession Plan task.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subresourceID",
"in": "path",
"description": "The Workday ID of the subresource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanCandidateDetails_7e3bb9fc9368100028e52fe266950000"
}
}
}
},
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data. Updating resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanCandidateDetails_7e3bb9fc9368100028e52fe266950000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A12 | Specify a candidate associated with this succession plan event. The Candidate ID you submitted isn’t associated with this succession plan event. |\n| Critical | A210 | This succession plan event has a pending action that conflicts with this one. Workday only supports 1 in progress event for an active succession plan. The initiating user must complete the in progress event before you can update the succession plan. |\n| Critical | A2777 | Specify an in progress succession plan event. The event you have specified is completed or cannot be changed unless it's in progress. |\n| Critical | A2785 | Specify an active succession plan or activate the inactive plan. The succession plan you submitted is inactive. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "84c25d861b46100015056d5340f50000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
POST /talentManagement/v2/successionPlanEvents/{ID}/submit
Submits a succession plan event.
Submits an in progress succession plan event specified by the Workday ID (WID). This operation is equivalent to submitting a succession plan event in the Manage Succession Plan task. To submit the succession plan event, specify an empty request body: {}.
To add a comment, specify this request body:
{
"businessProcessParameters": {
"action":{
"id": "d9e4223e446c11de98360015c5e6daf6"
},
"comment": "Test comment."
}
}
<b>Secured By Business Process Type:</b> Manage Succession Plan
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Submits a succession plan event.",
"description": "Submits an in progress succession plan event specified by the Workday ID (WID). This operation is equivalent to submitting a succession plan event in the Manage Succession Plan task. To submit the succession plan event, specify an empty request body: {}.\n\nTo add a comment, specify this request body:\n{\n \"businessProcessParameters\": {\n \"action\":{\n \"id\": \"d9e4223e446c11de98360015c5e6daf6\"\n },\n \"comment\": \"Test comment.\"\n }\n}\n\n<b>Secured By Business Process Type:</b> Manage Succession Plan\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/submitSuccessionPlanEvent_d5dd3422c77210000f4fb059cbfb0000"
},
"x-workday-multipart-root-part-name": "jsonData"
}
},
"x-workday-multipart-root-part-name": "jsonData"
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/submitSuccessionPlanEvent_d5dd3422c77210000f4fb059cbfb0000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A200 | You can't comment on this business process type. |\n| Critical | A228 | [customer event validation message] |\n| Critical | A2777 | Specify an in progress succession plan event. The event you have specified is completed or cannot be changed unless it's in progress. |",
"content": {}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "d5dd3422c77210000eaffa0fcee10000",
"x-workday-secured-by-business-process-types": [
"Manage Succession Plan"
]
}
GET /talentManagement/v2/successionPlanEvents/{ID}
Get Succession Plan Events
Retrieves all succession plan events with the specified succession plan ID.
<b>Secured By Domain:</b> Worker Data: Succession
<b>Scope:</b> Talent Pipeline
Authentication
[
{
"OAuth2": []
}
]
Request, responses and operation details
{
"tags": [
"successionPlanEvents"
],
"summary": "Get Succession Plan Events",
"description": "Retrieves all succession plan events with the specified succession plan ID.\n\n<b>Secured By Domain:</b> Worker Data: Succession\n\n<b>Scope:</b> Talent Pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successionPlanEventDetails_e1e8533ee9081000121e9843ab8a0000"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "e1e8533ee9081000121fa7d375b00000",
"x-workday-secured-by-domains": [
"Worker Data: Succession"
]
}
GET /talentManagement/v2/values/successionPlan/readiness/
Retrieves instances that can be used as values for other endpoint parameters in this service.
Authentication
[
{
"OAuth2": []
}
]
Path-level parameters and metadata
{
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default and maximum is 1000.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
"schema": {
"type": "string"
}
}
],
"x-workday-confidence-level": "Production"
}
Request, responses and operation details
{
"tags": [
"Prompt Values"
],
"description": "Retrieves instances that can be used as values for other endpoint parameters in this service.",
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-protected-usage-enabled": false,
"x-workday-internal-try-enabled": "false"
}
GET /talentManagement/v2/values/successionPlan/members/
Retrieves instances that can be used as values for other endpoint parameters in this service.
Authentication
[
{
"OAuth2": []
}
]
Path-level parameters and metadata
{
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default and maximum is 1000.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
"schema": {
"type": "string"
}
}
],
"x-workday-confidence-level": "Production"
}
Request, responses and operation details
{
"tags": [
"Prompt Values"
],
"description": "Retrieves instances that can be used as values for other endpoint parameters in this service.",
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-protected-usage-enabled": false,
"x-workday-internal-try-enabled": "false"
}
GET /talentManagement/v2/values/successionPlan/strategies/
Retrieves instances that can be used as values for other endpoint parameters in this service.
Authentication
[
{
"OAuth2": []
}
]
Path-level parameters and metadata
{
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default and maximum is 1000.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "search",
"in": "query",
"description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
"schema": {
"type": "string"
}
}
],
"x-workday-confidence-level": "Production"
}
Request, responses and operation details
{
"tags": [
"Prompt Values"
],
"description": "Retrieves instances that can be used as values for other endpoint parameters in this service.",
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-protected-usage-enabled": false,
"x-workday-internal-try-enabled": "false"
}
Document metadata and extensions
{
"openapi": "3.0.1",
"info": {
"title": "talentManagement",
"description": "The Talent Management public service contains resources that expose Workday Talent Management Business Services data. This service can be used for integration with other talent management systems.",
"version": "v2",
"x-workday-internal-source": "xo",
"x-workday-internal-routing": "Public",
"x-workday-internal-protected-usage-enabled": false,
"x-workday-internal-service-container-id": "d9326a9f560e10000ad2e111b3941258"
},
"tags": [
{
"name": "createMentorshipForMe",
"description": "Create Mentorship For Me interface"
},
{
"name": "createMentorshipForWorker",
"description": "Create Mentorship For Worker interface"
},
{
"name": "mentorships",
"description": "The Mentorship interface"
},
{
"name": "successionPlanEvents",
"description": "Retrieves all the information for succession plan events. You must specify a succession plan ID to retrieve all related succession plan events. If a succession plan ID is not specified, returns a blank response.",
"x-workday-confidence-level": "Production"
},
{
"name": "successionPlans",
"description": "Provides the ability to get and create succession plan for a position\n- GET endpoint retrieves all the information for a succession plan. You must specify a position ID. If a position ID is not specified, returns a blank response.\n\n- POST endpoint creates a single succession plan instance with the specified data. In the request body, specify the required field: position.ID.",
"x-workday-confidence-level": "Production"
},
{
"name": "Prompt Values",
"description": "Retrieves instances that can be used as values for other endpoint parameters in this service."
}
],
"security": [
{
"OAuth2": []
}
],
"x-purple-suite-contract": "full-service-repository-modeled-runtime",
"x-purple-suite-upstream-servers": [
{
"url": "https://<tenantHostname>/talentManagement/v2"
}
],
"x-purple-suite-runtime-fidelity": {
"capturedOperationIds": [],
"modeledOperationIds": [
"workdayTalentManagementGetSuccessionPlans",
"workdayTalentManagementPostSuccessionPlans",
"workdayTalentManagementGetSuccessionPlansByID",
"workdayTalentManagementGetMentorships",
"workdayTalentManagementPostMentorshipsByIDClose",
"workdayTalentManagementGetMentorshipsByID",
"workdayTalentManagementPostMentorshipsByIDEdit",
"workdayTalentManagementPostCreateMentorshipForWorker",
"workdayTalentManagementPostCreateMentorshipForMe",
"workdayTalentManagementGetSuccessionPlanEvents",
"workdayTalentManagementPostSuccessionPlanEvents",
"workdayTalentManagementGetSuccessionPlanEventsByIDCandidates",
"workdayTalentManagementPostSuccessionPlanEventsByIDCandidates",
"workdayTalentManagementGetSuccessionPlanEventsByIDCandidatesBySubresourceID",
"workdayTalentManagementPatchSuccessionPlanEventsByIDCandidatesBySubresourceID",
"workdayTalentManagementDeleteSuccessionPlanEventsByIDCandidatesBySubresourceID",
"workdayTalentManagementPostSuccessionPlanEventsByIDSubmit",
"workdayTalentManagementGetSuccessionPlanEventsByID",
"workdayTalentManagementGetValuesSuccessionPlanReadiness",
"workdayTalentManagementGetValuesSuccessionPlanMembers",
"workdayTalentManagementGetValuesSuccessionPlanStrategies"
],
"operations": [
{
"operationId": "workdayTalentManagementGetSuccessionPlans",
"method": "get",
"path": "/talentManagement/v2/successionPlans",
"upstreamPath": "/successionPlans",
"fidelity": "modeled",
"xWorkdayOperationId": "7e3bb9fc9368100020e63f4bc4f60000"
},
{
"operationId": "workdayTalentManagementPostSuccessionPlans",
"method": "post",
"path": "/talentManagement/v2/successionPlans",
"upstreamPath": "/successionPlans",
"fidelity": "modeled",
"xWorkdayOperationId": "6e24a91f47cf10001cb5fd1f934d0000"
},
{
"operationId": "workdayTalentManagementGetSuccessionPlansByID",
"method": "get",
"path": "/talentManagement/v2/successionPlans/{ID}",
"upstreamPath": "/successionPlans/{ID}",
"fidelity": "modeled",
"xWorkdayOperationId": "7e3bb9fc9368100020e63f4bc4f60000"
},
{
"operationId": "workdayTalentManagementGetMentorships",
"method": "get",
"path": "/talentManagement/v2/mentorships",
"upstreamPath": "/mentorships",
"fidelity": "modeled",
"xWorkdayOperationId": "96e7ee2167ea1000074ac1d67d180828"
},
{
"operationId": "workdayTalentManagementPostMentorshipsByIDClose",
"method": "post",
"path": "/talentManagement/v2/mentorships/{ID}/close",
"upstreamPath": "/mentorships/{ID}/close",
"fidelity": "modeled",
"xWorkdayOperationId": "96e7ee2167ea10001dd51060069e088f"
},
{
"operationId": "workdayTalentManagementGetMentorshipsByID",
"method": "get",
"path": "/talentManagement/v2/mentorships/{ID}",
"upstreamPath": "/mentorships/{ID}",
"fidelity": "modeled",
"xWorkdayOperationId": "96e7ee2167ea1000074ac1d67d180828"
},
{
"operationId": "workdayTalentManagementPostMentorshipsByIDEdit",
"method": "post",
"path": "/talentManagement/v2/mentorships/{ID}/edit",
"upstreamPath": "/mentorships/{ID}/edit",
"fidelity": "modeled",
"xWorkdayOperationId": "d8a7d527cba210002bf03817fa8d0834"
},
{
"operationId": "workdayTalentManagementPostCreateMentorshipForWorker",
"method": "post",
"path": "/talentManagement/v2/createMentorshipForWorker",
"upstreamPath": "/createMentorshipForWorker",
"fidelity": "modeled",
"xWorkdayOperationId": "9250dd1b917610001d929b470f6a02e5"
},
{
"operationId": "workdayTalentManagementPostCreateMentorshipForMe",
"method": "post",
"path": "/talentManagement/v2/createMentorshipForMe",
"upstreamPath": "/createMentorshipForMe",
"fidelity": "modeled",
"xWorkdayOperationId": "9250dd1b917610001cb89734400a02c6"
},
{
"operationId": "workdayTalentManagementGetSuccessionPlanEvents",
"method": "get",
"path": "/talentManagement/v2/successionPlanEvents",
"upstreamPath": "/successionPlanEvents",
"fidelity": "modeled",
"xWorkdayOperationId": "e1e8533ee9081000121fa7d375b00000"
},
{
"operationId": "workdayTalentManagementPostSuccessionPlanEvents",
"method": "post",
"path": "/talentManagement/v2/successionPlanEvents",
"upstreamPath": "/successionPlanEvents",
"fidelity": "modeled",
"xWorkdayOperationId": "86ac95d243841000150a8116a04d0000"
},
{
"operationId": "workdayTalentManagementGetSuccessionPlanEventsByIDCandidates",
"method": "get",
"path": "/talentManagement/v2/successionPlanEvents/{ID}/candidates",
"upstreamPath": "/successionPlanEvents/{ID}/candidates",
"fidelity": "modeled",
"xWorkdayOperationId": "1cfdaf8784fb10002824820310d50000"
},
{
"operationId": "workdayTalentManagementPostSuccessionPlanEventsByIDCandidates",
"method": "post",
"path": "/talentManagement/v2/successionPlanEvents/{ID}/candidates",
"upstreamPath": "/successionPlanEvents/{ID}/candidates",
"fidelity": "modeled",
"xWorkdayOperationId": "0567d730fbb910001fdf232744080000"
},
{
"operationId": "workdayTalentManagementGetSuccessionPlanEventsByIDCandidatesBySubresourceID",
"method": "get",
"path": "/talentManagement/v2/successionPlanEvents/{ID}/candidates/{subresourceID}",
"upstreamPath": "/successionPlanEvents/{ID}/candidates/{subresourceID}",
"fidelity": "modeled",
"xWorkdayOperationId": "1cfdaf8784fb10002824820310d50000"
},
{
"operationId": "workdayTalentManagementPatchSuccessionPlanEventsByIDCandidatesBySubresourceID",
"method": "patch",
"path": "/talentManagement/v2/successionPlanEvents/{ID}/candidates/{subresourceID}",
"upstreamPath": "/successionPlanEvents/{ID}/candidates/{subresourceID}",
"fidelity": "modeled",
"xWorkdayOperationId": "84c25d861b46100015056d5340f50000"
},
{
"operationId": "workdayTalentManagementDeleteSuccessionPlanEventsByIDCandidatesBySubresourceID",
"method": "delete",
"path": "/talentManagement/v2/successionPlanEvents/{ID}/candidates/{subresourceID}",
"upstreamPath": "/successionPlanEvents/{ID}/candidates/{subresourceID}",
"fidelity": "modeled",
"xWorkdayOperationId": "f50b3affc9e6100016f3e8cf43180000"
},
{
"operationId": "workdayTalentManagementPostSuccessionPlanEventsByIDSubmit",
"method": "post",
"path": "/talentManagement/v2/successionPlanEvents/{ID}/submit",
"upstreamPath": "/successionPlanEvents/{ID}/submit",
"fidelity": "modeled",
"xWorkdayOperationId": "d5dd3422c77210000eaffa0fcee10000"
},
{
"operationId": "workdayTalentManagementGetSuccessionPlanEventsByID",
"method": "get",
"path": "/talentManagement/v2/successionPlanEvents/{ID}",
"upstreamPath": "/successionPlanEvents/{ID}",
"fidelity": "modeled",
"xWorkdayOperationId": "e1e8533ee9081000121fa7d375b00000"
},
{
"operationId": "workdayTalentManagementGetValuesSuccessionPlanReadiness",
"method": "get",
"path": "/talentManagement/v2/values/successionPlan/readiness/",
"upstreamPath": "/values/successionPlan/readiness/",
"fidelity": "modeled"
},
{
"operationId": "workdayTalentManagementGetValuesSuccessionPlanMembers",
"method": "get",
"path": "/talentManagement/v2/values/successionPlan/members/",
"upstreamPath": "/values/successionPlan/members/",
"fidelity": "modeled"
},
{
"operationId": "workdayTalentManagementGetValuesSuccessionPlanStrategies",
"method": "get",
"path": "/talentManagement/v2/values/successionPlan/strategies/",
"upstreamPath": "/values/successionPlan/strategies/",
"fidelity": "modeled"
}
]
},
"x-purple-suite-exclusions": [
"Workday Web Services (SOAP/WWS)",
"Workday Graph API",
"Workday Query Language (WQL), a separate Platform API family",
"Reports-as-a-Service (RaaS) and tenant custom reports",
"Finance, Payroll, Student, and non-HR Platform REST services",
"Experimental alpha, beta, and labs services",
"Tenant-configured actions absent from the pinned public artifacts"
]
}