{ "swagger": "2.0", "info": { "description": "The Recruiting service enables applications to access Workday data about recruiting, such as job postings, prospects, and interviews.", "version": "v4", "title": "recruiting", "x-workday-confidence-level": "Production", "x-workday-internal-source": "xo", "x-workday-internal-routing": "Public", "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-service-container-id": "ba74f44bc90e107329f6353919340036" }, "host": "", "basePath": "/recruiting/v4", "tags": [ { "name": "employmentAgreements", "description": "Provides the ability to list employment agreements, access details for a specific agreement, and correct agreement data for pre-hire workers. Workday scopes this resource to pre-hire employment agreement events, and returns only information authorised by your business process security.", "x-workday-confidence-level": "Production" }, { "name": "interviews" }, { "name": "jobPostings", "description": "Provides the ability to retrieve job postings." }, { "name": "offers", "description": "Provides the ability to list offers, retrieve details for a specific offer, and correct offer data for candidates. Workday scopes this resource to offer events, and returns only information authorized by your business process security.", "x-workday-confidence-level": "Production" }, { "name": "prospects", "description": "Provides the ability to retrieve and create prospect data." }, { "name": "Prompt Values", "description": "Retrieves instances that can be used as values for other endpoint parameters in this service." } ], "schemes": [ "https" ], "paths": { "/jobPostings/{ID}/questionnaire/{subresourceID}": { "get": { "tags": [ "jobPostings" ], "summary": "Retrieves a single questionnaire for the specified job posting ID.", "description": "Retrieves all questionnaires for the specified job posting ID.\n\nSecured By Domain: Job Postings: External\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Job_Posting_Anchor_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Job_Posting_Anchor_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Questionnaire_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Questionnaire_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/questionnaireDetails_58cd464577ad1000ee76d171eea90000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "58cd464577ad1000f05fad5aa8270000", "x-workday-secured-by-domains": [ "Job Postings: External" ] } }, "/interviews/{ID}": { "get": { "tags": [ "interviews" ], "description": "Retrieves a collection of interviews.\n\nSecured By Domain: Interview Feedback Public API\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/interviewEventWithJobApplicationJobRequisitionInterviewerDetails_def69f12d55410000f7ec8da36ae005a" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "df78b8e577c910001f381909b55100e6", "x-workday-secured-by-domains": [ "Interview Feedback Public API" ] } }, "/values/common/countries/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "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.", "required": false, "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.", "required": false, "type": "string" } ] }, "/values/offers/hireReasons/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "id", "in": "query", "description": "The offer event used to filter prompt results.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "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.", "required": false, "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.", "required": false, "type": "string" } ], "x-workday-confidence-level": "Production" }, "/values/employmentAgreement/hireReasons/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "id", "in": "query", "description": "The employment agreement event used to filter prompt results.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "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.", "required": false, "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.", "required": false, "type": "string" } ], "x-workday-confidence-level": "Production" }, "/prospects": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single \\~prospect\\~ instance.", "description": "Retrieves the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Prospects, Set Up: External Career Site Access\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/prospectSummary_7657284bd7781000178a3bf6e17f001a" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ef3d700eb59610001e2f0dcf2ea90013", "x-workday-secured-by-domains": [ "Prospects", "Set Up: External Career Site Access" ] }, "post": { "tags": [ "prospects" ], "summary": "Create \\~prospects\\~.", "description": "Creates a single \\~prospect\\~ instance with the specified data. In the request body, specify at least the required field: candidate.name.country.id. The Recruiting Name Components configuration might require additional fields for candidate.name. To determine additional required fields, see the Recruiting Name Components tab on the Maintain Name Components by \\~Country\\~ task.\n\nSecured By Domain: Create External Prospects, Set Up: External Career Site Access\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "prospectSummary", "required": true, "schema": { "$ref": "#/definitions/prospectSummary_7657284bd7781000178a3bf6e17f001a" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/prospectSummary_7657284bd7781000178a3bf6e17f001a" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A249 | You must enter the prospect’s email address or phone number. |\n| Critical | A255 | Enter referral as the source when you enter referred by. |\n| Critical | A256 | Enter a name. |\n| Critical | A268 | Enter the referral for the prospect. |\n| Critical | A269 | Enter an email address in this format: xxx@yy.com. |\n| Critical | A274 | Enter a valid format for Phone Number. |\n| Critical | A278 | Enter active candidate pools. |\n| Critical | A284 | Enter active candidate tags. |\n| Critical | A288 | Enter a phone number in the valid format: [PhoneValidationMessage] |\n| Critical | A673 | The Phone Device Type that you specified must be Active. |\n| Critical | A820 | Specify a value for Phone Device Type. |\n| Critical | A821 | You can't specify a Phone Device Type that's Hidden for Recruiting. |\n| Critical | A822 | Specify a value for Phone Number. |\n| Critical | A823 | Specify a value for Country Phone Code. |\n| Critical | A2517 | The email address you entered is invalid. Enter a valid email address. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "50be5081f82e10000a3259d6e22d05b7", "x-workday-secured-by-domains": [ "Create External Prospects", "Set Up: External Career Site Access" ] } }, "/employmentAgreements/{ID}": { "get": { "tags": [ "employmentAgreements" ], "summary": "Returns an employment agreement event with the specified ID for a pre‑hire worker.", "description": "Retrieves an employment agreement event with the specified ID for a pre-hire worker. Workday returns only information authorized by your business process security.\n\nSecured By Domain: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/minimalInstanceView_6c2cb3ba412510001d291d96f4750000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "7b559a8aab2f100019fbbb68bb370000", "x-workday-secured-by-domains": [ "Core Navigation", "Public Business Processes" ] } }, "/values/employmentAgreement/location/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "id", "in": "query", "description": "The employment agreement event used to filter prompt results.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "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.", "required": false, "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.", "required": false, "type": "string" } ], "x-workday-confidence-level": "Production" }, "/employmentAgreements/{ID}/correct": { "post": { "tags": [ "employmentAgreements" ], "summary": "Corrects employment agreement events for a pre-hire worker.", "description": "Corrects employment agreement events for a pre-hire worker.\nSpecify the updated values for the supported employment agreement fields and enter an optional correction comment or reason. Workday validates the corrections against your business process configuration and security rules before applying them.\n\nSecured By Domain: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "in": "body", "name": "employmentAgreementCorrect", "required": true, "schema": { "$ref": "#/definitions/employmentAgreementCorrect_7b559a8aab2f10001b9526d096610000" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/employmentAgreementCorrect_7b559a8aab2f10001b9526d096610000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | Event is not correctable - A3471 | This [event] cannot be corrected |\n| Critical | - | Contact your system administrator. You currently don't have security access to correct this event. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "7b559a8aab2f10001adc4750fe350000", "x-workday-secured-by-domains": [ "Core Navigation", "Public Business Processes" ] } }, "/interviews": { "get": { "tags": [ "interviews" ], "description": "Retrieves a collection of interviews.\n\nSecured By Domain: Interview Feedback Public API\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "interviewStatus", "in": "query", "description": "\"All applicable interview statuses for an Interview event. Statuses can be: \n * AWAITING_ME - An in-progress Interview event is waiting for the logged-in user's feedback. \n * COMPLETED - An Interview event is complete.\n * FEEDBACK_COMPLETE - All interview feedback for this in-progress event was submitted, but the Interview event isn’t awaiting the Make Interview Decision step.\n * NOT_SCHEDULED - An interview hasn't been scheduled for an in-progress Interview event.\n * PENDING_FEEDBACK - An in-progress Interview event is waiting for interviewer feedback.\n * SCHEDULED - An interview is scheduled for an in-progress Interview event.\n * SUBMITTED_FEEDBACK - The logged-in user submitted feedback for an in-progress Interview event.\n * MAKE_INTERVIEW_DECISION - The make an interview decision step for the candidate.\"", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/interviewEventWithJobApplicationJobRequisitionInterviewerDetails_def69f12d55410000f7ec8da36ae005a" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "df78b8e577c910001f381909b55100e6", "x-workday-secured-by-domains": [ "Interview Feedback Public API" ] } }, "/prospects/{ID}/languages": { "get": { "tags": [ "prospects" ], "summary": "Retrieves the languages of a single \\~prospect\\~ instance.", "description": "Retrieves the languages of the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ecf7ccfb11c110002805608ea5d80015", "x-workday-secured-by-domains": [ "Prospects" ] }, "post": { "tags": [ "prospects" ], "summary": "Creates languages for a \\~prospect\\~.", "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: language.id, abilities, abilities.abilityType.\n\nSecured By Domain: Create External Prospects\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "in": "body", "name": "candidateLanguageSkillDetails", "required": true, "schema": { "$ref": "#/definitions/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A242 | Enter only 1 ability type for the same language. |\n| Critical | A263 | Enter a language. |\n| Critical | A267 | At least one ability for this language is required. |\n| Critical | A290 | Duplicate language entries are not allowed. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ecf7ccfb11c110002afc9babda82002e", "x-workday-secured-by-domains": [ "Create External Prospects" ] } }, "/prospects/{ID}/skills": { "get": { "tags": [ "prospects" ], "summary": "Retrieves the skills of a single \\~prospect\\~ instance.", "description": "Retrieves the skills of the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/candidateSkillItemDetails_2705750e957f10002beca80792940019" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "d1f5b73501871000123b3f69018f005e", "x-workday-secured-by-domains": [ "Prospects" ] }, "post": { "tags": [ "prospects" ], "summary": "Creates skills for a \\~prospect\\~.", "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: name.\n\nSecured By Domain: Create External Prospects\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "in": "body", "name": "candidateSkillItemDetails", "required": true, "schema": { "$ref": "#/definitions/candidateSkillItemDetails_2705750e957f10002beca80792940019" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/candidateSkillItemDetails_2705750e957f10002beca80792940019" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A257 | Enter a skill name. |\n| Critical | A259 | You cannot enter duplicate skills. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "2705750e957f10002bc3d403249c0017", "x-workday-secured-by-domains": [ "Create External Prospects" ] } }, "/prospects/{ID}/experiences/{subresourceID}": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single experience instance for a \\~prospect\\~.", "description": "Retrieves the work experience with the specified ID for the specified \\~prospect\\~.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: CANDIDATE_EXPERIENCE_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(CANDIDATE_EXPERIENCE_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b4dba3cbddc710001bf375eb8400001c", "x-workday-secured-by-domains": [ "Prospects" ] } }, "/jobPostings/{ID}/candidateAvailabilityTemplate": { "get": { "tags": [ "jobPostings" ], "summary": "Retrieves a single instance of the candidate availability template version.", "description": "Returns the candidate availability template version for the active job posting for the specified ID.\n\nSecured By Domain: Job Postings: External\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Job_Posting_Anchor_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Job_Posting_Anchor_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/availabilityTemplateDetails_617853847093100014ba0b710cd30000" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "6178538470931000145391d429b70000", "x-workday-secured-by-domains": [ "Job Postings: External" ] } }, "/jobPostings": { "get": { "tags": [ "jobPostings" ], "summary": "Retrieves a collection of job postings.", "description": "Retrieves all job postings. You can filter by categories and job sites.\n\nSecured By Domain: Job Postings: External\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "category", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "jobPosting", "in": "query", "description": "Job Posting for Job Posting Anchor", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "jobRequisition", "in": "query", "description": "Job Requisition for Job Posting Anchor", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "jobSite", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/jobPostingAnchorSummary_5597c990f22e10000fc34f022dce0020" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "5597c990f22e10000fc4975e37560022", "x-workday-secured-by-domains": [ "Job Postings: External" ] } }, "/offers/{ID}": { "get": { "tags": [ "offers" ], "summary": "Retrieves an offer event with the specified ID for a candidate.", "description": "Retrieves an offer event for a candidate with the specified ID. Workday returns only information authorized by your business process security.\n\nSecured By Domain: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/minimalInstanceView_6c2cb3ba412510001d291d96f4750000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "879f275868fe1000102461eb7d050000", "x-workday-secured-by-domains": [ "Core Navigation", "Public Business Processes" ] } }, "/prospects/{ID}/languages/{subresourceID}": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single language instance for a \\~prospect\\~.", "description": "Retrieves the language with the specified ID for the specified \\~prospect\\~.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ecf7ccfb11c110002805608ea5d80015", "x-workday-secured-by-domains": [ "Prospects" ] } }, "/prospects/{ID}/educations": { "get": { "tags": [ "prospects" ], "summary": "Retrieves the education of a single \\~prospect\\~ instance.", "description": "Retrieves the education of the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A261 | Enter a school name. |\n| Critical | A283 | Enter a last year attended that is after the first year attended. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "9727f970aa231000060528416b7b0016", "x-workday-secured-by-domains": [ "Prospects" ] }, "post": { "tags": [ "prospects" ], "summary": "Creates educations for a \\~prospect\\~.", "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: schoolName.\n\nSecured By Domain: Create External Prospects\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "in": "body", "name": "candidateEducationDetails", "required": true, "schema": { "$ref": "#/definitions/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A261 | Enter a school name. |\n| Critical | A283 | Enter a last year attended that is after the first year attended. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "9727f970aa231000052be822d809000d", "x-workday-secured-by-domains": [ "Create External Prospects" ] } }, "/values/employmentAgreement/jobProfiles/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "id", "in": "query", "description": "The employment agreement event used to filter prompt results.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "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.", "required": false, "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.", "required": false, "type": "string" } ], "x-workday-confidence-level": "Production" }, "/interviews/{ID}/feedback/{subresourceID}": { "get": { "tags": [ "interviews" ], "description": "Retrieves interview feedback for the specified ID.\n\nSecured By Domain: Interview Feedback Public API\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/interviewDetailSummary_def69f12d5541000139a7815aae9008f" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "df78b8e577c910001ba2775bb2e200c8", "x-workday-secured-by-domains": [ "Interview Feedback Public API" ] } }, "/prospects/{ID}/skills/{subresourceID}": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single skill instance for a \\~prospect\\~.", "description": "Retrieves the skill with the specified ID for the specified \\~prospect\\~.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/candidateSkillItemDetails_2705750e957f10002beca80792940019" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "d1f5b73501871000123b3f69018f005e", "x-workday-secured-by-domains": [ "Prospects" ] } }, "/prospects/{ID}/resumeAttachments/{subresourceID}": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single resume attachment instance for a \\~prospect\\~.", "description": "Retrieves the resume attachment with the specified ID for the specified \\~prospect\\~.\n\nSecured By Domain: Candidate Data: Attachments\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/resumeAttachmentDetailsView_134c3544d220100007f0f9b541a400a5" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b627485bd061100019eefb6f66010180", "x-workday-secured-by-domains": [ "Candidate Data: Attachments" ] } }, "/jobPostings/{ID}": { "get": { "tags": [ "jobPostings" ], "summary": "Retrieves a job posting.", "description": "Retrieves a job posting with the specified ID\n\nSecured By Domain: Job Postings: External\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Job_Posting_Anchor_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Job_Posting_Anchor_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/jobPostingAnchorSummary_5597c990f22e10000fc34f022dce0020" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "5597c990f22e10000fc4975e37560022", "x-workday-secured-by-domains": [ "Job Postings: External" ] } }, "/jobPostings/{ID}/candidateAvailabilityTemplate/{subresourceID}": { "get": { "tags": [ "jobPostings" ], "summary": "Retrieves a single instance of the candidate availability template version.", "description": "Returns the candidate availability template version for the active job posting for the specified ID.\n\nSecured By Domain: Job Postings: External\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Job_Posting_Anchor_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Job_Posting_Anchor_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/availabilityTemplateDetails_617853847093100014ba0b710cd30000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "6178538470931000145391d429b70000", "x-workday-secured-by-domains": [ "Job Postings: External" ] } }, "/prospects/{ID}/experiences": { "get": { "tags": [ "prospects" ], "summary": "Retrieves the work experience of a single \\~prospect\\~ instance.", "description": "Retrieves the work experience of the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b4dba3cbddc710001bf375eb8400001c", "x-workday-secured-by-domains": [ "Prospects" ] }, "post": { "tags": [ "prospects" ], "summary": "Creates experiences for a \\~prospect\\~.", "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: companyName, title, startYear.\n\nSecured By Domain: Create External Prospects\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "in": "body", "name": "prospectExperienceDetails", "required": true, "schema": { "$ref": "#/definitions/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A240 | Enter end year when you enter the end month. |\n| Critical | A247 | Enter a title. |\n| Critical | A253 | Enter a number from 1 to 12 for end month. |\n| Critical | A258 | Enter a start year. |\n| Critical | A271 | Enter an end month and end year that occur on or after the start month and start year. |\n| Critical | A282 | Enter a company name. |\n| Critical | A286 | Enter a number from 1 to 12 for start month. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b4dba3cbddc710001bf375af9e44001b", "x-workday-secured-by-domains": [ "Create External Prospects" ] } }, "/employmentAgreements": { "get": { "tags": [ "employmentAgreements" ], "summary": "Retrieves employment agreement events for a pre-hire worker.", "description": "Retrieves a collection of employment agreement events for a pre-hire worker. Workday returns only information authorized by your business process security.\n\nSecured By Domain: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable", "produces": [ "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/minimalInstanceView_6c2cb3ba412510001d291d96f4750000" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "7b559a8aab2f100019fbbb68bb370000", "x-workday-secured-by-domains": [ "Core Navigation", "Public Business Processes" ] } }, "/offers/{ID}/correct": { "post": { "tags": [ "offers" ], "summary": "Corrects offer events for a candidate.", "description": "Corrects offer events for a candidate. Specify the updated values for the supported fields and an optional correction comment or reason. Workday validate the corrections against your business process configuration and security rules before applying them.\n\nSecured By Domain: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "in": "body", "name": "offerCorrect", "required": true, "schema": { "$ref": "#/definitions/offerCorrect_879f275868fe1000108f853bdf110000" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/offerCorrect_879f275868fe1000108f853bdf110000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | Event is not correctable - A3471 | This [event] cannot be corrected |\n| Critical | - | Contact your system administrator. You currently don't have security access to correct this event. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "879f275868fe100010a9428260020000", "x-workday-secured-by-domains": [ "Core Navigation", "Public Business Processes" ] } }, "/prospects/{ID}/resumeAttachments/{subresourceID}?type=viewFile": { "get": { "tags": [ "prospects" ], "description": "\n\nSecured By Domain: Candidate Data: Attachments\n\nScope: Recruiting\n\nContains attachment(s)", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/resumeAttachmentFileView_ee7318fbf39e10001e321c67d42300c0" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b627485bd061100019eefbbb0d6c0181", "x-workday-secured-by-domains": [ "Candidate Data: Attachments" ] } }, "/interviews/{ID}/feedback": { "get": { "tags": [ "interviews" ], "description": "Retrieves interview feedback for the specified ID.\n\nSecured By Domain: Interview Feedback Public API\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/interviewDetailSummary_def69f12d5541000139a7815aae9008f" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "df78b8e577c910001ba2775bb2e200c8", "x-workday-secured-by-domains": [ "Interview Feedback Public API" ] }, "post": { "tags": [ "interviews" ], "description": "Submits interview details for the processing \\~worker\\~ with the interviewer's rating and comment.\n\nSecured By Domain: Interview Feedback Public API\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" }, { "in": "body", "name": "interviewDetailSummary", "required": true, "schema": { "$ref": "#/definitions/interviewDetailSummary_def69f12d5541000139a7815aae9008f" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/interviewDetailSummary_def69f12d5541000139a7815aae9008f" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A129 | You cannot take action on this candidate. |\n| Critical | A130 | Select a valid rating. |\n| Critical | A131 | You cannot submit interview feedback because you are not a part of the interview team. |\n| Critical | A132 | Overall Comment Required (Configure Optional Fields) but not included. Please contact your administrator. |\n| Critical | A133 | Overall Rating is included but is hidden (Configure Optional Fields). Please contact your administrator. |\n| Critical | A134 | Overall Comment is included but is hidden (Configure Optional Fields). Please contact your administrator. |\n| Critical | A135 | Interview feedback task contains competencies, questionnaires, or both; complete feedback using Workday or the Give Interview Feedback URL provided by the API. |\n| Critical | A136 | Overall Rating is Required (Configure Optional Fields) but not included. Please contact your administrator. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "df78b8e577c91000174144aa747100b1", "x-workday-secured-by-domains": [ "Interview Feedback Public API" ] } }, "/prospects/{ID}/resumeAttachments": { "get": { "tags": [ "prospects" ], "summary": "Retrieves attached resumes for a single \\~prospect\\~ instance.", "description": "Retrieves attached resumes for the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Candidate Data: Attachments\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/resumeAttachmentDetailsView_134c3544d220100007f0f9b541a400a5" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b627485bd061100019eefb6f66010180", "x-workday-secured-by-domains": [ "Candidate Data: Attachments" ] }, "post": { "tags": [ "prospects" ], "summary": "Creates resume attachments for a \\~prospect\\~.", "description": "Creates a single resume attachment instance with the specified data. In the request body, specify at least these required fields: fileName, attachmentContent.\n\nSecured By Domain: Create External Prospects, Set Up: External Career Site Access\n\nScope: Recruiting\n\nContains attachment(s)\n\nContains attachment(s)", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "in": "body", "name": "jsonData", "required": true, "schema": { "$ref": "#/definitions/resumeAttachmentDetailsCreate_ee22ee09075410000346b5ebfa2303e4" }, "x-workday-multipart-root-part-name": "jsonData" } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/resumeAttachmentDetailsCreate_ee22ee09075410000346b5ebfa2303e4" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A246 | One of the following file extensions must be used: [allowed file extensions]. |\n| Critical | A252 | Enter a file name. |\n| Critical | A270 | Select a file to upload. |\n| Critical | - | The file size should not exceed [file size]MB. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-multipart-root-part-name": "jsonData", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b627485bd061100019eefbc59fe90182", "x-workday-secured-by-domains": [ "Create External Prospects", "Set Up: External Career Site Access" ] } }, "/jobPostings/{ID}/questionnaire": { "get": { "tags": [ "jobPostings" ], "summary": "Retrieves a single questionnaire instance.", "description": "Retrieves a collection of questionnaires.\n\nSecured By Domain: Job Postings: External\n\nScope: Recruiting", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Job_Posting_Anchor_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Job_Posting_Anchor_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" }, { "name": "questionnaireType", "in": "query", "description": "questionnaireType", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/questionnaireDetails_58cd464577ad1000ee76d171eea90000" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "58cd464577ad1000f05fad5aa8270000", "x-workday-secured-by-domains": [ "Job Postings: External" ] } }, "/prospects/{ID}/resumeAttachments?type=viewFile": { "get": { "tags": [ "prospects" ], "description": "\n\nSecured By Domain: Candidate Data: Attachments\n\nScope: Recruiting\n\nContains attachment(s)", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/resumeAttachmentFileView_ee7318fbf39e10001e321c67d42300c0" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b627485bd061100019eefbbb0d6c0181", "x-workday-secured-by-domains": [ "Candidate Data: Attachments" ] } }, "/offers": { "get": { "tags": [ "offers" ], "summary": "Retrieves offer events for a candidate.", "description": "Retrieves a collection of offer events. Workday returns only information authorized by your business process security.\n\nSecured By Domain: Core Navigation, Public Business Processes\n\nScope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable", "produces": [ "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "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.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/minimalInstanceView_6c2cb3ba412510001d291d96f4750000" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-confidence-level": "Production", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "879f275868fe1000102461eb7d050000", "x-workday-secured-by-domains": [ "Core Navigation", "Public Business Processes" ] } }, "/prospects/{ID}/educations/{subresourceID}": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single education instance for a \\~prospect\\~.", "description": "Retrieves the education with specified ID for the specified \\~prospect\\~.\n\nSecured By Domain: Prospects\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).", "required": true, "type": "string", "pattern": "^([0-9a-f]{32})$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A261 | Enter a school name. |\n| Critical | A283 | Enter a last year attended that is after the first year attended. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "9727f970aa231000060528416b7b0016", "x-workday-secured-by-domains": [ "Prospects" ] } }, "/prospects/{ID}": { "get": { "tags": [ "prospects" ], "summary": "Retrieves a single \\~prospect\\~ instance.", "description": "Retrieves the \\~prospect\\~ with the specified ID.\n\nSecured By Domain: Prospects, Set Up: External Career Site Access\n\nScope: Recruiting, Talent Pipeline", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Recruiting_Prospect_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/prospectSummary_7657284bd7781000178a3bf6e17f001a" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ef3d700eb59610001e2f0dcf2ea90013", "x-workday-secured-by-domains": [ "Prospects", "Set Up: External Career Site Access" ] } } }, "securityDefinitions": { "OAuth2": { "type": "oauth2", "authorizationUrl": "https://", "flow": "implicit" } }, "definitions": { "INSTANCE_MODEL_REFERENCE": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$" }, "descriptor": { "type": "string", "description": "The display name of the instance", "readOnly": true }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true } } }, "ERROR_MODEL_REFERENCE": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "description": "A description of the error" }, "code": { "type": "string", "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change" }, "field": { "type": "string", "description": "The field related to the error" }, "path": { "type": "string", "description": "The path of the field related to the error" }, "severity": { "type": "string", "description": "Severity of the validation (e.g. Critical, Warning)." }, "internalMessage": { "type": "string", "description": "Internal message providing additional context for the validation (e.g. representation content validation details)." } } }, "VALIDATION_ERROR_MODEL_REFERENCE": { "allOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "description": "A description of the error" }, "errors": { "type": "array", "description": "An array of validation errors", "items": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } } } ] }, "FACETS_MODEL_REFERENCE": { "type": "array", "items": { "type": "object", "description": "This object represents the possible facets for this resource", "readOnly": true, "properties": { "descriptor": { "type": "string", "description": "A description of the facet" }, "facetParameter": { "type": "string", "description": "The alias used to select the facet" }, "values": { "type": "array", "description": "the facet values", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "The number of instances returned by this facet" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$" }, "descriptor": { "type": "string", "description": "A description of the facet" }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true } }, "required": [ "id" ] } } } } }, "MULTIPLE_INSTANCE_MODEL_REFERENCE": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" } } } }, "WorkdayId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Workday ID (32-character lowercase hexadecimal string).", "example": "a3f5b554007d20e98360015c5e6daf6" }, "WorkdayReferenceId_jobPostings": { "type": "string", "pattern": "^(Job_Posting_Anchor_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Job_Posting_Anchor_ID", "example": "Job_Posting_Anchor_ID=21002" }, "ResourceIdPathValue_jobPostings": {}, "jobSite_8b241418d7ce1000073b5115cd300040": { "allOf": [ { "$ref": "#/definitions/jobPostingSiteDetail_8b241418d7ce10000818455b78e40057" }, {} ], "description": "The job posting site that the job is posted on." }, "primaryLocation_8b241418d7ce1000073b51293ed40043": { "allOf": [ { "$ref": "#/definitions/locationSummary_8b241418d7ce100007a5c9eea7de004c" }, {} ], "description": "The primary location for the job posting, according to the associated job requisition." }, "timeType_8b241418d7ce1000073b510155b0003d": { "allOf": [ { "$ref": "#/definitions/positionTimeTypeDetail_8b241418d7ce100007fe51d00f630053" }, {} ], "description": "The position time type for job posting." }, "jobType_8b241418d7ce1000073b511c6e2a0041": { "allOf": [ { "$ref": "#/definitions/positionWorkerTypeDetail_8b241418d7ce1000089e70503c92005a" }, {} ], "description": "The \\~worker\\~ sub-type for the job posting, according to the job requisition." }, "candidateAvailabilityTemplateVersion_e60aa0457a21100011bb304dbba40000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Candidate Availability Template Version for Job Posting" }, "company_8b241418d7ce1000073b5122b5a90042": { "allOf": [ { "$ref": "#/definitions/organizationDetail_8b241418d7ce100008b027833f33005d" }, {} ], "description": "The \\~supervisory organization\\~ assigned to the job requisition associated with the job posting." }, "remoteType_d0be7f99be971000125025ffa1c40000": { "allOf": [ { "$ref": "#/definitions/remoteTypeDefinition_8bdd07e7084f1000151e15ccc3dd0000" }, {} ], "description": "The Job Requisition Remote Type for a Job Posting. For Remote Types with an External Name, the given external name is returned." }, "jobPostingAnchorSummary_5597c990f22e10000fc34f022dce0020": { "allOf": [ { "type": "object", "properties": { "categories": { "type": "array", "description": "The job family group for the job posting, according to the job requisition.", "items": { "$ref": "#/definitions/categories_8b241418d7ce1000073b510f7c9a003f" }, "x-workday-type": "Multi-instance" }, "jobSite": { "$ref": "#/definitions/jobSite_8b241418d7ce1000073b5115cd300040" }, "jobDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The description of the job for the job posting.", "x-workday-type": "Rich Text" }, "primaryLocation": { "$ref": "#/definitions/primaryLocation_8b241418d7ce1000073b51293ed40043" }, "timeType": { "$ref": "#/definitions/timeType_8b241418d7ce1000073b510155b0003d" }, "jobType": { "$ref": "#/definitions/jobType_8b241418d7ce1000073b511c6e2a0041" }, "candidateAvailabilityTemplateVersion": { "$ref": "#/definitions/candidateAvailabilityTemplateVersion_e60aa0457a21100011bb304dbba40000" }, "spotlightJob": { "type": "boolean", "example": true, "description": "True if the job posting is a \\~Spotlight Job\\~ or not.", "x-workday-type": "Boolean" }, "additionalLocations": { "type": "array", "description": "The additional locations on the job posting, according to the job requisition.", "items": { "$ref": "#/definitions/additionalLocations_8b241418d7ce1000073b50f95caf003c" }, "x-workday-type": "Multi-instance" }, "company": { "$ref": "#/definitions/company_8b241418d7ce1000073b5122b5a90042" }, "remoteType": { "$ref": "#/definitions/remoteType_d0be7f99be971000125025ffa1c40000" }, "endDate": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The end date for the job posting.", "x-workday-type": "Date" }, "url": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "External URL for Job Posting if it is posted to a published Workday External Career Site.", "x-workday-type": "Text" }, "startDate": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The start date for the job posting.", "x-workday-type": "Date" }, "title": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The title of the job posting, according to the associated job requisition.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "ResourceIdPathValue_candidateAvailabilityTemplate": {}, "availabilityTemplateDetails_617853847093100014ba0b710cd30000": { "allOf": [ { "type": "object", "properties": { "mondayAvailability": { "type": "array", "description": "Monday timeslots for template version.", "items": { "$ref": "#/definitions/mondayAvailability_deb14270132f10001fed2e410c850000" }, "x-workday-type": "Multi-instance", "x-label": "Monday Time Slots" }, "tuesdayAvailability": { "type": "array", "description": "Tuesday timeslots for template version.", "items": { "$ref": "#/definitions/tuesdayAvailability_6d359e79836910003741d96fc0480005" }, "x-workday-type": "Multi-instance", "x-label": "Tuesday Time Slots" }, "sundayAvailability": { "type": "array", "description": "Sunday timeslots for template version.", "items": { "$ref": "#/definitions/sundayAvailability_6d359e79836910003741d96fc0480000" }, "x-workday-type": "Multi-instance", "x-label": "Sunday Time Slots" }, "templateName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Name of the template version.", "x-workday-type": "Text", "x-label": "Availability Template Name" }, "wednesdayAvailability": { "type": "array", "description": "Wednesday timeslots for template version.", "items": { "$ref": "#/definitions/wednesdayAvailability_6d359e79836910003741d96fc0480004" }, "x-workday-type": "Multi-instance", "x-label": "Wednesday Time Slots" }, "thursdayAvailability": { "type": "array", "description": "Thursday timeslots for template version.", "items": { "$ref": "#/definitions/thursdayAvailability_6d359e79836910003741d96fc0480003" }, "x-workday-type": "Multi-instance", "x-label": "Thursday Time Slots" }, "saturdayAvailability": { "type": "array", "description": "Saturday timeslots for template version.", "items": { "$ref": "#/definitions/saturdayAvailability_6d359e79836910003741d96fc0480001" }, "x-workday-type": "Multi-instance", "x-label": "Saturday Time Slots" }, "fridayAvailability": { "type": "array", "description": "Friday timeslots for template version.", "items": { "$ref": "#/definitions/fridayAvailability_6d359e79836910003741d96fc0480002" }, "x-workday-type": "Multi-instance", "x-label": "Friday Time Slots" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_questionnaire": { "type": "string", "pattern": "^(Questionnaire_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Questionnaire_ID", "example": "Questionnaire_ID=21002" }, "ResourceIdPathValue_questionnaire": {}, "questionnaireDetails_58cd464577ad1000ee76d171eea90000": { "allOf": [ { "type": "object", "properties": { "questions": { "type": "array", "description": "Returns all Parent-Level Question Items for the questionnaire", "items": { "$ref": "#/definitions/questions_35124aec314610000eeda239777500f3" }, "x-workday-type": "Multi-instance" }, "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the questionnaire.", "x-workday-type": "Text" }, "questionnaireDisplayName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The display name for the questionnaire.", "x-workday-type": "Text", "x-workday-confidence-level": "Production" }, "referenceIdValue": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The reference ID for the Questionnaire", "x-workday-type": "Text" }, "questionnaireInstructions": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Returns instructions for the questionnaire. These instructions may be overridden where the questionnaire is being used.", "x-workday-type": "Rich Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "ResourceIdPathValue_offers": {}, "minimalInstanceView_6c2cb3ba412510001d291d96f4750000": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "details_6eb68609eb9c100011c228e7b3f40000": { "allOf": [ { "$ref": "#/definitions/offerDetailsCorrect_916121a6292610000f3b7892b0fa0000" }, {} ], "description": "Contains the relationship to Employment Agreement Details." }, "offerCorrect_879f275868fe1000108f853bdf110000": { "allOf": [ { "type": "object", "required": [ "comment" ], "properties": { "details": { "$ref": "#/definitions/details_6eb68609eb9c100011c228e7b3f40000" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The most recent comment you submitted for the business process.", "x-workday-type": "Text" } } } ] }, "ResourceIdPathValue_interviews": {}, "jobApplication_df78b8e577c91000201ea3e7d0f60101": { "allOf": [ { "$ref": "#/definitions/jobApplicationPublic_b36c621f46fd10001cc501100a4e03c7" }, {} ], "description": "The job application for the Recruiting event. Requires that the user is an interviewer for the in-progress Interview event or has access to the Candidate Data: Interview Feedback Results domain." }, "jobRequisition_df78b8e577c9100015f051a74e0b00a2": { "allOf": [ { "$ref": "#/definitions/jobRequisitionPublic_df78b8e577c91000162ee14015b600a4" }, {} ], "description": "The job requisition the candidate applied to. Requires that the user is an interviewer for the in-progress Interview event or has access to the Candidate Data: Interview Feedback Results domain." }, "interviewEventWithJobApplicationJobRequisitionInterviewerDetails_def69f12d55410000f7ec8da36ae005a": { "allOf": [ { "type": "object", "properties": { "jobApplication": { "$ref": "#/definitions/jobApplication_df78b8e577c91000201ea3e7d0f60101" }, "overallComment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Overall Comment XIP configuration formatted as text.", "x-workday-type": "Text" }, "interviewers": { "type": "array", "description": "All \\~workers\\~ selected to interview the candidate for a given Interview event.", "items": { "$ref": "#/definitions/interviewers_eb7eaf97ea8110000fafd115cf8e00ec" }, "x-workday-type": "Multi-instance" }, "overallRating": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Overall Rating XIP configuration formatted as text.", "x-workday-type": "Text" }, "interviewStatuses": { "type": "array", "description": "\"All applicable interview statuses for an Interview event. Statuses can be: \n * AWAITING_ME - An in-progress Interview event is waiting for the logged-in user's feedback. \n * COMPLETED - An Interview event is complete.\n * FEEDBACK_COMPLETE - All interview feedback for this in-progress event was submitted, but the Interview event isn’t awaiting the Make Interview Decision step.\n * NOT_SCHEDULED - An interview hasn't been scheduled for an in-progress Interview event.\n * PENDING_FEEDBACK - An in-progress Interview event is waiting for interviewer feedback.\n * SCHEDULED - An interview is scheduled for an in-progress Interview event.\n * SUBMITTED_FEEDBACK - The logged-in user submitted feedback for an in-progress Interview event.\n * MAKE_INTERVIEW_DECISION - The make an interview decision step for the candidate.\"", "items": { "$ref": "#/definitions/interviewStatuses_782d6c28615f10000374ab73f1530174" }, "x-workday-type": "Multi-instance" }, "hasCompetenciesQuestionnaires": { "type": "boolean", "example": true, "description": "If true, the interviewer feedback task awaiting processing has Competencies or Questionnaires with configured XIP settings.", "x-workday-type": "Boolean" }, "jobRequisition": { "$ref": "#/definitions/jobRequisition_df78b8e577c9100015f051a74e0b00a2" }, "workersPendingFeedback": { "type": "array", "description": "Interviewers with pending interview feedback.", "items": { "$ref": "#/definitions/workersPendingFeedback_af722229b5c3100018ad0c79a75801a0" }, "x-workday-type": "Multi-instance" }, "giveInterviewFeedbackLink": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "A URL for the Give Interview Feedback task, for \\~workers\\~ with access to the Interview Feedback Detail event awaiting processing.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "overallRating_def69f12d5541000141441c84bd00096": { "allOf": [ { "$ref": "#/definitions/interviewFeedbackRatingSummary_def69f12d554100013fe5747ffa50092" }, {} ], "description": "The interviewer's rating." }, "interviewDetailSummary_def69f12d5541000139a7815aae9008f": { "allOf": [ { "type": "object", "properties": { "overallRating": { "$ref": "#/definitions/overallRating_def69f12d5541000141441c84bd00096" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The interviewer's overall and competency comments.", "x-workday-type": "Text" }, "dateSubmitted": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The feedback submission date.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "ResourceIdPathValue_feedback": {}, "ResourceIdPathValue_employmentAgreements": {}, "details_5104e35eecce10001963e56753790000": { "allOf": [ { "$ref": "#/definitions/employmentAgreementDetailsCorrect_6eb68609eb9c100011bd315ef6360000" }, {} ], "description": "Contains the relationship to Employment Agreement Details" }, "employmentAgreementCorrect_7b559a8aab2f10001b9526d096610000": { "allOf": [ { "type": "object", "required": [ "comment" ], "properties": { "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The most recent comment you submitted for the business process", "x-workday-type": "Text" }, "details": { "$ref": "#/definitions/details_5104e35eecce10001963e56753790000" } } } ] }, "status_4e798b9f4f0c10000f0d81a848650021": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The status of the \\~prospect\\~. See configured types in the Maintain \\~Prospect\\~ Statuses task." }, "source_4e798b9f4f0c10000f0d818b76f6001f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The source for the \\~prospect\\~. Examples: LinkedIn, Facebook." }, "type_4e798b9f4f0c10000f0d819e58340020": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of the \\~prospect\\~. See configured types in the Maintain \\~Prospect\\~ Types task." }, "referredBy_4e798b9f4f0c10000f0d81ba535a0023": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The \\~worker\\~ who referred the candidate." }, "level_4e798b9f4f0c10000f0d81b1a0740022": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The targeted management level for the \\~Prospect\\~." }, "candidate_263b3523259410001ed40f0f6518126a": { "allOf": [ { "$ref": "#/definitions/candidateSummary_263b3523259410001f3119d56cda126c" }, {} ], "description": "The candidate profile associated with this \\~Prospect\\~." }, "prospectSummary_7657284bd7781000178a3bf6e17f001a": { "allOf": [ { "type": "object", "properties": { "status": { "$ref": "#/definitions/status_4e798b9f4f0c10000f0d81a848650021" }, "contactConsent": { "type": "boolean", "example": true, "description": "If true, the candidate agrees to be contacted.", "x-workday-type": "Boolean" }, "source": { "$ref": "#/definitions/source_4e798b9f4f0c10000f0d818b76f6001f" }, "type": { "$ref": "#/definitions/type_4e798b9f4f0c10000f0d819e58340020" }, "referredBy": { "$ref": "#/definitions/referredBy_4e798b9f4f0c10000f0d81ba535a0023" }, "level": { "$ref": "#/definitions/level_4e798b9f4f0c10000f0d81b1a0740022" }, "candidatePools": { "type": "array", "description": "The active, static pools for the candidate.", "items": { "$ref": "#/definitions/candidatePools_7c49be35aa7210000fc8ff87959512bc" }, "x-workday-type": "Multi-instance" }, "candidateTags": { "type": "array", "description": "The candidate tags associated with the candidate.", "items": { "$ref": "#/definitions/candidateTags_7b4e2f108d3b10001639543785fe0039" }, "x-workday-type": "Multi-instance" }, "candidate": { "$ref": "#/definitions/candidate_263b3523259410001ed40f0f6518126a" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_prospects": { "type": "string", "pattern": "^(Recruiting_Prospect_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Recruiting_Prospect_ID", "example": "Recruiting_Prospect_ID=21002" }, "ResourceIdPathValue_prospects": {}, "WorkdayReferenceId_resumeAttachments": { "type": "string", "pattern": "^(File_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: File_ID", "example": "File_ID=21002" }, "ResourceIdPathValue_resumeAttachments": {}, "resumeAttachmentDetailsView_134c3544d220100007f0f9b541a400a5": { "allOf": [ { "type": "object", "properties": { "fileName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The file name of the attachment.", "maxLength": 255, "x-workday-type": "Text" }, "fileExtension": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The file extension of the attachment.", "x-workday-type": "Text" }, "fileLength": { "type": "integer", "example": "99999999999", "description": "The file length of the attachment.", "x-workday-type": "Numeric" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014": { "allOf": [ { "type": "object", "properties": { "description": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Any responsibilities or accomplishments that the candidate gained at the associated company.", "x-workday-type": "Text" }, "location": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The location of this company.", "x-workday-type": "Text" }, "currentlyWorkHere": { "type": "boolean", "example": true, "description": "If true, the candidate currently works at this company.", "x-workday-type": "Boolean" }, "startYear": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The year the candidate started employment at this company.", "x-workday-type": "Date" }, "startMonth": { "type": "integer", "example": "99", "description": "The month the candidate started employment at this company.", "x-workday-type": "Numeric" }, "title": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The business title for the candidate's work experience.", "x-workday-type": "Text" }, "endMonth": { "type": "integer", "example": "99", "description": "The month the candidate ended employment at this company.", "x-workday-type": "Numeric" }, "endYear": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The year the candidate ended employment at this company.", "x-workday-type": "Date" }, "companyName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The company name the candidate entered in their job history.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_experiences": { "type": "string", "pattern": "^(CANDIDATE_EXPERIENCE_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: CANDIDATE_EXPERIENCE_ID", "example": "CANDIDATE_EXPERIENCE_ID=21002" }, "ResourceIdPathValue_experiences": {}, "language_ecf7ccfb11c11000285d4771a6300019": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The language for this language skill." }, "candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017": { "allOf": [ { "type": "object", "properties": { "language": { "$ref": "#/definitions/language_ecf7ccfb11c11000285d4771a6300019" }, "abilities": { "type": "array", "description": "The abilities associated with this language skill.", "items": { "$ref": "#/definitions/abilities_320147168979100014698d5722110045" }, "x-workday-type": "Multi-instance" }, "native": { "type": "boolean", "example": true, "description": "If true, this language skill is the native language.", "x-workday-type": "Boolean" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "ResourceIdPathValue_languages": {}, "ResourceIdPathValue_skills": {}, "candidateSkillItemDetails_2705750e957f10002beca80792940019": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the candidate skill.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "degree_9727f970aa23100005e6ec6727ee0011": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The candidate's degree at this educational institution." }, "fieldOfStudy_9727f970aa23100005e6ec5e7dd10010": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The field of study for the candidate at this educational institution." }, "candidateEducationDetails_9727f970aa231000052ae7db3fc0000b": { "allOf": [ { "type": "object", "properties": { "gradeAverage": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The candidate's grade average at this educational institution.", "x-workday-type": "Text" }, "degree": { "$ref": "#/definitions/degree_9727f970aa23100005e6ec6727ee0011" }, "schoolName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the school the candidate attended or is attending.", "x-workday-type": "Text" }, "fieldOfStudy": { "$ref": "#/definitions/fieldOfStudy_9727f970aa23100005e6ec5e7dd10010" }, "firstYearAttended": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The first year the candidate attended this educational institution.", "x-workday-type": "Date" }, "lastYearAttended": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The last year the candidate attended this educational institution.", "x-workday-type": "Date" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "ResourceIdPathValue_educations": {}, "jobFamilyGroupDetail_8b241418d7ce1000081068ca51810055": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Job Family" } } } ] }, "jobPostingSiteDetail_8b241418d7ce10000818455b78e40057": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Job Posting Site" } } } ] }, "countryRegionDetail_8b241418d7ce100007a4d8749d270049": { "allOf": [ { "type": "object", "properties": { "code": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The region-only portion of the ISO 3166-2 code for a country region.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "countryDetail_8b241418d7ce10000797fe76c17a0046": { "allOf": [ { "type": "object", "properties": { "alpha3Code": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The ISO alpha-3 code for a country.", "maxLength": 3, "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" } } } ] }, "region_8b241418d7ce100007a5ca0b072e004e": { "allOf": [ { "$ref": "#/definitions/countryRegionDetail_8b241418d7ce100007a4d8749d270049" }, {} ], "description": "Returns the country region for the location." }, "country_8b241418d7ce100007a5ca00337b004d": { "allOf": [ { "$ref": "#/definitions/countryDetail_8b241418d7ce10000797fe76c17a0046" }, {} ], "description": "Returns the \\~country\\~ from the primary address for the location." }, "locationSummary_8b241418d7ce100007a5c9eea7de004c": { "allOf": [ { "type": "object", "properties": { "region": { "$ref": "#/definitions/region_8b241418d7ce100007a5ca0b072e004e" }, "country": { "$ref": "#/definitions/country_8b241418d7ce100007a5ca00337b004d" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Location" } } } ] }, "positionTimeTypeDetail_8b241418d7ce100007fe51d00f630053": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Time Type" } } } ] }, "positionWorkerTypeDetail_8b241418d7ce1000089e70503c92005a": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Position \\~Worker\\~ Type" } } } ] }, "organizationDetail_8b241418d7ce100008b027833f33005d": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Supervisory Organization\\~" } } } ] }, "remoteTypeDefinition_8bdd07e7084f1000151e15ccc3dd0000": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The external or internal name of the Job Requisition Remote Type for the given Job Posting.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Job Requisition Remote Type" } } } ] }, "categories_8b241418d7ce1000073b510f7c9a003f": { "allOf": [ { "$ref": "#/definitions/jobFamilyGroupDetail_8b241418d7ce1000081068ca51810055" }, { "properties": { "id": { "type": "string", "description": "The id for Job Family" } } } ] }, "additionalLocations_8b241418d7ce1000073b50f95caf003c": { "allOf": [ { "$ref": "#/definitions/locationSummary_8b241418d7ce100007a5c9eea7de004c" }, { "properties": { "id": { "type": "string", "description": "The id for Location" } } } ] }, "timeslot_2e016acbd91810000809d655a1fc0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "mondayAvailability_deb14270132f10001fed2e410c850000": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "tuesdayAvailability_6d359e79836910003741d96fc0480005": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "sundayAvailability_6d359e79836910003741d96fc0480000": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "wednesdayAvailability_6d359e79836910003741d96fc0480004": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "thursdayAvailability_6d359e79836910003741d96fc0480003": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "saturdayAvailability_6d359e79836910003741d96fc0480001": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "fridayAvailability_6d359e79836910003741d96fc0480002": { "allOf": [ { "$ref": "#/definitions/timeslot_2e016acbd91810000809d655a1fc0000" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Availability Time Slot" } } } ] }, "branchingQuestion_b846d79e92ac100013f9842aa5700161": { "allOf": [ { "$ref": "#/definitions/questionItemDetails_35124aec314610000f15a3222d1800f9" }, {} ], "description": "Branching Question Item for Question Score" }, "questionMultipleChoiceAnswerDetails_35124aec314610000f355986c6490104": { "allOf": [ { "type": "object", "properties": { "score": { "type": "integer", "example": "99999999999", "description": "Returns the score for the multiple choice answer configured for the multiple choice question.", "x-workday-type": "Numeric" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The answer text for the Question Multiple Choice Answer", "x-workday-type": "Text" }, "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order for the Question Multiple Choice Answer", "x-workday-type": "Text" }, "branchingQuestion": { "$ref": "#/definitions/branchingQuestion_b846d79e92ac100013f9842aa5700161" }, "id": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The id for Question Score", "x-workday-type": "Text" } } } ] }, "possibleAnswers_35124aec314610000f15a340986c00fe": { "allOf": [ { "$ref": "#/definitions/questionMultipleChoiceAnswerDetails_35124aec314610000f355986c6490104" }, { "properties": { "id": { "type": "string", "description": "The id for Question Score" } } } ] }, "type_35124aec314610000f15a34518bf00ff": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of the question." }, "displayOption_35124aec314610000f15a32daa6600fa": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Returns the display option selected for the question. Answer choices will be presented this way to users answering the question." }, "questionItemDetails_35124aec314610000f15a3222d1800f9": { "allOf": [ { "type": "object", "properties": { "numberOfSelections": { "type": "integer", "example": "99", "description": "The number of allowed answers for a question for a questionnaire", "x-workday-type": "Numeric" }, "order": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The order of the question within the questionnaire.", "x-workday-type": "Text" }, "possibleAnswers": { "type": "array", "description": "Returns the scores for the multiple choice answers configured for the multiple choice question.", "items": { "$ref": "#/definitions/possibleAnswers_35124aec314610000f15a340986c00fe" }, "x-workday-type": "Multi-instance" }, "required": { "type": "boolean", "example": true, "description": "Indicator whether the answer for the question is required.", "x-workday-type": "Boolean" }, "type": { "$ref": "#/definitions/type_35124aec314610000f15a34518bf00ff" }, "displayOption": { "$ref": "#/definitions/displayOption_35124aec314610000f15a32daa6600fa" }, "body": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The body of the question.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Question Item" } } } ] }, "questions_35124aec314610000eeda239777500f3": { "allOf": [ { "$ref": "#/definitions/questionItemDetails_35124aec314610000f15a3222d1800f9" }, { "properties": { "id": { "type": "string", "description": "The id for Question Item" } } } ] }, "jobProfileReference_8c77c61a8a7d10001044729e404a0000": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Job Profile" } } } ] }, "hireReasonRepresentation_ab7461737b2b10001165337bccc50000": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Event Classification Subcategory" } } } ] }, "recruitingLocationIdReference_85ddfcc2b84810001130d622a5090000": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Location" } } } ] }, "jobProfile_68cdb222a84110000fb1cf0cc8a40000": { "allOf": [ { "$ref": "#/definitions/jobProfileReference_8c77c61a8a7d10001044729e404a0000" }, {} ], "description": "The job profile proposed for the worker on this employment agreement. When provided, it overrides the job profile inherited from the associated job requisition", "x-conditionally-required": true, "x-conditionally-hidden": true, "x-conditionally-readOnly": true }, "hireReason_916121a6292610000f3b7a60428d0000": { "allOf": [ { "$ref": "#/definitions/hireReasonRepresentation_ab7461737b2b10001165337bccc50000" }, {} ], "description": "The reason for hiring the pre-hire or candidate from their most recent approved Offer", "x-conditionally-required": true, "x-conditionally-hidden": true, "x-workday-populated-by": { "path": "/values/offers/hireReasons", "field": "id" } }, "location_2abab8465006100019370ad0513c0000": { "allOf": [ { "$ref": "#/definitions/recruitingLocationIdReference_85ddfcc2b84810001130d622a5090000" }, {} ], "description": "The location of the pre-hire or candidate comes from their most recent approved employment agreement.", "x-conditionally-required": true }, "offerDetailsCorrect_916121a6292610000f3b7892b0fa0000": { "allOf": [ { "type": "object", "properties": { "hireDate": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The HireDate for the pre-hire or candidate on their employment agreement.", "x-workday-type": "Date", "x-conditionally-required": true }, "jobProfile": { "$ref": "#/definitions/jobProfile_68cdb222a84110000fb1cf0cc8a40000" }, "hireReason": { "$ref": "#/definitions/hireReason_916121a6292610000f3b7a60428d0000" }, "location": { "$ref": "#/definitions/location_2abab8465006100019370ad0513c0000" }, "scheduledWeeklyHours": { "type": "number", "example": 999.99, "description": "Assigned hours for the specific employee/actual hours the employee is expected to work.", "x-workday-type": "Numeric", "x-conditionally-required": true, "x-conditionally-hidden": true }, "proposedEndDate": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The date the contract ends for a pre-hire or candidate from their most recent approved employment agreement.", "x-workday-type": "Date", "x-conditionally-required": true, "x-conditionally-hidden": true, "x-conditionally-readOnly": true }, "businessTitle": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The proposed business title for the pre-hire or candidate on their Offer.", "x-workday-type": "Text", "x-conditionally-required": true }, "defaultWeeklyHours": { "type": "number", "example": 999.99, "description": "The default weekly hours for the candidate.", "x-workday-type": "Numeric", "x-conditionally-required": true, "x-conditionally-hidden": true } } } ] }, "jobApplicationPublic_b36c621f46fd10001cc501100a4e03c7": { "allOf": [ { "type": "object", "properties": { "numberOfJobs": { "type": "integer", "example": "999999", "description": "The number of jobs for a candidate on this job application.", "x-workday-type": "Numeric" }, "yearsInCurrentJob": { "type": "number", "example": 99999999999.999, "description": "The number of years the candidate has been employed at their current job", "x-workday-type": "Numeric" }, "totalYearsExperience": { "type": "number", "example": 99999999999.999, "description": "The total years of experience for the candidate on this job application.", "x-workday-type": "Numeric" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Job Application \nExample(s): Job_Application_ID=Sample_Value" } } } ] }, "workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Worker\\~" } } } ] }, "interviewStatusRepresentation_782d6c28615f10000371c7f006740172": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Interview Status" } } } ] }, "recruiters_3b057822a75f100009d3dfe5672a0027": { "allOf": [ { "$ref": "#/definitions/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Worker\\~" } } } ] }, "primaryRecruiters_7469d71c04f610001aa86e35418d0010": { "allOf": [ { "$ref": "#/definitions/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Worker\\~" } } } ] }, "hiringManager_b47f16fb63e910000a6ac5854fd4021c": { "allOf": [ { "$ref": "#/definitions/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016" }, {} ], "description": "The hiring manager for a job requisition." }, "jobRequisitionPublic_df78b8e577c91000162ee14015b600a4": { "allOf": [ { "type": "object", "properties": { "recruiters": { "type": "array", "description": "The non-primary recruiters assigned to the job requisition.", "items": { "$ref": "#/definitions/recruiters_3b057822a75f100009d3dfe5672a0027" }, "x-workday-type": "Multi-instance" }, "primaryRecruiters": { "type": "array", "description": "The primary recruiters assigned to the job requisition. If no primary recruiter is assigned, the field is blank.", "items": { "$ref": "#/definitions/primaryRecruiters_7469d71c04f610001aa86e35418d0010" }, "x-workday-type": "Multi-instance" }, "hiringManager": { "$ref": "#/definitions/hiringManager_b47f16fb63e910000a6ac5854fd4021c" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Job Requisition \nExample(s): Job_Requisition_ID=Sample_Value" } } } ] }, "interviewers_eb7eaf97ea8110000fafd115cf8e00ec": { "allOf": [ { "$ref": "#/definitions/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Worker\\~" } } } ] }, "interviewStatuses_782d6c28615f10000374ab73f1530174": { "allOf": [ { "$ref": "#/definitions/interviewStatusRepresentation_782d6c28615f10000371c7f006740172" }, { "properties": { "id": { "type": "string", "description": "The id for Interview Status" } } } ] }, "workersPendingFeedback_af722229b5c3100018ad0c79a75801a0": { "allOf": [ { "$ref": "#/definitions/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Worker\\~" } } } ] }, "interviewFeedbackRatingSummary_def69f12d554100013fe5747ffa50092": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Interview Feedback Rating \nExample(s): Interview_Feedback_Rating_ID=Sample_Value" } } } ] }, "location_91e5bb4769a11000142dd06224d00000": { "allOf": [ { "$ref": "#/definitions/recruitingLocationIdReference_85ddfcc2b84810001130d622a5090000" }, {} ], "description": "The location of the pre-hire or candidate comes from their most recent approved employment agreement.", "x-conditionally-required": true }, "hireReason_ab7461737b2b1000116df9415e9e0000": { "allOf": [ { "$ref": "#/definitions/hireReasonRepresentation_ab7461737b2b10001165337bccc50000" }, {} ], "description": "The reason for hiring the pre-hire or candidate from their most recent approved employment agreement", "x-conditionally-required": true, "x-conditionally-hidden": true, "x-workday-populated-by": { "path": "/values/employmentAgreement/hireReasons", "field": "id" } }, "jobProfile_8c77c61a8a7d10001047766f58140000": { "allOf": [ { "$ref": "#/definitions/jobProfileReference_8c77c61a8a7d10001044729e404a0000" }, {} ], "description": "The job profile proposed for the worker on this employment agreement. When provided, it overrides the job profile inherited from the associated job requisition", "x-conditionally-required": true, "x-conditionally-hidden": true, "x-conditionally-readOnly": true }, "employmentAgreementDetailsCorrect_6eb68609eb9c100011bd315ef6360000": { "allOf": [ { "type": "object", "properties": { "location": { "$ref": "#/definitions/location_91e5bb4769a11000142dd06224d00000" }, "hireReason": { "$ref": "#/definitions/hireReason_ab7461737b2b1000116df9415e9e0000" }, "hireDate": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The HireDate for the pre-hire or candidate on their employment agreement.", "x-workday-type": "Date", "x-conditionally-required": true }, "defaultWeeklyHours": { "type": "number", "example": 999.99, "description": "The default weekly hours for the candidate.", "x-workday-type": "Numeric", "x-conditionally-required": true, "x-conditionally-hidden": true }, "scheduledWeeklyHours": { "type": "number", "example": 999.99, "description": "Assigned hours for the specific employee/actual hours the employee is expected to work.", "x-workday-type": "Numeric", "x-conditionally-required": true, "x-conditionally-hidden": true }, "businessTitle": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The proposed business title for the pre-hire or candidate on their employment agreement.", "x-workday-type": "Text", "x-conditionally-required": true }, "proposedEndDate": { "type": "string", "format": "date", "example": "2026-10-03T07:00:00.000Z", "description": "The date the contract ends for a pre-hire or candidate from their most recent approved employment agreement.", "x-workday-type": "Date", "x-conditionally-hidden": true, "x-conditionally-readOnly": true }, "jobProfile": { "$ref": "#/definitions/jobProfile_8c77c61a8a7d10001047766f58140000" } } } ] }, "candidatePool_7c49be35aa7210001012f723bc6012ca": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Candidate Pool" } } } ] }, "candidateTag_7b4e2f108d3b1000162f47403b7d0037": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Candidate Tag" } } } ] }, "deviceType_6f9c0428295210002484a8f3720f1796": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of phone device." }, "countryPhoneCode_6f9c04282952100023a80fd30a5f173e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The \\~country\\~ code of the phone number." }, "candidatePhoneDetails_6f9c04282952100023a80fa49bde173d": { "allOf": [ { "type": "object", "properties": { "deviceType": { "$ref": "#/definitions/deviceType_6f9c0428295210002484a8f3720f1796" }, "phoneNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The full primary phone number of the person.", "x-workday-type": "Text" }, "extension": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The phone number extension.", "x-workday-type": "Text" }, "countryPhoneCode": { "$ref": "#/definitions/countryPhoneCode_6f9c04282952100023a80fd30a5f173e" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Phone Interface (Derived)" } } } ] }, "countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Country\\~ Predefined Person Name Component Value \nExample(s): Predefined_Name_Component_ID=Sample_Value" } } } ] }, "country_1089da0ab90910000f6d7bd30bb20881": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Country\\~ \nExample(s): ISO_3166-1_Alpha-3_Code=Sample_Value" } } } ] }, "social_a229cf3cded91000151b47c7e0e2012c": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d" }, {} ], "description": "The social suffix from the name.", "x-workday-populated-by": { "path": "/values/name/social", "field": "id" } }, "salutation_a229cf3cded91000151b47b82570012a": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d" }, {} ], "description": "The salutation from the name.", "x-workday-populated-by": { "path": "/values/name/salutation", "field": "id" } }, "country_a229cf3cded91000151b47775e040123": { "allOf": [ { "$ref": "#/definitions/country_1089da0ab90910000f6d7bd30bb20881" }, {} ], "description": "The country from the name." }, "hereditary_a229cf3cded91000151b479726220126": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d" }, {} ], "description": "The hereditary suffix from the name.", "x-workday-populated-by": { "path": "/values/name/hereditary", "field": "id" } }, "title_a229cf3cded91000151b47af4c400129": { "allOf": [ { "$ref": "#/definitions/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d" }, {} ], "description": "The prefix from the name.", "x-workday-populated-by": { "path": "/values/name/title", "field": "id" } }, "name_59514ca580dc100021a2a27ee1880689": { "allOf": [ { "type": "object", "properties": { "secondaryLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "firstNameLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "firstNameLocal2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "social": { "$ref": "#/definitions/social_a229cf3cded91000151b47c7e0e2012c" }, "salutation": { "$ref": "#/definitions/salutation_a229cf3cded91000151b47b82570012a" }, "fullName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Full Name for a person, when it is provided. Workday only tracks Full Name for countries where the Full Name name component is used.", "x-workday-type": "Text" }, "lastNameLocal2": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "lastName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The last or family name for a person.", "x-workday-type": "Text" }, "secondaryLastName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The secondary family name for a person.", "x-workday-type": "Text" }, "middleNameLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "country": { "$ref": "#/definitions/country_a229cf3cded91000151b47775e040123" }, "firstName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The first or given name for a person.", "x-workday-type": "Text" }, "lastNameLocal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used.", "x-workday-type": "Text" }, "middleName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's middle name.", "x-workday-type": "Text" }, "tertiaryLastName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The person's tertiary last name.", "x-workday-type": "Text" }, "hereditary": { "$ref": "#/definitions/hereditary_a229cf3cded91000151b479726220126" }, "title": { "$ref": "#/definitions/title_a229cf3cded91000151b47af4c400129" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Global Name Interface (Derived)" } } } ] }, "phone_4d9dacbbb7bb10000c97867b421a4c7e": { "allOf": [ { "$ref": "#/definitions/candidatePhoneDetails_6f9c04282952100023a80fa49bde173d" }, {} ], "description": "The candidate's primary home phone number." }, "name_59514ca580dc100021a481f97c54068b": { "allOf": [ { "$ref": "#/definitions/name_59514ca580dc100021a2a27ee1880689" }, {} ], "description": "The global name associated with the candidate." }, "candidateSummary_263b3523259410001f3119d56cda126c": { "allOf": [ { "type": "object", "properties": { "phone": { "$ref": "#/definitions/phone_4d9dacbbb7bb10000c97867b421a4c7e" }, "name": { "$ref": "#/definitions/name_59514ca580dc100021a481f97c54068b" }, "email": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The candidate's email address.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Candidate Representation" } } } ] }, "candidatePools_7c49be35aa7210000fc8ff87959512bc": { "allOf": [ { "$ref": "#/definitions/candidatePool_7c49be35aa7210001012f723bc6012ca" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Pool" } } } ] }, "candidateTags_7b4e2f108d3b10001639543785fe0039": { "allOf": [ { "$ref": "#/definitions/candidateTag_7b4e2f108d3b1000162f47403b7d0037" }, { "properties": { "id": { "type": "string", "description": "The id for Candidate Tag" } } } ] }, "resumeAttachmentFileView_ee7318fbf39e10001e321c67d42300c0": { "allOf": [ { "type": "object", "properties": { "attachmentContent": { "type": "string", "format": "binary", "description": "The raw base64 data for an attachment or image for reports used as web services (RaaS) only.", "x-workday-type": "File" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "contentType_ee22ee09075410000346b6722d9b03e8": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The content type of the attachment." }, "resumeAttachmentDetailsCreate_ee22ee09075410000346b5ebfa2303e4": { "allOf": [ { "type": "object", "required": [ "attachmentContent", "fileLength" ], "properties": { "attachmentContent": { "type": "string", "format": "binary", "description": "The raw base64 data for an attachment or image for reports used as web services (RaaS) only.", "x-workday-type": "File" }, "fileName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The file name of the attachment.", "maxLength": 255, "x-workday-type": "Text" }, "fileLength": { "type": "integer", "example": "99999999999", "description": "The file length of the attachment.", "x-workday-type": "Numeric" }, "contentType": { "$ref": "#/definitions/contentType_ee22ee09075410000346b6722d9b03e8" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "proficiency_ecf7ccfb11c110002a0cd3c79f4c0023": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The proficiency for a specific language ability." }, "abilityType_ecf7ccfb11c110002a0cd3d48d1d0024": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of language ability. See the configured types in the Maintain Language Ability Types." }, "languageAbilityDetails_ecf7ccfb11c110002a0cd3b3ff8b0022": { "allOf": [ { "type": "object", "properties": { "proficiency": { "$ref": "#/definitions/proficiency_ecf7ccfb11c110002a0cd3c79f4c0023" }, "abilityType": { "$ref": "#/definitions/abilityType_ecf7ccfb11c110002a0cd3d48d1d0024" }, "id": { "type": "string", "description": "The id for Language Ability Representation" } } } ] }, "abilities_320147168979100014698d5722110045": { "allOf": [ { "$ref": "#/definitions/languageAbilityDetails_ecf7ccfb11c110002a0cd3b3ff8b0022" }, { "properties": { "id": { "type": "string", "description": "The id for Language Ability Representation" } } } ] } } }